A C D E G I L M N P R S T U V W

A

AbstractAsciiList - Class in de.vandermeer.asciilist

Abstract implementation as base for the AsciiList hierarchy.

AbstractAsciiList() - Constructor for class AbstractAsciiList

Creates a new list.

AbstractAsciiList(AbstractAsciiList) - Constructor for class AbstractAsciiList

Creates a new list.

AbstractAsciiList(boolean) - Constructor for class AbstractAsciiList

Creates a new list.

AbstractAsciiListItem - Class in de.vandermeer.asciilist

Abstract (fully featured) implementation of AsciiListItem.

AbstractAsciiListItem(Object) - Constructor for class AbstractAsciiListItem

Creates a new list item

addAllItems(Collection<String>) - Method in interface AsciiList_Check

Adds a collection of new items to the list, all set to "unchecked".

addAllItems(Collection<String>) - Method in interface AsciiList_Enumerate

Adds a collection of new items to the list.

addAllItems(Collection<String>) - Method in interface AsciiList_Itemize

Adds a collection of new items to the list.

addAllItems(Collection<String>) - Method in class CheckList

addAllItems(Collection<String>) - Method in class EnumerateList

addAllItems(Collection<String>) - Method in class ItemizeList

addItem(String) - Method in interface AsciiList_Check

Adds a new item which is set to "unchecked".

addItem(String, String) - Method in interface AsciiList_Description

Adds a new item to the description list.

addItem(AsciiList) - Method in interface AsciiList_Enumerate

Adds a new list to the list.

addItem(String) - Method in interface AsciiList_Enumerate

Adds a new item to the list.

addItem(String) - Method in interface AsciiList_Itemize

Adds a new item to the list.

addItem(AsciiList) - Method in interface AsciiList_Itemize

Adds a new list to the list.

addItem(String) - Method in class CheckList

addItem(String, String) - Method in class DescriptionList

addItem(AsciiList) - Method in class EnumerateList

addItem(String) - Method in class EnumerateList

addItem(AsciiList) - Method in class ItemizeList

addItem(String) - Method in class ItemizeList

addItemChecked(String) - Method in interface AsciiList_Check

Adds a new item which is set to "checked".

addItemChecked(String) - Method in class CheckList

AlphaLiteralUtils - Class in de.vandermeer.asciilist.commons

Utilities to convert numbers (integers) into alphanumeric literals with several supported representations using ASCII-7 and UTF characters.

AlphaLiteralUtils() - Constructor for class AlphaLiteralUtils

ArabicLiteralUtils - Class in de.vandermeer.asciilist.commons

Utilities to convert numbers (integers) into arabic number literals with several supported representations using ASCII-7 and UTF characters.

ArabicLiteralUtils() - Constructor for class ArabicLiteralUtils

AsciiList - Interface in de.vandermeer.asciilist

Base of the ASCII list hierarchy - standard interface.

AsciiList_Check - Interface in de.vandermeer.asciilist

A list - called option (list) in HTML, checklist in ASCII Doc.

AsciiList_Description - Interface in de.vandermeer.asciilist

A list - called description in LaTeX, definition list in HTML, labeled list in ASCII Doc.

AsciiList_Enumerate - Interface in de.vandermeer.asciilist

A list - called enumerate in LaTeX, ordered in HTML and ASCII Doc.

AsciiList_Itemize - Interface in de.vandermeer.asciilist

A list - called itemize in LaTeX, unordered in HTML and ASCII Doc.

AsciiListItem - Interface in de.vandermeer.asciilist

A list item.

C

calculateItemLabel(AsciiListItem) - Method in class CheckList

Calculates and returns the label for a list item.

calculateItemLabel(int) - Method in class EnumerateList

Calculates and returns the label for a list item.

calculateMaxIndentation() - Method in class AbstractAsciiList

calculateMaxIndentation() - Method in interface AsciiList

Calculates indentation for each element of the list and returns the maximum value.

calculateMaxIndentation(AsciiListItem, int) - Method in interface AsciiList

Calculates indentation for a list item.

