com.googlecode.lanterna.gui.component

Class RadioCheckBoxList

java.lang.Object

com.googlecode.lanterna.gui.component.AbstractComponent

com.googlecode.lanterna.gui.component.AbstractInteractableComponent

com.googlecode.lanterna.gui.component.AbstractListBox

com.googlecode.lanterna.gui.component.RadioCheckBoxList

All Implemented Interfaces:

Component, InteractableComponent, Interactable

public class RadioCheckBoxList
extends AbstractListBox

The list box will display a number of items, of which one and only one can be marked as selected. The user can select an item in the list box by pressing the return key or space bar key. If you select one item when another item is already selected, the previously selected item will be deselected and the highlighted item will be the selected one instead.

Author:

Martin

Nested Class Summary

Nested classes/interfaces inherited from interface com.googlecode.lanterna.gui.Interactable

Interactable.FocusChangeDirection, Interactable.Result

Nested classes/interfaces inherited from interface com.googlecode.lanterna.gui.Component

Component.Alignment

Constructor Summary

Constructors

Constructor and Description
RadioCheckBoxList() Creates a new RadioCheckBoxList with no items
RadioCheckBoxList(TerminalSize preferredSize) Creates a new RadioCheckBoxList with a specified size override

Method Summary

Methods

Modifier and Type	Method and Description
void	addItem(Object item)
void	clearItems()
protected String	createItemString(int index)
Object	getCheckedItem()
int	getCheckedItemIndex()
protected int	getHotSpotPositionOnLine(int selectedIndex)
protected Theme.Definition	getListItemThemeDefinition(Theme theme)
protected Theme.Definition	getSelectedListItemThemeDefinition(Theme theme)
Boolean	isChecked(int index) This method will see if an item, adressed by index, is the currently selected item in this RadioCheckBoxList
Boolean	isChecked(Object object) This method will see if an object is the currently selected item in this RadioCheckBoxList
void	setCheckedItemIndex(int index) Sets the currently selected item by index
protected Interactable.Result	unhandledKeyboardEvent(Key key)

Methods inherited from class com.googlecode.lanterna.gui.component.AbstractListBox

afterEnteredFocus, calculatePreferredSize, getItemAt, getNrOfItems, getSelectedIndex, getSelectedItem, getSize, indexOf, isScrollable, keyboardInteraction, printItem, repaint, setSelectedItem

Methods inherited from class com.googlecode.lanterna.gui.component.AbstractInteractableComponent

afterLeftFocus, getHotspot, hasFocus, onEnterFocus, onLeaveFocus, setHotspot

Methods inherited from class com.googlecode.lanterna.gui.component.AbstractComponent

addBorder, addComponentListener, getAlignment, getComponentListeners, getGUIScreen, getMinimumSize, getParent, getPreferredSize, getWindow, invalidate, isVisible, removeComponentListener, setAlignment, setParent, setPreferredSize, setVisible, transformAccordingToAlignment

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.googlecode.lanterna.gui.Component

addBorder, addComponentListener, getAlignment, getMinimumSize, getParent, getPreferredSize, getWindow, isVisible, removeComponentListener, setAlignment, setPreferredSize, setVisible

Constructor Detail

RadioCheckBoxList

public RadioCheckBoxList()

Creates a new RadioCheckBoxList with no items

RadioCheckBoxList

public RadioCheckBoxList(TerminalSize preferredSize)

Creates a new RadioCheckBoxList with a specified size override

Parameters:

preferredSize - Size of the RadioCheckBoxList or null to use the default calculation algorithm

Method Detail

clearItems

public void clearItems()

Overrides:

clearItems in class AbstractListBox

addItem

public void addItem(Object item)

Overrides:

addItem in class AbstractListBox

isChecked

public Boolean isChecked(Object object)

This method will see if an object is the currently selected item in this RadioCheckBoxList

Parameters:

object - Object to test if it's the selected one

Returns:

true if the supplied object is what's currently selected in the list box, false otherwise. Returns null if the supplied object is not an item in the list box.

isChecked

public Boolean isChecked(int index)

This method will see if an item, adressed by index, is the currently selected item in this RadioCheckBoxList

Parameters:

index - Index of the item to check if it's currently selected

Returns:

true if the currently selected object is at the supplied index, false otherwise. Returns null if the index is out of range.

setCheckedItemIndex

public void setCheckedItemIndex(int index)

Sets the currently selected item by index

Parameters:

index - Index of the item to be selected

getCheckedItemIndex

public int getCheckedItemIndex()

Returns:

The index of the item which is currently selected, or -1 if there is no selection

getCheckedItem

public Object getCheckedItem()

Returns:

The object currently selected, or null if there is no selection

unhandledKeyboardEvent

protected Interactable.Result unhandledKeyboardEvent(Key key)

Overrides:

unhandledKeyboardEvent in class AbstractListBox

getHotSpotPositionOnLine

protected int getHotSpotPositionOnLine(int selectedIndex)

Overrides:

getHotSpotPositionOnLine in class AbstractListBox

createItemString

protected String createItemString(int index)

Specified by:

createItemString in class AbstractListBox

getListItemThemeDefinition

protected Theme.Definition getListItemThemeDefinition(Theme theme)

Overrides:

getListItemThemeDefinition in class AbstractListBox

getSelectedListItemThemeDefinition

protected Theme.Definition getSelectedListItemThemeDefinition(Theme theme)

Overrides:

getSelectedListItemThemeDefinition in class AbstractListBox