de.vandermeer.asciithemes

Interface TA_CheckedItem

All Superinterfaces:

CategoryHas, CategoryIs, HasDescription, HasToDoc, IsTextArt

public interface TA_CheckedItem
extends IsTextArt

An item that has a checked and an unchecked label.

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_CheckedItem	create(Character checked, Character unchecked, String description) Creates a new checked item.
static TA_CheckedItem	create(String checked, String unchecked, String description) Creates a new checked item.
String	getCheckedLabel() Returns the checked label.
default String	getLabel(boolean checked) Returns the label for a given level.
String	getUncheckedLabel() Returns the unchecked label
default StrBuilder	toDoc()

Methods inherited from interface HasDescription

getDescription

Method Detail

getLabel

default String getLabel(boolean checked)

Returns the label for a given level.

Parameters:

checked - flag for a checked (true) or unchecked (false) label

Returns:

the label

getCheckedLabel

String getCheckedLabel()

Returns the checked label.

Returns:

checked label

getUncheckedLabel

String getUncheckedLabel()

Returns the unchecked label

Returns:

unchecked label

toDoc

default StrBuilder toDoc()

Specified by:

toDoc in interface HasToDoc

create

static TA_CheckedItem create(Character checked,
                             Character unchecked,
                             String description)

Creates a new checked item.

Parameters:

checked - checked label character

unchecked - unckecked label character

description - item description

Returns:

new checked item

create

static TA_CheckedItem create(String checked,
                             String unchecked,
                             String description)

Creates a new checked item.

Parameters:

checked - checked label string

unchecked - unckecked label string

description - item description

Returns:

new checked item