com.googlecode.lanterna.gui.component

Class Table

java.lang.Object

com.googlecode.lanterna.gui.component.AbstractComponent

com.googlecode.lanterna.gui.component.Table

All Implemented Interfaces:

Component, InteractableContainer

public class Table
extends AbstractComponent
implements InteractableContainer

Author:

Martin

Nested Class Summary

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

Component.Alignment

Constructor Summary

Constructors

Constructor and Description
Table()
Table(int nrOfColumns)
Table(int nrOfColumns, String title)
Table(String title)

Method Summary

Methods

Modifier and Type	Method and Description
void	addRow(Component... components) Adds a new row to this table, using the given components as its cells.
void	addShortcut(char character, boolean withCtrl, boolean withAlt, Action action) Adds a keyboard shortcut to be invoked when the Interactable component in focus within this container didn't handle the keyboard event and the event matches the supplied character and control key status.
void	addShortcut(Key.Kind key, Action action) Adds a keyboard shortcut to be invoked when the Interactable component in focus within this container didn't handle the keyboard event and the event matches the supplied Key.Kind.
void	alterTableStructure(int nrOfColumns)
protected TerminalSize	calculatePreferredSize()
int	getNrOfRows()
Component[]	getRow(int index)
String	getTitle()
boolean	hasInteractable(Interactable interactable) Returns true if this container contains the interactable passed in as the parameter
Interactable	nextFocus(Interactable fromThis) Given an interactable, find the next one in line to receive focus.
Interactable	previousFocus(Interactable fromThis) Given an interactable, find the previous one in line to receive focus.
void	removeAllRows() Removes all rows from this table.
void	removeRow(int index)
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	setColumnPaddingSize(int size)
protected void	setParent(Container container)
void	setTitle(String title)
boolean	triggerShortcut(Key key) Looks for a shortcut that matches this key and, if one is found, executes it.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Table

public Table()

Table

public Table(String title)

Table

public Table(int nrOfColumns)

Table

public Table(int nrOfColumns,
     String title)

Method Detail

setColumnPaddingSize

public void setColumnPaddingSize(int size)

addRow

public void addRow(Component... components)

Adds a new row to this table, using the given components as its cells.

getNrOfRows

public int getNrOfRows()

getRow

public Component[] getRow(int index)

removeRow

public void removeRow(int index)

alterTableStructure

public final void alterTableStructure(int nrOfColumns)

removeAllRows

public void removeAllRows()

Removes all rows from this table.

calculatePreferredSize

protected TerminalSize calculatePreferredSize()

Specified by:

calculatePreferredSize in class AbstractComponent

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.

Specified by:

repaint in interface Component

Parameters:

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

setParent

protected void setParent(Container container)

Overrides:

setParent in class AbstractComponent

hasInteractable

public boolean hasInteractable(Interactable interactable)

Description copied from interface: InteractableContainer

Returns true if this container contains the interactable passed in as the parameter

Specified by:

hasInteractable in interface InteractableContainer

Parameters:

interactable - interactable to look for

Returns:

true if the container has interactable, otherwise false

nextFocus

public Interactable nextFocus(Interactable fromThis)

Description copied from interface: InteractableContainer

Given an interactable, find the next one in line to receive focus.

Specified by:

nextFocus in interface InteractableContainer

Parameters:

fromThis - Component from which to get the next interactable, or if null, pick the first available interactable

Returns:

The next interactable component, or null if there are no more interactables in the list

previousFocus

public Interactable previousFocus(Interactable fromThis)

Description copied from interface: InteractableContainer

Given an interactable, find the previous one in line to receive focus.

Specified by:

previousFocus in interface InteractableContainer

Parameters:

fromThis - Component from which to get the previous interactable, or if null, pick the last interactable in the list

Returns:

The previous interactable component, or null if there are no more interactables in the list

addShortcut

public void addShortcut(Key.Kind key,
               Action action)

Description copied from interface: InteractableContainer

Adds a keyboard shortcut to be invoked when the Interactable component in focus within this container didn't handle the keyboard event and the event matches the supplied Key.Kind. Please note that calling addShortcut with Key.Kind.NormalKey will throw IllegalArgumentException; if you want to add a keyboard shortcut for a non-special key, please use addShortcut(char, boolean, boolean, Action).

Specified by:

addShortcut in interface InteractableContainer

Parameters:

key - Kind of key to trigger the shortcut

action - Action to run, on the event thread, when the shortcut is triggered

addShortcut

public void addShortcut(char character,
               boolean withCtrl,
               boolean withAlt,
               Action action)

Description copied from interface: InteractableContainer

Adds a keyboard shortcut to be invoked when the Interactable component in focus within this container didn't handle the keyboard event and the event matches the supplied character and control key status. If you want to add a keyboard shortcut for a special keys, please use addShortcut(Key.Kind, Action).

Specified by:

addShortcut in interface InteractableContainer

Parameters:

character - Character types on the keyboard to trigger the shortcut

withCtrl - If true, ctrl key must be down when the key is typed to trigger; if false the ctrl key must be up to trigger

withAlt - If true, alt key must be down when the key is typed to trigger; if false the alt key must be up to trigger

action - Action to run, on the event thread, when the shortcut is triggered

triggerShortcut

public boolean triggerShortcut(Key key)

Description copied from interface: InteractableContainer

Looks for a shortcut that matches this key and, if one is found, executes it.

Specified by:

triggerShortcut in interface InteractableContainer

Parameters:

key - Key to check for matching shortcuts

Returns:

true if a shortcut was triggered and executed, false otherwise.

getTitle

public String getTitle()

setTitle

public void setTitle(String title)