AbstractAsciiList (ASCII List 0.0.3 API)

Object
- AbstractAsciiList

All Implemented Interfaces:

AsciiList

Direct Known Subclasses:

CheckList, DescriptionList, EnumerateList, ItemizeList
```
public abstract class AbstractAsciiList
extends Object
implements AsciiList
```
Abstract implementation as base for the AsciiList hierarchy.

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
`protected boolean`	`isContinued` Flag indicating if the list is continued from a previous list of the same type or not.
`protected List<Object>`	`items` The items of a list.
`protected int`	`level` The level of the list, default is 1.
`protected int`	`maxItemIndent` The maximum item indentation, 0 until calculated.
`protected int`	`postLabelIndent` The indentation after the label (and the post-label string), default is 1.
`protected String`	`postLabelStr` A string printed directly after the label, other than indentation, default is empty string.
`protected int`	`preLabelIndent` The indentation before the label (and the pre-label string), default is 1.
`protected String`	`preLabelStr` A string printed directly before the label, other than indentation, default is empty string.
`protected int`	`width` The maximum width if the list (and all items and sub-lists), -1 for no width until set otherwise.

Fields inherited from interface AsciiList
IMPLICIT_NEWLINE

Constructor Summary

Constructors
Constructor and Description
`AbstractAsciiList()` Creates a new list.
`AbstractAsciiList(AbstractAsciiList list)` Creates a new list.
`AbstractAsciiList(boolean isContinued)` Creates a new list.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`calculateMaxIndentation()` Calculates indentation for each element of the list and returns the maximum value.
`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.
`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`	`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.
`protected String`	`wrapItem(String renderedItem)` Wraps a rendered list item for the width given in the list.
`protected String`	`wrapItemNextLine(String str)` Wraps all following lines of an item

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface AsciiList
calculateMaxIndentation, copy, renderItem, setListStyle

- Field Detail
  - items
```
protected List<Object> items
```
    The items of a list.
  - preLabelIndent
```
protected int preLabelIndent
```
    The indentation before the label (and the pre-label string), default is 1.
  - postLabelIndent
```
protected int postLabelIndent
```
    The indentation after the label (and the post-label string), default is 1.
  - preLabelStr
```
protected String preLabelStr
```
    A string printed directly before the label, other than indentation, default is empty string.
  - postLabelStr
```
protected String postLabelStr
```
    A string printed directly after the label, other than indentation, default is empty string.
  - level
```
protected int level
```
    The level of the list, default is 1.
  - isContinued
```
protected final boolean isContinued
```
    Flag indicating if the list is continued from a previous list of the same type or not.
  - maxItemIndent
```
protected int maxItemIndent
```
    The maximum item indentation, 0 until calculated.
  - width
```
protected int width
```
    The maximum width if the list (and all items and sub-lists), -1 for no width until set otherwise.
- Constructor Detail
  - AbstractAsciiList
```
public AbstractAsciiList()
```
    Creates a new list.
  - AbstractAsciiList
```
public AbstractAsciiList(AbstractAsciiList list)
```
    Creates a new list.
    
    Parameters:
    
    list - original list
  - AbstractAsciiList
```
public AbstractAsciiList(boolean isContinued)
```
    Creates a new list.
    
    Parameters:
    
    isContinued - true if the list is continued from a previous list of the same type, false otherwise
- Method Detail
  - setLabelDefaults
```
public AsciiList setLabelDefaults()
```
    Description copied from interface: AsciiList
    
    Sets the values for pre/post paramters of labels back to their default values.
    
    Specified by:
    
    setLabelDefaults in interface AsciiList
    
    Returns:
    
    self to allow for chaining
  - calculateMaxIndentation
```
public int calculateMaxIndentation()
```
    Description copied from interface: AsciiList
    
    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.
    
    Specified by:
    
    calculateMaxIndentation in interface AsciiList
    
    Returns:
    
    maximum indentation calculated over all list items
  - getItems
```
public List<Object> getItems()
```
    Description copied from interface: AsciiList
    
    Returns the items of the list.
    
    Specified by:
    
    getItems in interface AsciiList
    
    Returns:
    
    items of the list
  - getLevel
```
public int getLevel()
```
    Description copied from interface: AsciiList
    
    Returns the level of the list.
    
    Specified by:
    
    getLevel in interface AsciiList
    
    Returns:
    
    list level, one if top list, greater than one if it is a nested list
  - getPostLabelIndent
```
public int getPostLabelIndent()
```
    Description copied from interface: AsciiList
    
    Sets the indentation to be used for an item after the label (and before the post-label string).
    
    Specified by:
    
    getPostLabelIndent in interface AsciiList
    
    Returns:
    
    indent post-label indentation
  - getPostLabelString