calculateMaxIndentation(AsciiListItem, int) - Method in class CheckList

calculateMaxIndentation(AsciiListItem, int) - Method in class DescriptionList

calculateMaxIndentation(AsciiListItem, int) - Method in class EnumerateList

calculateMaxIndentation(AsciiListItem, int) - Method in class ItemizeList

checked - Variable in class CheckListItem

Flag for checked (true) and unchecked (false) items in a checklist.

CheckList - Class in de.vandermeer.asciilist

Abstract implementation of a checklist AsciiList_Check.

CheckList() - Constructor for class CheckList

Creates a new check list.

CheckList(boolean) - Constructor for class CheckList

Creates a new check list with continue flag.

CheckList(CheckList) - Constructor for class CheckList

Creates a new check list as a copy of the original list.

CheckListItem - Class in de.vandermeer.asciilist

Implementation of AsciiListItem for a checklist.

CheckListItem(Object, boolean) - Constructor for class CheckListItem

Creates a new list item

CheckListStyles - Enum in de.vandermeer.asciilist.styles

Styles for an check lists - AsciiList_Check.

content - Variable in class AbstractAsciiListItem

The actual content of the list item.

copy() - Method in interface AsciiList

Returns a copy of the list.

copy() - Method in class CheckList

copy() - Method in class DescriptionList

copy() - Method in class EnumerateList

copy() - Method in class ItemizeList

D

de.vandermeer.asciilist - package de.vandermeer.asciilist

ASCII lists - ordered and unordered and checklist and more, with many configuration options.

de.vandermeer.asciilist.commons - package de.vandermeer.asciilist.commons

Utilities and common classes/interfaces for ASCII lists.

de.vandermeer.asciilist.styles - package de.vandermeer.asciilist.styles

Style interfaces and pre-defined styles for ASCII lists.

DescriptionList - Class in de.vandermeer.asciilist

Abstract implementation of a description list AsciiList_Description.

DescriptionList() - Constructor for class DescriptionList

DescriptionListItem - Class in de.vandermeer.asciilist

Implementation of AsciiListItem for a description list.

DescriptionListItem(Object, Object) - Constructor for class DescriptionListItem

Creates a new description item with term and description.

E

EnumerateList - Class in de.vandermeer.asciilist

Abstract implementation of an enumerate list AsciiList_Enumerate.

EnumerateList() - Constructor for class EnumerateList

Creates a new enumerate list.

EnumerateList(boolean) - Constructor for class EnumerateList

Creates a new enumerate list.

EnumerateList(EnumerateList) - Constructor for class EnumerateList

Creates a new enumerate list as a copy of the original list.

EnumerateStyles - Enum in de.vandermeer.asciilist.styles

Styles for an enumerate list /ordered list - AsciiList_Enumerate.

G

getContent() - Method in class AbstractAsciiListItem

getContent() - Method in interface AsciiListItem

Returns the content of the list item.

getItems() - Method in class AbstractAsciiList

getItems() - Method in interface AsciiList

Returns the items of the list.

getLabel(int) - Method in enum EnumerateStyles

getLabel(int) - Method in interface ListStyle_Enumerate

Returns the label according to the style for a particular position in an enumerate list.

getLabel() - Method in interface ListStyle_Itemize

Returns the label for an item.

getLabel(int) - Method in interface ListStyle_ItemizeNested

Returns the label for a given level.

getLabel(int) - Method in enum NestedItemizeStyles

getLabelChecked() - Method in enum CheckListStyles

getLabelChecked() - Method in interface ListStyle_Check

Returns the label for a checked item.

getLabelSeparator() - Method in interface AsciiList_Enumerate

Returns the label separator, default is dot.

getLabelSeparator() - Method in class EnumerateList

getLabelUnchecked() - Method in enum CheckListStyles

getLabelUnchecked() - Method in interface ListStyle_Check

Returns the label for an unchecked item.

getLevel() - Method in class AbstractAsciiList

getLevel() - Method in interface AsciiList

Returns the level of the list.

getParents() - Method in interface AsciiList_Enumerate

