de.vandermeer.asciithemes

Interface TA_Checklist

All Superinterfaces:

CategoryHas, CategoryIs, HasDescription, HasToDoc, IsTextArt, TA_List

public interface TA_Checklist
extends TA_List

A echecklist 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_Checklist	create(String description, TA_CheckedItem... items) Creates a new checklist list with levels.
static TA_Checklist	create(TA_CheckedItem item, String description) Creates a new checklist with unlimited levels.
String	getLabel(int level, boolean checked) 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,
                boolean checked)

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

checked - set true if the item is checked, false otherwise

Returns:

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

Throws:

IllegalArgumentException - 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_Checklist create(TA_CheckedItem item,
                           String description)

Creates a new checklist with unlimited levels.

Parameters:

item - the checked item to be used

description - list description

Returns:

new list

create

static TA_Checklist create(String description,
                           TA_CheckedItem... items)

Creates a new checklist list with levels.

Parameters:

description - list description

items - an array with checked items

Returns:

new list