CheckListStyles (ASCII List 0.0.3 API)

Object
- Enum<CheckListStyles>
- - CheckListStyles

All Implemented Interfaces:

ListStyle_Check, Serializable, Comparable<CheckListStyles>
```
public enum CheckListStyles
extends Enum<CheckListStyles>
implements ListStyle_Check
```
Styles for an check lists - AsciiList_Check.

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
`ASCII_SQUARE_BRACKET_BLANK_X` Style that uses square brackets and X.
`UTF_BALLOT_BOX` Style that uses UTF-8 ballot box characters.
`UTF_BALLOT_BOX_X` Style that uses UTF-8 ballot box characters with X box for checked.
`UTF_BALLOT_X` Style that uses blank for unchecked and UTF-8 ballot X for checked items.
`UTF_BALLOT_X_HEAVY` Style that uses blank for unchecked and UTF-8 ballot heavy X for checked items.
`UTF_CHECKMARK` Style that uses blank for unchecked and UTF-8 checkmark for checked items.
`UTF_MULTIPLICATION_X` Style that uses blank for unchecked and UTF-8 multiplication x for checked items.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getLabelChecked()` Returns the label for a checked item.
`String`	`getLabelUnchecked()` Returns the label for an unchecked item.
`StrBuilder`	`toDoc()` Returns a representation of the list style useful for documentation
`static CheckListStyles`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static CheckListStyles[]`	`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
  - ASCII_SQUARE_BRACKET_BLANK_X
```
public static final CheckListStyles ASCII_SQUARE_BRACKET_BLANK_X
```
    Style that uses square brackets and X. For example:
```
        [ ] unchecked item
        [X] checked item
 
```
  - UTF_BALLOT_BOX
```
public static final CheckListStyles UTF_BALLOT_BOX
```
    Style that uses UTF-8 ballot box characters. For example:
```
        ☐ unchecked item
        ☑ checked item
 
```
  - UTF_BALLOT_BOX_X
```
public static final CheckListStyles UTF_BALLOT_BOX_X
```
    Style that uses UTF-8 ballot box characters with X box for checked. For example:
```
        ☐ unchecked item
        ☒ checked item
 
```
  - UTF_BALLOT_X
```
public static final CheckListStyles UTF_BALLOT_X
```
    Style that uses blank for unchecked and UTF-8 ballot X for checked items. For example:
```
          unchecked item
        ✗ checked item
 
```
  - UTF_BALLOT_X_HEAVY
```
public static final CheckListStyles UTF_BALLOT_X_HEAVY
```
    Style that uses blank for unchecked and UTF-8 ballot heavy X for checked items. For example:
```
          unchecked item
        ✘ checked item
 
```
  - UTF_CHECKMARK
```
public static final CheckListStyles UTF_CHECKMARK
```
    Style that uses blank for unchecked and UTF-8 checkmark for checked items. For example:
```
          unchecked item
        ✓ checked item
 
```
  - UTF_MULTIPLICATION_X
```
public static final CheckListStyles UTF_MULTIPLICATION_X
```
    Style that uses blank for unchecked and UTF-8 multiplication x for checked items. For example:
```
          unchecked item
        ✕ checked item
 
```
- Method Detail
  - values
```
public static CheckListStyles[] 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 (CheckListStyles c : CheckListStyles.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static CheckListStyles 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
  - getLabelChecked
```
public String getLabelChecked()
```
    Description copied from interface: ListStyle_Check
    
    Returns the label for a checked item.
    
    Specified by:
    
    getLabelChecked in interface ListStyle_Check
    
    Returns:
    
    checked label, should not be null
  - getLabelUnchecked
```
public String getLabelUnchecked()
```
    Description copied from interface: ListStyle_Check
    
    Returns the label for an unchecked item.
    
    Specified by:
    
    getLabelUnchecked in interface ListStyle_Check
    
    Returns:
    
    unchecked label, should not be null
  - toDoc
```
public StrBuilder toDoc()
```
    Description copied from interface: ListStyle_Check
    
    Returns a representation of the list style useful for documentation
    
    Specified by:
    
    toDoc in interface ListStyle_Check
    
    Returns:
    
    documentation representation of the list style

Enum CheckListStyles

Enum Constant Summary

Method Summary

Methods inherited from class Enum

Methods inherited from class Object

Enum Constant Detail

ASCII_SQUARE_BRACKET_BLANK_X

UTF_BALLOT_BOX

UTF_BALLOT_BOX_X

UTF_BALLOT_X

UTF_BALLOT_X_HEAVY

UTF_CHECKMARK

UTF_MULTIPLICATION_X

Method Detail

values

valueOf

getLabelChecked

getLabelUnchecked

toDoc