de.vandermeer.asciilist

Class DescriptionList

Object

AbstractAsciiList

DescriptionList

All Implemented Interfaces:

AsciiList, AsciiList_Description

public class DescriptionList
extends AbstractAsciiList
implements AsciiList_Description

Abstract implementation of a description list AsciiList_Description.

Since:

v0.0.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 boolean	useSingleLine Flag directing the lists render behavior, true for single line, false for multiline, default is single line.
protected int	wrappedLineIndentation The indentation to be used if lines of the description need to be wrapped, default is 5.

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
DescriptionList()

Method Summary

Modifier and Type	Method and Description
AsciiList_Description	addItem(String term, String description) Adds a new item to the description list.
int	calculateMaxIndentation(AsciiListItem item, int position) Calculates indentation for a list item.
AsciiList	copy() Returns a copy of the list.
int	getWrappedLineIndentation() Returns the indentation if lines need to be wrapped due to over length compared to a given width.
String	renderItem(AsciiListItem item, int position) Renders a particular item of a list.
AsciiList	setListStyle(ListStyle style) Sets the style of a list.
AsciiList_Description	setWrappedLineIndentation(int indentation) Sets the indentation if lines need to be wrapped due to over length compared to a given width.
AsciiList_Description	useSingleLine(boolean flag) Sets the list behavior for the descriptions to single line or multiline.

Methods inherited from class AbstractAsciiList

calculateMaxIndentation, getItems, getLevel, getPostLabelIndent, getPostLabelString, getPreLabelIndent, getPreLabelString, isContinuedList, prepareRender, 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, prepareRender, render, setLabelDefaults, setLevel, setPostLabelIndent, setPostLabelString, setPreLabelIndent, setPreLabelString, setWidth

Field Detail

useSingleLine

protected boolean useSingleLine

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

wrappedLineIndentation

protected int wrappedLineIndentation

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

Constructor Detail

DescriptionList

public DescriptionList()

Method Detail

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

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

useSingleLine

public AsciiList_Description useSingleLine(boolean flag)

Description copied from interface: AsciiList_Description

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

Specified by:

useSingleLine in interface AsciiList_Description

Parameters:

flag - true for single line (label and description in one line), false for multiline (separate lines for label and descriptions)

Returns:

self to allow chaining

addItem

public AsciiList_Description addItem(String term,
                                     String description)

Description copied from interface: AsciiList_Description

Adds a new item to the description list. Nothing will be added of the term or the description are blank.

Specified by:

addItem in interface AsciiList_Description

Parameters:

term - the term of the item

description - the description of the term

Returns:

self to allow chaining

setWrappedLineIndentation

public AsciiList_Description setWrappedLineIndentation(int indentation)

Description copied from interface: AsciiList_Description

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

Specified by:

setWrappedLineIndentation in interface AsciiList_Description

Parameters:

indentation - the indentation

Returns:

self to allow chaining

getWrappedLineIndentation

public int getWrappedLineIndentation()

Description copied from interface: AsciiList_Description

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

Specified by:

getWrappedLineIndentation in interface AsciiList_Description

Returns:

indentation the indentation

setListStyle

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