de.vandermeer.asciilist

Interface AsciiList_Enumerate

All Superinterfaces:

AsciiList

All Known Implementing Classes:

EnumerateList

public interface AsciiList_Enumerate
extends AsciiList

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

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>

Field Summary

Fields inherited from interface AsciiList

IMPLICIT_NEWLINE

Method Summary

Modifier and Type	Method and Description
AsciiList_Enumerate	addAllItems(Collection<String> items) Adds a collection of new items to the list.
AsciiList_Enumerate	addItem(AsciiList list) Adds a new list to the list.
AsciiList_Enumerate	addItem(String item) Adds a new item to the list.
String	getLabelSeparator() Returns the label separator, default is dot.
int[]	getParents() Returns the parents of nested enumerate lists.
boolean	isPrepared() Returns a flag stating if the list is prepared for rendering.
AsciiList_Enumerate	setLabelSeparator(String separator) Sets the label separator, default is dot.
AsciiList_Enumerate	setParents(int[] parents) Sets the parents (enumerations of all parent items) to generate for instance 1.
void	setPrepared() Sets the list as being prepared for rendering.
AsciiList_Enumerate	useLabelSeparatorAfterLastItem(boolean flag) Sets the behavior for using the label separator after the last item when rendering a list item.

Methods inherited from interface AsciiList

calculateMaxIndentation, calculateMaxIndentation, copy, getItems, getLevel, getPostLabelIndent, getPostLabelString, getPreLabelIndent, getPreLabelString, isContinuedList, prepareRender, render, renderItem, setLabelDefaults, setLevel, setListStyle, setPostLabelIndent, setPostLabelString, setPreLabelIndent, setPreLabelString, setWidth

Method Detail

addItem

AsciiList_Enumerate addItem(AsciiList list)

Adds a new list to the list. If the list is an enumerate list, then continuation behavior will be as follows: If the list is not continued, then no style information will be copied and the list level will be 1. If the list is a continued list, then all style information will be copied from the parent list and the level of the added list will be set accordingly. A list is continued if AsciiList.isContinuedList() returns true, not continued if it returns false.

Parameters:

list - the new list

Returns:

self to allow chaining

Throws:

NullPointerException - - if the list is null

IllegalArgumentException - - if the list is empty

addItem

AsciiList_Enumerate addItem(String item)

Adds a new item to the list.

Parameters:

item - new item, only added if not blank

Returns:

self to allow chaining

addAllItems

AsciiList_Enumerate addAllItems(Collection<String> items)

Adds a collection of new items to the list.

Parameters:

items - collection of items, individual items only added if not blank

Returns:

self to allow chaining

setParents

AsciiList_Enumerate setParents(int[] parents)

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

Parameters:

parents - nested level, each entry in the array marks the position of a parent

Returns:

self to allow chaining

getParents

int[] getParents()

Returns the parents of nested enumerate lists.

Returns:

levels of nested enumerate lists, null for the top one

setLabelSeparator

AsciiList_Enumerate setLabelSeparator(String separator)

Sets the label separator, default is dot.

Parameters:

separator - new label separator, blank can be used

Returns:

self to allow chaining

getLabelSeparator

String getLabelSeparator()

Returns the label separator, default is dot.

Returns:

separator new label separator, blank can be used

useLabelSeparatorAfterLastItem

AsciiList_Enumerate useLabelSeparatorAfterLastItem(boolean flag)

Sets the behavior for using the label separator after the last item when rendering a list item. The default behavior is false, i.e. do not use the label separator after the last item.

Parameters:

flag - true if the separator should be used after the last item, false otherwise

Returns:

self to allow chaining

isPrepared

boolean isPrepared()

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

Returns:

true if prepared for rendering, false otherwise

setPrepared

void setPrepared()

Sets the list as being prepared for rendering.