com.googlecode.lanterna.gui.component

Class AbstractListBox

java.lang.Object

com.googlecode.lanterna.gui.component.AbstractComponent

com.googlecode.lanterna.gui.component.AbstractInteractableComponent

com.googlecode.lanterna.gui.component.AbstractListBox

All Implemented Interfaces:

Component, InteractableComponent, Interactable

Direct Known Subclasses:

ActionListBox, CheckBoxList, RadioCheckBoxList

public abstract class AbstractListBox
extends AbstractInteractableComponent

Common base class for list-type components (check box list, action list, etc)

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

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addItem(Object item)
protected void	afterEnteredFocus(Interactable.FocusChangeDirection direction)
protected TerminalSize	calculatePreferredSize()
void	clearItems()
protected abstract String	createItemString(int index)
protected int	getHotSpotPositionOnLine(int selectedIndex)
Object	getItemAt(int index)
protected Theme.Definition	getListItemThemeDefinition(Theme theme)
int	getNrOfItems()
int	getSelectedIndex()
Object	getSelectedItem()
protected Theme.Definition	getSelectedListItemThemeDefinition(Theme theme)
int	getSize()
int	indexOf(Object item)
boolean	isScrollable() This method is used by the layout system when it needs to shrink components because the available space is too small.
Interactable.Result	keyboardInteraction(Key key) This method is called when this component has focus and the user has pressed a key on the keyboard.
protected void	printItem(TextGraphics graphics, int x, int y, int index) Draws an item in the ListBox at specific coordinates.
void	repaint(TextGraphics graphics) This is the main 'paint' method for a component, it's called when lanterna wants the component to re-draw itself.
void	setSelectedItem(int index)
protected Interactable.Result	unhandledKeyboardEvent(Key key)

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

AbstractListBox

public AbstractListBox()

AbstractListBox

public AbstractListBox(TerminalSize preferredSize)

Method Detail

calculatePreferredSize

protected TerminalSize calculatePreferredSize()

Specified by:

calculatePreferredSize in class AbstractComponent

addItem

protected void addItem(Object item)

clearItems

public void clearItems()

indexOf

public int indexOf(Object item)

getSize

public int getSize()

getItemAt

public Object getItemAt(int index)

getNrOfItems

public int getNrOfItems()

setSelectedItem

public void setSelectedItem(int index)

getSelectedIndex

public int getSelectedIndex()

getSelectedItem

public Object getSelectedItem()

isScrollable

public boolean isScrollable()

Description copied from interface: Component

This method is used by the layout system when it needs to shrink components because the available space is too small. Scrollable components will be shrunk first.

Specified by:

isScrollable in interface Component

Overrides:

isScrollable in class AbstractComponent

Returns:

True if this component has a scrollable area and can contain more text than fits on the screen

repaint

public void repaint(TextGraphics graphics)

Description copied from interface: Component

This is the main 'paint' method for a component, it's called when lanterna wants the component to re-draw itself. Use the supplied TextGraphics object to draw the component. In order to find out how the size of your compnent (as decided by the layout), use the graphics objects and query for its size.

Parameters:

graphics - TextGraphics object to use for drawing the component and getting information about the drawing context

afterEnteredFocus

protected void afterEnteredFocus(Interactable.FocusChangeDirection direction)

Overrides:

afterEnteredFocus in class AbstractInteractableComponent

getSelectedListItemThemeDefinition

protected Theme.Definition getSelectedListItemThemeDefinition(Theme theme)

getListItemThemeDefinition

protected Theme.Definition getListItemThemeDefinition(Theme theme)

keyboardInteraction

public Interactable.Result keyboardInteraction(Key key)

Description copied from interface: Interactable

This method is called when this component has focus and the user has pressed a key on the keyboard.

Parameters:

key - Key pressed on the keyboard

Returns:

Result of this keyboard interaction, this can for example be a hint to the parent container to move input focus to a different component or telling that the event was processed by the component and no extra action is required

printItem

protected void printItem(TextGraphics graphics,
             int x,
             int y,
             int index)

Draws an item in the ListBox at specific coordinates. If you override this method, please note that the x and y positions have been pre-calculated for you and you should use the values supplied instead of trying to figure out the position on your own based on the index of the item.

Parameters:

graphics - TextGraphics object to use when drawing the item

x - X-coordinate on the terminal of the item, pre-adjusted for scrolling

y - Y-coordinate on the terminal of the item, pre-adjusted for scrolling

index - Index of the item that is to be drawn

unhandledKeyboardEvent

protected Interactable.Result unhandledKeyboardEvent(Key key)

getHotSpotPositionOnLine

protected int getHotSpotPositionOnLine(int selectedIndex)

createItemString

protected abstract String createItemString(int index)