AsciiList (ASCII List 0.0.3 API)

All Known Subinterfaces:

AsciiList_Check, AsciiList_Description, AsciiList_Enumerate, AsciiList_Itemize

All Known Implementing Classes:

AbstractAsciiList, CheckList, DescriptionList, EnumerateList, ItemizeList
```
public interface AsciiList
```
Base of the ASCII list hierarchy - standard interface. The interface covers all generic functionality for ASCII lists:
- Set/get all label related formatting options (pre-label indentation and string, post-label indentation and string)
- Set list style (based on the style interface
- Render the list
- Retrieve list items for processing
Some methods a more for internal use (by an abstract implementation supporting specific lists):
- Set/get level (of nested lists)
- Calculation methods (e.g. for maximum indentation)
- Render and individual items
The interface does not define any method to add content to a list. The reason for that is that list content is very specific for a particular list. For instance, a description will need a term and a description as content for an item, while an itemize list requires only text for the item. In addition: some lists allow for adding other lists (e.g. enumerate, itemize) while other lists do not support that (e.g. checklist).
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

static String IMPLICIT_NEWLINE
A string representing an implicit new line for item rendering or internal processing such as word wrapping.

Fields
Modifier and Type	Field and Description
`static String`	`IMPLICIT_NEWLINE` A string representing an implicit new line for item rendering or internal processing such as word wrapping.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`int`	`calculateMaxIndentation()` Calculates indentation for each element of the list and returns the maximum value.
`int`	`calculateMaxIndentation(AsciiListItem item, int position)` Calculates indentation for a list item.
`AsciiList`	`copy()` Returns a copy of the list.
`List<Object>`	`getItems()` Returns the items of the list.
`int`	`getLevel()` Returns the level of the list.
`int`	`getPostLabelIndent()` Sets the indentation to be used for an item after the label (and before the post-label string).
`String`	`getPostLabelString()` Sets a string to be printed after an item label (and before the post-label indentation).
`int`	`getPreLabelIndent()` Gets the indentation to be used for an item before the label (and after the pre-label string).
`String`	`getPreLabelString()` Sets a string to be printed before an item label (and after the pre-label indentation).
`boolean`	`isContinuedList()` Returns a flag indicating if the list is continued from a previous list of the same type or not.
`void`	`prepareRender()` Prepares a list to be rendered.
`String`	`render()` Renders the list, generates a string representation of it.
`String`	`renderItem(AsciiListItem item, int position)` Renders a particular item of a list.
`AsciiList`	`setLabelDefaults()` Sets the values for pre/post paramters of labels back to their default values.
`AsciiList`	`setLevel(int level)` Sets the level of the list.
`AsciiList`	`setListStyle(ListStyle style)` Sets the style of a list.
`AsciiList`	`setPostLabelIndent(int indent)` Sets the indentation to be used for an item after the label (and before the post-label string).
`AsciiList`	`setPostLabelString(String str)` Sets a string to be printed after an item label (and before the post-label indentation).
`AsciiList`	`setPreLabelIndent(int indent)` Sets the indentation to be used for an item before the label (and after the pre-label string).
`AsciiList`	`setPreLabelString(String str)` Sets a string to be printed before an item label (and after the pre-label indentation).
`AsciiList`	`setWidth(int width)` Sets the (maximum) width a list (and all items and sub-lists) can have when being rendered.

- Field Detail
  - IMPLICIT_NEWLINE
```
static final String IMPLICIT_NEWLINE
```
    A string representing an implicit new line for item rendering or internal processing such as word wrapping.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - copy
```
AsciiList copy()
```
    Returns a copy of the list.
    
    Returns:
    
    copy of the list
  - getItems
```
List<Object> getItems()
```
    Returns the items of the list.
    
    Returns:
    
    items of the list
  - getLevel
```
int getLevel()
```
    Returns the level of the list.
    
    Returns:
    
    list level, one if top list, greater than one if it is a nested list
  - getPostLabelIndent
```
int getPostLabelIndent()
```
    Sets the indentation to be used for an item after the label (and before the post-label string).
    
    Returns:
    
    indent post-label indentation
  - getPostLabelString
```
String getPostLabelString()
```
    Sets a string to be printed after an item label (and before the post-label indentation).
    
    Returns:
    
    postLabel string for post label
  - getPreLabelIndent
```
int getPreLabelIndent()
```
    Gets the indentation to be used for an item before the label (and after the pre-label string).
    
    Returns:
    
    indent pre-label indentation
  - getPreLabelString
```
String getPreLabelString()
```
    Sets a string to be printed before an item label (and after the pre-label indentation).
    
    Returns:
    
    preLabel string for pre-label
  - isContinuedList
```
boolean isContinuedList()
```
    Returns a flag indicating if the list is continued from a previous list of the same type or not.
    
    Returns:
    
    true if is continued, false otherwise
  - render
```
String render()
```
    Renders the list, generates a string representation of it.
    
    Returns:
    
    rendered list
    
    Throws:
    
    IllegalArgumentException - if a set width is too small for any list item being rendered intelligibly
  - prepareRender
```
void prepareRender()
```
    Prepares a list to be rendered. This method should be automatically called by the list before starting the rendering.
  - calculateMaxIndentation
```
int calculateMaxIndentation()
```
    Calculates indentation for each element of the list and returns the maximum value. The max value contains the pre-label indent, the pre-label string, the actual label, the post-label string and the post-label indent. This maximum indentation can then be used in the rendering process to indent all items and sub-lists, even with different length labels.
    
    Returns:
    
    maximum indentation calculated over all list items
  - calculateMaxIndentation
```
int calculateMaxIndentation(AsciiListItem item,
                            int position)
```
    Calculates indentation for a list item.
    
    Parameters:
    
    item - the item to be used for calculation
    
    position - the position of the item in the item list
    
    Returns:
    
    item indentation
  - setWidth
```
AsciiList setWidth(int width)
```
    Sets the (maximum) width a list (and all items and sub-lists) can have when being rendered.
    
    Parameters:
    
    width - maximum width
    
    Returns:
    
    self to allow chaining
  - renderItem
```
String renderItem(AsciiListItem item,
                  int position)
```
    Renders a particular item of a list.
    
    Parameters:
    
    item - the item to be rendered
    
    position - the position of the item in the item list
    
    Returns:
    
    rendered item
  - setLevel
```
AsciiList setLevel(int level)
```
    Sets the level of the list.
    
    Parameters:
    
    level - new list level, should only be used if 2 or larger (nested list) using 1 as default
    
    Returns:
    
    self to allow chaining
  - setListStyle
```
AsciiList setListStyle(ListStyle style)
```
    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.
    
    Parameters:
    
    style - new list style
    
    Returns:
    
    self to allow chaining
  - setPostLabelIndent
```
AsciiList setPostLabelIndent(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
  - setPostLabelString
```
AsciiList setPostLabelString(String str)
```
    Sets a string to be printed after an item label (and before the post-label indentation).
    
    Parameters:
    
    str - string for post label
    
    Returns:
    
    self to allow chaining
  - setPreLabelIndent
```
AsciiList setPreLabelIndent(int indent)
```
    Sets the indentation to be used for an item before the label (and after the pre-label string).
    
    Parameters:
    
    indent - pre-label indentation, negative integer will use default
    
    Returns:
    
    self to allow chaining
  - setPreLabelString
```
AsciiList setPreLabelString(String str)
```
    Sets a string to be printed before an item label (and after the pre-label indentation).
    
    Parameters:
    
    str - string for pre-label
    
    Returns:
    
    self to allow chaining
  - setLabelDefaults
```
AsciiList setLabelDefaults()
```
    Sets the values for pre/post paramters of labels back to their default values.
    
    Returns:
    
    self to allow for chaining

Interface AsciiList

Field Summary

Method Summary

Field Detail

IMPLICIT_NEWLINE

Method Detail

copy

getItems

getLevel

getPostLabelIndent

getPostLabelString

getPreLabelIndent

getPreLabelString

isContinuedList

render

prepareRender

calculateMaxIndentation

calculateMaxIndentation

setWidth

renderItem

setLevel

setListStyle

setPostLabelIndent

setPostLabelString

setPreLabelIndent

setPreLabelString

setLabelDefaults