de.vandermeer.asciilist

Class EnumerateList

Object

AbstractAsciiList

EnumerateList

All Implemented Interfaces:

AsciiList, AsciiList_Enumerate

public class EnumerateList
extends AbstractAsciiList
implements AsciiList_Enumerate

Abstract implementation of an enumerate list AsciiList_Enumerate.

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

Modifier and Type	Field and Description
protected boolean	isPrepared Flag stating if the list is fully prepared for rendering.
protected String	labelSeparator A string to separate labels, default is dot.
protected int[]	parents The levels of the parents for nested enumerate lists 1.
protected int	realPosition The real position that is the position number an item belongs to, allowing for sub-lists belonging to an item here.
protected ListStyle_EnumerateNested	style The style for list items.
protected boolean	useLabelSeparatorAfterLastItem Flag for the use-label-separator-after-last-item behavior.

Fields inherited from class AbstractAsciiList

isContinued, items, level, maxItemIndent, postLabelIndent, postLabelStr, preLabelIndent, preLabelStr, width

Fields inherited from interface AsciiList

IMPLICIT_NEWLINE

Constructor Summary

Constructors

Constructor and Description
EnumerateList() Creates a new enumerate list.
EnumerateList(boolean isContinued) Creates a new enumerate list.
EnumerateList(EnumerateList list) Creates a new enumerate list as a copy of the original list.

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.
protected String	calculateItemLabel(int position) Calculates and returns the label for a list item.
int	calculateMaxIndentation(AsciiListItem item, int position) Calculates indentation for a list item.
AsciiList	copy() Returns a copy of 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.
void	prepareRender() Prepares a list to be rendered.
String	renderItem(AsciiListItem item, int position) Renders a particular item of a list.
AsciiList_Enumerate	setLabelSeparator(String separator) Sets the label separator, default is dot.
AsciiList_Enumerate	setListStyle(ListStyle style) Sets the style of a list.
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 class AbstractAsciiList

calculateMaxIndentation, getItems, getLevel, getPostLabelIndent, getPostLabelString, getPreLabelIndent, getPreLabelString, isContinuedList, render, setLabelDefaults, setLevel, setPostLabelIndent, setPostLabelString, setPreLabelIndent, setPreLabelString, setWidth, wrapItem, wrapItemNextLine

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface AsciiList

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

Field Detail

style

protected ListStyle_EnumerateNested style

The style for list items.

parents

protected int[] parents

The levels of the parents for nested enumerate lists 1. - 1.1. - 1.1.1.

isPrepared

protected boolean isPrepared

Flag stating if the list is fully prepared for rendering.

realPosition

protected int realPosition

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

labelSeparator

protected String labelSeparator

A string to separate labels, default is dot.

useLabelSeparatorAfterLastItem

protected boolean useLabelSeparatorAfterLastItem

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

Constructor Detail

EnumerateList

public EnumerateList()

Creates a new enumerate list.

EnumerateList

public EnumerateList(boolean isContinued)

Creates a new enumerate list.

Parameters:

isContinued - true if continued from previous list of same type, false otherwise

EnumerateList

public EnumerateList(EnumerateList list)

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

Parameters:

list - original list

Method Detail

addItem

public AsciiList_Enumerate addItem(AsciiList list)

Description copied from interface: AsciiList_Enumerate

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.

Specified by:

addItem in interface AsciiList_Enumerate

Parameters:

list - the new list

Returns:

self to allow chaining

prepareRender

public void prepareRender()

Description copied from interface: AsciiList

Prepares a list to be rendered. This method should be automatically called by the list before starting the rendering.

Specified by:

prepareRender in interface AsciiList

Overrides:

prepareRender in class AbstractAsciiList

calculateItemLabel

protected String calculateItemLabel(int position)

Calculates and returns the label for a list item.

Parameters:

position - the position of the item in the list

Returns:

calculated label

renderItem

public String renderItem(AsciiListItem item,
                         int position)

Description copied from interface: AsciiList

Renders a particular item of a list.

Specified by:

renderItem in interface AsciiList

Parameters:

item - the item to be rendered

position - the position of the item in the item list

Returns:

rendered item

setParents

public AsciiList_Enumerate setParents(int[] parents)

Description copied from interface: AsciiList_Enumerate

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

Specified by:

setParents in interface AsciiList_Enumerate

Parameters:

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

Returns:

self to allow chaining

getParents

public int[] getParents()

Description copied from interface: AsciiList_Enumerate

Returns the parents of nested enumerate lists.

Specified by:

getParents in interface AsciiList_Enumerate

Returns:

levels of nested enumerate lists, null for the top one

setListStyle

public AsciiList_Enumerate setListStyle(ListStyle style)

Description copied from interface: AsciiList

Sets the style of a list. The style is specific to the list type. To set a style the list will go through all list items and set the style if the item class supports the given style.

Specified by:

setListStyle in interface AsciiList

Parameters:

style - new list style

Returns:

self to allow chaining

copy

public AsciiList copy()

Description copied from interface: AsciiList

Returns a copy of the list.

Specified by:

copy in interface AsciiList

Returns:

copy of the list

setLabelSeparator

public AsciiList_Enumerate setLabelSeparator(String separator)

Description copied from interface: AsciiList_Enumerate

Sets the label separator, default is dot.

Specified by:

setLabelSeparator in interface AsciiList_Enumerate

Parameters:

separator - new label separator, blank can be used

Returns:

self to allow chaining

getLabelSeparator

public String getLabelSeparator()

Description copied from interface: AsciiList_Enumerate

Returns the label separator, default is dot.

Specified by:

getLabelSeparator in interface AsciiList_Enumerate

Returns:

separator new label separator, blank can be used

useLabelSeparatorAfterLastItem

public AsciiList_Enumerate useLabelSeparatorAfterLastItem(boolean flag)

Description copied from interface: AsciiList_Enumerate

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.

Specified by:

useLabelSeparatorAfterLastItem in interface AsciiList_Enumerate

Parameters:

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

Returns:

self to allow chaining

calculateMaxIndentation

public int calculateMaxIndentation(AsciiListItem item,
                                   int position)

Description copied from interface: AsciiList

Calculates indentation for a list item.

Specified by:

calculateMaxIndentation in interface AsciiList

Parameters:

item - the item to be used for calculation

position - the position of the item in the item list

Returns:

item indentation

addItem

public AsciiList_Enumerate addItem(String item)

Description copied from interface: AsciiList_Enumerate

Adds a new item to the list.

Specified by:

addItem in interface AsciiList_Enumerate

Parameters:

item - new item, only added if not blank

Returns:

self to allow chaining

addAllItems

public AsciiList_Enumerate addAllItems(Collection<String> items)

Description copied from interface: AsciiList_Enumerate

Adds a collection of new items to the list.

Specified by:

addAllItems in interface AsciiList_Enumerate

Parameters:

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

Returns:

self to allow chaining

isPrepared

public boolean isPrepared()

Description copied from interface: AsciiList_Enumerate

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

Specified by:

isPrepared in interface AsciiList_Enumerate

Returns:

true if prepared for rendering, false otherwise

setPrepared

public void setPrepared()

Description copied from interface: AsciiList_Enumerate

Sets the list as being prepared for rendering.

Specified by:

setPrepared in interface AsciiList_Enumerate