de.vandermeer.asciilist

Interface AsciiList_Description

All Superinterfaces:

AsciiList

All Known Implementing Classes:

DescriptionList

public interface AsciiList_Description
extends AsciiList

A list - called description in LaTeX, definition list in HTML, labeled list in 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_Description	addItem(String term, String description) Adds a new item to the description list.
int	getWrappedLineIndentation() Returns the indentation if lines need to be wrapped due to over length compared to a given width.
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 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

setWrappedLineIndentation

AsciiList_Description setWrappedLineIndentation(int indentation)

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

Parameters:

indentation - the indentation

Returns:

self to allow chaining

getWrappedLineIndentation

int getWrappedLineIndentation()

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

Returns:

indentation the indentation

addItem

AsciiList_Description addItem(String term,
                              String description)

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

Parameters:

term - the term of the item

description - the description of the term

Returns:

self to allow chaining

useSingleLine

AsciiList_Description useSingleLine(boolean flag)

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

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