Module org.jline.prompt

Package org.jline.prompt.impl

Class DefaultCheckboxItem

java.lang.Object

org.jline.prompt.impl.DefaultCheckboxItem

All Implemented Interfaces:

CheckboxItem, PromptItem

public class DefaultCheckboxItem
extends Object
implements CheckboxItem

Default implementation of CheckboxItem interface.

Constructor Summary

Constructors

Constructor	Description
DefaultCheckboxItem(String name, String text)
DefaultCheckboxItem(String name, String text, boolean checked)
DefaultCheckboxItem(String name, String text, boolean checked, boolean disabled, String disabledText)
DefaultCheckboxItem(String name, String text, boolean checked, boolean disabled, String disabledText, String footer)

Method Summary

Modifier and Type	Method	Description
String	getDisabledText()	Get the text to display when this item is disabled.
String	getFooter()	Optional footer text shown dimmed below a list or checkbox while this item is focused.
String	getName()	Get the name of this item.
String	getText()	Get the text to display for this item.
boolean	isDisabled()	Whether this item is disabled.
boolean	isInitiallyChecked()	Whether this checkbox is initially checked.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jline.prompt.PromptItem

isSelectable

Constructor Details

DefaultCheckboxItem

public DefaultCheckboxItem(String name,
 String text,
 boolean checked,
 boolean disabled,
 String disabledText,
 String footer)

DefaultCheckboxItem

public DefaultCheckboxItem(String name,
 String text,
 boolean checked,
 boolean disabled,
 String disabledText)

DefaultCheckboxItem

public DefaultCheckboxItem(String name,
 String text,
 boolean checked)

DefaultCheckboxItem

public DefaultCheckboxItem(String name,
 String text)

Method Details

getName

public String getName()

Description copied from interface: PromptItem

Get the name of this item.

Specified by:

getName in interface PromptItem

Returns:

the name

getText

public String getText()

Description copied from interface: PromptItem

Get the text to display for this item.

Specified by:

getText in interface PromptItem

Returns:

the text

isInitiallyChecked

public boolean isInitiallyChecked()

Description copied from interface: CheckboxItem

Whether this checkbox is initially checked. This represents the default/initial state, not the current selection.

Specified by:

isInitiallyChecked in interface CheckboxItem

Returns:

true if this checkbox is initially checked

isDisabled

public boolean isDisabled()

Description copied from interface: PromptItem

Whether this item is disabled.

Specified by:

isDisabled in interface PromptItem

Returns:

true if this item is disabled

getDisabledText

public String getDisabledText()

Description copied from interface: PromptItem

Get the text to display when this item is disabled.

Specified by:

getDisabledText in interface PromptItem

Returns:

the disabled text

getFooter

public String getFooter()

Description copied from interface: PromptItem

Optional footer text shown dimmed below a list or checkbox while this item is focused.

Specified by:

getFooter in interface PromptItem

Returns:

the footer text, or null/empty for no footer

toString

public String toString()

Overrides:

toString in class Object