Returns the parents of nested enumerate lists.

getParents() - Method in class EnumerateList

getPostLabelIndent() - Method in class AbstractAsciiList

getPostLabelIndent() - Method in interface AsciiList

Sets the indentation to be used for an item after the label (and before the post-label string).

getPostLabelString() - Method in class AbstractAsciiList

getPostLabelString() - Method in interface AsciiList

Sets a string to be printed after an item label (and before the post-label indentation).

getPreLabelIndent() - Method in class AbstractAsciiList

getPreLabelIndent() - Method in interface AsciiList

Gets the indentation to be used for an item before the label (and after the pre-label string).

getPreLabelString() - Method in class AbstractAsciiList

getPreLabelString() - Method in interface AsciiList

Sets a string to be printed before an item label (and after the pre-label indentation).

getStyle(int) - Method in interface ListStyle_CheckNested

Returns the style for a given level.

getStyle(int) - Method in interface ListStyle_EnumerateNested

Returns the style for a given level.

getStyle(int) - Method in enum NestedCheckStyles

getStyle(int) - Method in enum NestedEnumerateStyles

getTerm() - Method in class DescriptionListItem

Returns the term of the description item.

getWrappedLineIndentation() - Method in interface AsciiList_Description

Returns the indentation if lines need to be wrapped due to over length compared to a given width.

getWrappedLineIndentation() - Method in class DescriptionList

I

IMPLICIT_NEWLINE - Static variable in interface AsciiList

A string representing an implicit new line for item rendering or internal processing such as word wrapping.

INTEGER_2_ROMAN(int) - Static method in enum RomanNumberLiterals

Converts an integer into a Roman number.

isChecked() - Method in class CheckListItem

Returns the checked flag of the item.

isContinued - Variable in class AbstractAsciiList

Flag indicating if the list is continued from a previous list of the same type or not.

isContinuedList() - Method in class AbstractAsciiList

isContinuedList() - Method in interface AsciiList

Returns a flag indicating if the list is continued from a previous list of the same type or not.

isPrepared() - Method in interface AsciiList_Enumerate

Returns a flag stating if the list is prepared for rendering.

isPrepared - Variable in class EnumerateList

Flag stating if the list is fully prepared for rendering.

isPrepared() - Method in class EnumerateList

ItemizeList - Class in de.vandermeer.asciilist

Abstract implementation of an itemize list AsciiList_Itemize.

ItemizeList() - Constructor for class ItemizeList

Creates a new itemize list.

ItemizeList(boolean) - Constructor for class ItemizeList

Creates a new itemize list.

ItemizeList(ItemizeList) - Constructor for class ItemizeList

Creates a new itemize list.

items - Variable in class AbstractAsciiList

The items of a list.

L

labelSeparator - Variable in class EnumerateList

A string to separate labels, default is dot.

LETTERS - Static variable in enum RomanNumberLiterals

Array of Roman number literals.

level - Variable in class AbstractAsciiList

The level of the list, default is 1.

ListStyle - Interface in de.vandermeer.asciilist.styles

Customizable styles for lists - AsciiList.

ListStyle_Check - Interface in de.vandermeer.asciilist.styles

Customizable style for check lists - AsciiList_Check.

ListStyle_CheckNested - Interface in de.vandermeer.asciilist.styles

Customizable style for nested check lists - AsciiList_Check.

ListStyle_Enumerate - Interface in de.vandermeer.asciilist.styles

Customizable style for enumerate (ordered) lists - AsciiList_Enumerate.

ListStyle_EnumerateNested - Interface in de.vandermeer.asciilist.styles

Customizable style for nested enumerate (ordered) lists - AsciiList_Enumerate.

ListStyle_Itemize - Interface in de.vandermeer.asciilist.styles

Customizable style for itemize (unordered) lists - AsciiList_Itemize.

ListStyle_ItemizeNested - Interface in de.vandermeer.asciilist.styles

Customizable style for nested itemize (unordered) lists - AsciiList_Itemize.

M

maxItemIndent - Variable in class AbstractAsciiList

