de.vandermeer.asciilist

Interface AsciiList_Check

All Superinterfaces:

AsciiList

All Known Implementing Classes:

CheckList

public interface AsciiList_Check
extends AsciiList

A list - called option (list) in HTML, checklist 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_Check	addAllItems(Collection<String> items) Adds a collection of new items to the list, all set to "unchecked".
AsciiList_Check	addItem(String item) Adds a new item which is set to "unchecked".
AsciiList_Check	addItemChecked(String item) Adds a new item which is set to "checked".
AsciiList_Check	setPostIndent(int indent) Sets the indentation to be used for an item after the label (and before the post-label string).
AsciiList_Check	setPostLabel(String postLabel) Sets a string to be printed after an item label (and before the post-label indentation).
AsciiList_Check	setPreLabel(String preLabel) Sets a string to be printed before an item label (and after the pre-label indentation).

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

setPreLabel

AsciiList_Check setPreLabel(String preLabel)

Sets a string to be printed before an item label (and after the pre-label indentation).

Parameters:

preLabel - string for pre-label

Returns:

self to allow chaining

setPostLabel

AsciiList_Check setPostLabel(String postLabel)

Sets a string to be printed after an item label (and before the post-label indentation).

Parameters:

postLabel - string for post label

Returns:

self to allow chaining

setPostIndent

AsciiList_Check setPostIndent(int indent)

Sets the indentation to be used for an item after the label (and before the post-label string).

Parameters:

indent - post-label indentation, negative integer will use default

Returns:

self to allow chaining

addItem

AsciiList_Check addItem(String item)

Adds a new item which is set to "unchecked".

Parameters:

item - new item, only added if not blank

Returns:

self to allow chaining

addAllItems

AsciiList_Check addAllItems(Collection<String> items)

Adds a collection of new items to the list, all set to "unchecked".

Parameters:

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

Returns:

self to allow chaining

addItemChecked

AsciiList_Check addItemChecked(String item)

Adds a new item which is set to "checked".

Parameters:

item - content for the checked item

Returns:

self to allow chaining