de.vandermeer.asciilist.styles

Enum NestedCheckStyles

Object

Enum<NestedCheckStyles>

NestedCheckStyles

All Implemented Interfaces:

ListStyle, ListStyle_CheckNested, Serializable, Comparable<NestedCheckStyles>

public enum NestedCheckStyles
extends Enum<NestedCheckStyles>
implements ListStyle_CheckNested

Standard styles for check lists implementing ListStyle_CheckNested for 6 levels.

Since:

v0.0.1

Version:

v0.0.3 build 160301 (01-Mar-16) for Java 1.7

Author:

Sven van der Meer <vdmeer.sven@mykolab.com>

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL_SQUARE_BRACKET_BLANK_X Style that uses CheckListStyles.ASCII_SQUARE_BRACKET_BLANK_X for unlimited levels.
ALL_UTF_BALLOT_BOX Style that uses CheckListStyles.UTF_BALLOT_BOX for unlimited levels.
ALL_UTF_BALLOT_BOX_X Style that uses CheckListStyles.UTF_BALLOT_BOX_X for unlimited levels.

Method Summary

Modifier and Type	Method and Description
ListStyle_Check	getStyle(int level) Returns the style for a given level.
StrBuilder	toDoc() Returns a representation of the list style useful for documentation
static NestedCheckStyles	valueOf(String name) Returns the enum constant of this type with the specified name.
static NestedCheckStyles[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ALL_SQUARE_BRACKET_BLANK_X

public static final NestedCheckStyles ALL_SQUARE_BRACKET_BLANK_X

Style that uses CheckListStyles.ASCII_SQUARE_BRACKET_BLANK_X for unlimited levels. For example:

        [ ] unchecked item
        [X] checked item
           [ ] unchecked item
           [X] checked item
              [ ] unchecked item
              [X] checked item
                 [ ] unchecked item
                 [X] checked item
                    [ ] unchecked item
                    [X] checked item
                       [ ] unchecked item
                       [X] checked item
 

ALL_UTF_BALLOT_BOX

public static final NestedCheckStyles ALL_UTF_BALLOT_BOX

Style that uses CheckListStyles.UTF_BALLOT_BOX for unlimited levels. For example:

        ☐ unchecked item
        ☑ checked item
           ☐ unchecked item
           ☑ checked item
              ☐ unchecked item
              ☑ checked item
                 ☐ unchecked item
                 ☑ checked item
                    ☐ unchecked item
                    ☑ checked item
                       ☐ unchecked item
                       ☑ checked item
 

ALL_UTF_BALLOT_BOX_X

public static final NestedCheckStyles ALL_UTF_BALLOT_BOX_X

Style that uses CheckListStyles.UTF_BALLOT_BOX_X for unlimited levels. For example:

        ☐ unchecked item
        ☒ checked item
           ☐ unchecked item
           ☒ checked item
              ☐ unchecked item
              ☒ checked item
                 ☐ unchecked item
                 ☒ checked item
                    ☐ unchecked item
                    ☒ checked item
                       ☐ unchecked item
                       ☒ checked item
 

Method Detail

values

public static NestedCheckStyles[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (NestedCheckStyles c : NestedCheckStyles.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static NestedCheckStyles valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

toDoc

public StrBuilder toDoc()

Description copied from interface: ListStyle

Returns a representation of the list style useful for documentation

Specified by:

toDoc in interface ListStyle

Returns:

documentation representation of the list style

getStyle

public ListStyle_Check getStyle(int level)

Description copied from interface: ListStyle_CheckNested

Returns the style for a given level.

Specified by:

getStyle in interface ListStyle_CheckNested

Parameters:

level - the level for the requested style

Returns:

check lists style for a given level