de.vandermeer.asciilist

Class ItemizeList

Object

AbstractAsciiList

ItemizeList

All Implemented Interfaces:

AsciiList, AsciiList_Itemize

public class ItemizeList
extends AbstractAsciiList
implements AsciiList_Itemize

Abstract implementation of an itemize list AsciiList_Itemize.

Since:

v0.2.2

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 ListStyle_ItemizeNested	style The style for list items.

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
ItemizeList() Creates a new itemize list.
ItemizeList(boolean isContinued) Creates a new itemize list.
ItemizeList(ItemizeList list) Creates a new itemize list.

Method Summary

Modifier and Type	Method and Description
AsciiList_Itemize	addAllItems(Collection<String> items) Adds a collection of new items to the list.
AsciiList_Itemize	addItem(AsciiList list) Adds a new list to the list.
AsciiList_Itemize	addItem(String item) Adds a new item to the list.
int	calculateMaxIndentation(AsciiListItem item, int position) Calculates indentation for a list item.
AsciiList	copy() Returns a copy of the list.
void	prepareRender() Prepares a list to be rendered.
String	renderItem(AsciiListItem item, int position) Renders a particular item of a list.
AsciiList_Itemize	setListStyle(ListStyle style) Sets the style of a list.

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_ItemizeNested style

The style for list items.

Constructor Detail

ItemizeList

public ItemizeList()

Creates a new itemize list.

ItemizeList

public ItemizeList(boolean isContinued)

Creates a new itemize list.

Parameters:

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

ItemizeList

public ItemizeList(ItemizeList list)

Creates a new itemize list.

Parameters:

list - original list

Method Detail

addItem

public AsciiList_Itemize addItem(AsciiList list)

Description copied from interface: AsciiList_Itemize

Adds a new list to the list. If the list is an itemize 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_Itemize

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

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

setListStyle

public AsciiList_Itemize 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

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_Itemize addItem(String item)

Description copied from interface: AsciiList_Itemize

Adds a new item to the list.

Specified by:

addItem in interface AsciiList_Itemize

Parameters:

item - new item, only added if not blank

Returns:

self to allow chaining

addAllItems

public AsciiList_Itemize addAllItems(Collection<String> items)

Description copied from interface: AsciiList_Itemize

Adds a collection of new items to the list.

Specified by:

addAllItems in interface AsciiList_Itemize

Parameters:

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

Returns:

self to allow chaining