The maximum item indentation, 0 until calculated.

N

NestedCheckStyles - Enum in de.vandermeer.asciilist.styles

Standard styles for check lists implementing ListStyle_CheckNested for 6 levels.

NestedEnumerateStyles - Enum in de.vandermeer.asciilist.styles

Standard styles for enumerate (ordered) lists implementing ListStyle_EnumerateNested for 6 levels.

NestedItemizeStyles - Enum in de.vandermeer.asciilist.styles

Standard styles for itemize (unordered) lists implementing ListStyle_ItemizeNested for 6 levels.

NUMBERS - Static variable in enum RomanNumberLiterals

Array to convert numbers.

P

parents - Variable in class EnumerateList

The levels of the parents for nested enumerate lists 1.

postLabelIndent - Variable in class AbstractAsciiList

The indentation after the label (and the post-label string), default is 1.

postLabelStr - Variable in class AbstractAsciiList

A string printed directly after the label, other than indentation, default is empty string.

preLabelIndent - Variable in class AbstractAsciiList

The indentation before the label (and the pre-label string), default is 1.

preLabelStr - Variable in class AbstractAsciiList

A string printed directly before the label, other than indentation, default is empty string.

prepareRender() - Method in class AbstractAsciiList

prepareRender() - Method in interface AsciiList

Prepares a list to be rendered.

prepareRender() - Method in class EnumerateList

prepareRender() - Method in class ItemizeList

R

realPosition - Variable in class EnumerateList

The real position that is the position number an item belongs to, allowing for sub-lists belonging to an item here.

render() - Method in class AbstractAsciiList

render(int, String, String, String, int) - Method in class AbstractAsciiListItem

render() - Method in interface AsciiList

Renders the list, generates a string representation of it.

render(int, String, String, String, int) - Method in interface AsciiListItem

Renders the list item, generates a string representation of it.

render(int, String, String, int, boolean) - Method in class DescriptionListItem

Renders the list item, generates a string representation of it.

renderItem(AsciiListItem, int) - Method in interface AsciiList

Renders a particular item of a list.

renderItem(AsciiListItem, int) - Method in class CheckList

renderItem(AsciiListItem, int) - Method in class DescriptionList

renderItem(AsciiListItem, int) - Method in class EnumerateList

renderItem(AsciiListItem, int) - Method in class ItemizeList

ROMAN_2_ENUM(String) - Static method in enum RomanNumberLiterals

Converts a string of Roman literals into an array of enumerates for further character conversion.

RomanNumberLiterals - Enum in de.vandermeer.asciilist.commons

Utilities to convert numbers (integers) into Roman number literals with several supported representations using ASCII-7 and UTF characters.

S

setLabelDefaults() - Method in class AbstractAsciiList

setLabelDefaults() - Method in interface AsciiList

Sets the values for pre/post paramters of labels back to their default values.

setLabelSeparator(String) - Method in interface AsciiList_Enumerate

Sets the label separator, default is dot.

setLabelSeparator(String) - Method in class EnumerateList

setLevel(int) - Method in class AbstractAsciiList

setLevel(int) - Method in interface AsciiList

Sets the level of the list.

setListStyle(ListStyle) - Method in interface AsciiList

Sets the style of a list.

setListStyle(ListStyle) - Method in class CheckList

setListStyle(ListStyle) - Method in class DescriptionList

setListStyle(ListStyle) - Method in class EnumerateList

setListStyle(ListStyle) - Method in class ItemizeList

setParents(int[]) - Method in interface AsciiList_Enumerate

Sets the parents (enumerations of all parent items) to generate for instance 1.

setParents(int[]) - Method in class EnumerateList

setPostIndent(int) - Method in interface AsciiList_Check

Sets the indentation to be used for an item after the label (and before the post-label string).

setPostIndent(int) - Method in class CheckList

setPostLabel(String) - Method in interface AsciiList_Check

Sets a string to be printed after an item label (and before the post-label indentation).

setPostLabel(String) - Method in class CheckList