```
public String getPostLabelString()
```
    Description copied from interface: AsciiList
    
    Sets a string to be printed after an item label (and before the post-label indentation).
    
    Specified by:
    
    getPostLabelString in interface AsciiList
    
    Returns:
    
    postLabel string for post label
  - getPreLabelIndent
```
public int getPreLabelIndent()
```
    Description copied from interface: AsciiList
    
    Gets the indentation to be used for an item before the label (and after the pre-label string).
    
    Specified by:
    
    getPreLabelIndent in interface AsciiList
    
    Returns:
    
    indent pre-label indentation
  - getPreLabelString
```
public String getPreLabelString()
```
    Description copied from interface: AsciiList
    
    Sets a string to be printed before an item label (and after the pre-label indentation).
    
    Specified by:
    
    getPreLabelString in interface AsciiList
    
    Returns:
    
    preLabel string for pre-label
  - isContinuedList
```
public boolean isContinuedList()
```
    Description copied from interface: AsciiList
    
    Returns a flag indicating if the list is continued from a previous list of the same type or not.
    
    Specified by:
    
    isContinuedList in interface AsciiList
    
    Returns:
    
    true if is continued, false otherwise
  - render
```
public String render()
```
    Description copied from interface: AsciiList
    
    Renders the list, generates a string representation of it.
    
    Specified by:
    
    render in interface AsciiList
    
    Returns:
    
    rendered list
  - setLevel
```
public AsciiList setLevel(int level)
```
    Description copied from interface: AsciiList
    
    Sets the level of the list.
    
    Specified by:
    
    setLevel in interface AsciiList
    
    Parameters:
    
    level - new list level, should only be used if 2 or larger (nested list) using 1 as default
    
    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
  - setPostLabelIndent
```
public AsciiList setPostLabelIndent(int indent)
```
    Description copied from interface: AsciiList
    
    Sets the indentation to be used for an item after the label (and before the post-label string).
    
    Specified by:
    
    setPostLabelIndent in interface AsciiList
    
    Parameters:
    
    indent - post-label indentation, negative integer will use default
    
    Returns:
    
    self to allow chaining
  - setPostLabelString
```
public AsciiList setPostLabelString(String str)
```
    Description copied from interface: AsciiList
    
    Sets a string to be printed after an item label (and before the post-label indentation).
    
    Specified by:
    
    setPostLabelString in interface AsciiList
    
    Parameters:
    
    str - string for post label
    
    Returns:
    
    self to allow chaining
  - setPreLabelIndent
```
public AsciiList setPreLabelIndent(int indent)
```
    Description copied from interface: AsciiList
    
    Sets the indentation to be used for an item before the label (and after the pre-label string).
    
    Specified by:
    
    setPreLabelIndent in interface AsciiList
    
    Parameters:
    
    indent - pre-label indentation, negative integer will use default
    
    Returns:
    
    self to allow chaining
  - setPreLabelString
```
public AsciiList setPreLabelString(String str)
```
    Description copied from interface: AsciiList
    
    Sets a string to be printed before an item label (and after the pre-label indentation).
    
    Specified by:
    
    setPreLabelString in interface AsciiList
    
    Parameters:
    
    str - string for pre-label
    
    Returns:
    
    self to allow chaining
  - setWidth
```
public AsciiList setWidth(int width)
```
    Description copied from interface: AsciiList
    
    Sets the (maximum) width a list (and all items and sub-lists) can have when being rendered.
    
    Specified by:
    
    setWidth in interface AsciiList
    
    Parameters:
    
    width - maximum width
    
    Returns:
    
    self to allow chaining
  - wrapItem
```
protected String wrapItem(String renderedItem)
```
    Wraps a rendered list item for the width given in the list.
    
    Parameters:
    
    renderedItem - the rendered item to wrap
    
    Returns:
    
    a string with the wrapped item (lines separated by "\n")
  - wrapItemNextLine
```
protected String wrapItemNextLine(String str)
```
    Wraps all following lines of an item
    
    Parameters:
    
    str - the string to wrap
    
    Returns:
    
    wrapped string

Class AbstractAsciiList

Field Summary

Fields inherited from interface AsciiList

Constructor Summary

Method Summary

Methods inherited from class Object

Methods inherited from interface AsciiList

Field Detail

items

preLabelIndent

postLabelIndent

preLabelStr

postLabelStr

level

isContinued

maxItemIndent

width

Constructor Detail

AbstractAsciiList

AbstractAsciiList

AbstractAsciiList

Method Detail

setLabelDefaults

calculateMaxIndentation

getItems

getLevel

getPostLabelIndent

getPostLabelString

getPreLabelIndent

getPreLabelString

isContinuedList

render

setLevel

prepareRender

setPostLabelIndent

setPostLabelString

setPreLabelIndent

setPreLabelString

setWidth

wrapItem

wrapItemNextLine