de.vandermeer.asciithemes

Interface TA_ItemizeList

All Superinterfaces:

CategoryHas, CategoryIs, HasDescription, HasToDoc, IsTextArt, TA_List

public interface TA_ItemizeList
extends TA_List

An itemize list using ASCII and UTF-8 characters.

Since:

v0.0.1

Version:

v0.0.1 build 170404 (04-Apr-17) for Java 1.8

Author:

Sven van der Meer <vdmeer.sven@mykolab.com>

Field Summary

Fields inherited from interface HasDescription

DEFAULT_DESCRIPTION

Method Summary

Modifier and Type	Method and Description
static TA_ItemizeList	create(Character label, String description) Creates a new itemize list with unlimited levels for given character.
static TA_ItemizeList	create(String description, Character... characters) Creates a new itemize list for levels provided by the given characters.
static TA_ItemizeList	createIncremental(Character label, String description) Creates a new itemize list with unlimited levels for given character.
String	getLabel(int level) Returns the label for a given level.
int	getMaxLevel() Returns the max level the style supports.
default StrBuilder	toDoc()

Methods inherited from interface HasDescription

getDescription

Method Detail

getLabel

String getLabel(int level)

Returns the label for a given level.

Parameters:

level - the level for the requested style

Returns:

label for a given level, null if not set or supported

Throws:

NotImplementedException - if requested level is not supported

getMaxLevel

int getMaxLevel()

Returns the max level the style supports.

Returns:

ax level, if set to -1 then the style provides unlimited levels

toDoc

default StrBuilder toDoc()

Specified by:

toDoc in interface HasToDoc

create

static TA_ItemizeList create(Character label,
                             String description)

Creates a new itemize list with unlimited levels for given character.

Parameters:

label - character as label

description - list description

Returns:

new list

createIncremental

static TA_ItemizeList createIncremental(Character label,
                                        String description)

Creates a new itemize list with unlimited levels for given character. Incremental means that level 1 has 1 character, level 2 has 2 characters, level 3 has 3 characters and so forth.

Parameters:

label - character as label

description - list description

Returns:

new list

create

static TA_ItemizeList create(String description,
                             Character... characters)

Creates a new itemize list for levels provided by the given characters.

Parameters:

description - list description

characters - characters in order of level they support (level 1 is first, level n is last)

Returns:

new list