setPostLabelIndent(int) - Method in class AbstractAsciiList

setPostLabelIndent(int) - Method in interface AsciiList

Sets the indentation to be used for an item after the label (and before the post-label string).

setPostLabelString(String) - Method in class AbstractAsciiList

setPostLabelString(String) - Method in interface AsciiList

Sets a string to be printed after an item label (and before the post-label indentation).

setPreLabel(String) - Method in interface AsciiList_Check

Sets a string to be printed before an item label (and after the pre-label indentation).

setPreLabel(String) - Method in class CheckList

setPreLabelIndent(int) - Method in class AbstractAsciiList

setPreLabelIndent(int) - Method in interface AsciiList

Sets the indentation to be used for an item before the label (and after the pre-label string).

setPreLabelString(String) - Method in class AbstractAsciiList

setPreLabelString(String) - Method in interface AsciiList

Sets a string to be printed before an item label (and after the pre-label indentation).

setPrepared() - Method in interface AsciiList_Enumerate

Sets the list as being prepared for rendering.

setPrepared() - Method in class EnumerateList

setWidth(int) - Method in class AbstractAsciiList

setWidth(int) - Method in interface AsciiList

Sets the (maximum) width a list (and all items and sub-lists) can have when being rendered.

setWrappedLineIndentation(int) - Method in interface AsciiList_Description

Sets the indentation if lines need to be wrapped due to over length compared to a given width.

setWrappedLineIndentation(int) - Method in class DescriptionList

style - Variable in class CheckList

The style for list items.

style - Variable in class EnumerateList

The style for list items.

style - Variable in class ItemizeList

The style for list items.

T

term - Variable in class DescriptionListItem

The term of a description.

toAscii(int) - Static method in class AlphaLiteralUtils

Returns an alphanumeric literal representation of the given number using ASCII-7 upper case characters.

toAscii(int) - Static method in class ArabicLiteralUtils

Returns an Arabic literal representation of the given number using ASCII-7 characters.

toAscii(int) - Static method in enum RomanNumberLiterals

Returns a Roman literal representation of the given number using ASCII-7 upper case characters.

toAsciiLC(int) - Static method in class AlphaLiteralUtils

Returns an alphanumeric literal representation of the given number using ASCII-7 lower case characters.

toAsciiLC(int) - Static method in enum RomanNumberLiterals

Returns a Roman literal representation of the given number using ASCII-7 lower case characters.

toCircledDigit(int) - Static method in class ArabicLiteralUtils

Returns an alphanumeric literal representation of the given number using UTF Circled Digit/Number characters.

toCircledLatinCapital(int) - Static method in class AlphaLiteralUtils

Returns an alphanumeric literal representation of the given number using UTF Circled Latin Capital (upper case) characters.

toCircledLatinCaptial(int) - Static method in enum RomanNumberLiterals

Returns a Roman literal representation of the given number using UTF Circled Latin Captial (upper case) characters.

toCircledLatinSmall(int) - Static method in class AlphaLiteralUtils

Returns an alphanumeric literal representation of the given number using UTF Circled Latin Small (lower case) characters.

toCircledLatinSmall(int) - Static method in enum RomanNumberLiterals

Returns a Roman literal representation of the given number using UTF Circled Latin Small (lower case) characters.

toDingbatNegativeCircledDigit(int) - Static method in class ArabicLiteralUtils

Returns an alphanumeric literal representation of the given number using UTF Dingbat Negative Circled Digit characters.

toDingbatNegativeSanserifCircledDigit(int) - Static method in class ArabicLiteralUtils

Returns an alphanumeric literal representation of the given number using UTF Dingbat Negative Sanserif Circled Digit characters.

toDingbatSanserifCircledDigit(int) - Static method in class ArabicLiteralUtils

Returns an alphanumeric literal representation of the given number using UTF Dingbat Sanserif Circled Digit characters.

toDoc() - Method in enum CheckListStyles

toDoc() - Method in enum EnumerateStyles

toDoc() - Method in interface ListStyle

Returns a representation of the list style useful for documentation

