com.googlecode.lanterna.gui.component

Class ActionListBox

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.ActionListBox

All Implemented Interfaces:

Component, InteractableComponent, Interactable

public class ActionListBox
extends AbstractListBox

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
ActionListBox()
ActionListBox(TerminalSize preferredSize)

Method Summary

Methods

Modifier and Type	Method and Description
void	addAction(Action action) Adds an action to the list, using toString() of the action as a label
void	addAction(String label, Action action) Adds an action to the list, with a specified label
protected String	createItemString(int index)
TerminalPosition	getHotspot() When the component has keyboard focus, this method is called by the GUI system to figure out where should the cursor be positioned.
protected Theme.Definition	getListItemThemeDefinition(Theme theme)
protected Theme.Definition	getSelectedListItemThemeDefinition(Theme theme)
protected Interactable.Result	unhandledKeyboardEvent(Key key)

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

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

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

afterLeftFocus, 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

ActionListBox

public ActionListBox()

ActionListBox

public ActionListBox(TerminalSize preferredSize)

Method Detail

addAction

public void addAction(Action action)

Adds an action to the list, using toString() of the action as a label

Parameters:

action - Action to be performed when the user presses enter key

addAction

public void addAction(String label,
             Action action)

Adds an action to the list, with a specified label

Parameters:

label - Label to be displayed, representing the action

action - Action to be performed when the user presses enter key

unhandledKeyboardEvent

protected Interactable.Result unhandledKeyboardEvent(Key key)

Overrides:

unhandledKeyboardEvent in class AbstractListBox

createItemString

protected String createItemString(int index)

Specified by:

createItemString in class AbstractListBox

getHotspot

public TerminalPosition getHotspot()

Description copied from interface: Interactable

When the component has keyboard focus, this method is called by the GUI system to figure out where should the cursor be positioned.

Specified by:

getHotspot in interface Interactable

Overrides:

getHotspot in class AbstractInteractableComponent

Returns:

position of the cursor, in global coordinates, or null if the cursor should be hidden

getListItemThemeDefinition

protected Theme.Definition getListItemThemeDefinition(Theme theme)

Overrides:

getListItemThemeDefinition in class AbstractListBox

getSelectedListItemThemeDefinition

protected Theme.Definition getSelectedListItemThemeDefinition(Theme theme)

Overrides:

getSelectedListItemThemeDefinition in class AbstractListBox