de.vandermeer.asciithemes

Interface TA_EnumerateList

All Superinterfaces:

CategoryHas, CategoryIs, HasDescription, HasToDoc, IsTextArt, TA_List

public interface TA_EnumerateList
extends TA_List

An enumerate 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_EnumerateList	create(String description, TA_Numbering... numbering) Creates a new enumerate list with levels provided by given numbering schemes.
static TA_EnumerateList	create(TA_Numbering numbering, String description) Creates a new enumerate list with unlimited levels for given numbering scheme.
String	getLabel(int level) Returns the label for a given level.
default String	getLabel(int[] levels, String separator, boolean useSepOnLast) Returns a label constructed of labels for each 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. If the list is implementing a nested style, this method will always use the top level style.

Parameters:

level - the level for the requested style

Returns:

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

Throws:

IllegalArgumentException - if requested level is not supported

getLabel

default String getLabel(int[] levels,
                        String separator,
                        boolean useSepOnLast)

Returns a label constructed of labels for each given level.

Parameters:

levels - the levels, each entry marks the number for the given level

separator - the separator between numbers, can be null

useSepOnLast - use true if the last number gets a separator, false if not

Returns:

label string, unless overwritten this will be null if the max level is not -1

Throws:

IllegalArgumentException - if any 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_EnumerateList create(TA_Numbering numbering,
                               String description)

Creates a new enumerate list with unlimited levels for given numbering scheme.

Parameters:

numbering - the numbering scheme to use

description - list description

Returns:

new list

create

static TA_EnumerateList create(String description,
                               TA_Numbering... numbering)

Creates a new enumerate list with levels provided by given numbering schemes.

Parameters:

description - list description

numbering - an array with numbering schemes

Returns:

new list