toDoc() - Method in interface ListStyle_Check

Returns a representation of the list style useful for documentation

toDoc() - Method in interface ListStyle_Enumerate

Returns a representation of the list style useful for documentation

toDoc() - Method in interface ListStyle_Itemize

Returns a representation of the list style useful for documentation

toDoc() - Method in enum NestedCheckStyles

toDoc() - Method in enum NestedEnumerateStyles

toDoc() - Method in enum NestedItemizeStyles

toDoubleCircledDigit(int) - Static method in class ArabicLiteralUtils

Returns an alphanumeric literal representation of the given number using UTF Double Circled Digit/Number characters.

toFullStop(int) - Static method in class ArabicLiteralUtils

Returns an alphanumeric literal representation of the given number using UTF Full Stop characters.

toFullwidth(int) - Static method in class ArabicLiteralUtils

Returns an alphanumeric literal representation of the given number using UTF Fullwidth characters.

toFullwidthLatinCapital(int) - Static method in class AlphaLiteralUtils

Returns an alphanumeric literal representation of the given number using UTF Fullwidth Latin Capital Letter (upper case) characters.

toFullwidthLatinSmall(int) - Static method in class AlphaLiteralUtils

Returns an alphanumeric literal representation of the given number using UTF Fullwidth Latin Small Letter (lower case) characters.

toNumberForms(int) - Static method in enum RomanNumberLiterals

Returns a Roman literal representation of the given number using UTF Number Forms upper case characters.

toNumberFormsLC(int) - Static method in enum RomanNumberLiterals

Returns a Roman literal representation of the given number using UTF Number Forms lower case characters.

toParenthesized(int) - Static method in class ArabicLiteralUtils

Returns an alphanumeric literal representation of the given number using UTF Parenthesized Digit/Number characters.

toParenthesizedLatinSmallLetter(int) - Static method in class AlphaLiteralUtils

Returns an alphanumeric literal representation of the given number using UTF Parenthesized Latin Small Letter (lower case) characters.

toSubscript(int) - Static method in class ArabicLiteralUtils

Returns an alphanumeric literal representation of the given number using UTF Subscript characters.

toSuperscript(int) - Static method in class ArabicLiteralUtils

Returns an alphanumeric literal representation of the given number using UTF Superscript Latin Small Letter characters.

U

useLabelSeparatorAfterLastItem(boolean) - Method in interface AsciiList_Enumerate

Sets the behavior for using the label separator after the last item when rendering a list item.

useLabelSeparatorAfterLastItem - Variable in class EnumerateList

Flag for the use-label-separator-after-last-item behavior.

useLabelSeparatorAfterLastItem(boolean) - Method in class EnumerateList

useSingleLine(boolean) - Method in interface AsciiList_Description

Sets the list behavior for the descriptions to single line or multiline.

useSingleLine - Variable in class DescriptionList

Flag directing the lists render behavior, true for single line, false for multiline, default is single line.

useSingleLine(boolean) - Method in class DescriptionList

V

valueOf(String) - Static method in enum RomanNumberLiterals

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum CheckListStyles

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum EnumerateStyles

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum NestedCheckStyles

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum NestedEnumerateStyles

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum NestedItemizeStyles

Returns the enum constant of this type with the specified name.

values() - Static method in enum RomanNumberLiterals

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

values() - Static method in enum CheckListStyles

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

values() - Static method in enum EnumerateStyles

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

values() - Static method in enum NestedCheckStyles

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

values() - Static method in enum NestedEnumerateStyles

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

values() - Static method in enum NestedItemizeStyles

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

W

width - Variable in class AbstractAsciiList

The maximum width if the list (and all items and sub-lists), -1 for no width until set otherwise.

wrapItem(String) - Method in class AbstractAsciiList

Wraps a rendered list item for the width given in the list.

wrapItemNextLine(String) - Method in class AbstractAsciiList

Wraps all following lines of an item

wrappedLineIndentation - Variable in class DescriptionList

The indentation to be used if lines of the description need to be wrapped, default is 5.

A C D E G I L M N P R S T U V W