com.googlecode.lanterna.gui

Interface InteractableContainer

All Known Implementing Classes:

AbstractContainer, Panel, Table

public interface InteractableContainer

Containers containing interactable components must implement this interface so that the GUI system knows how to switch between the different components.

Author:

Martin

Method Summary

Methods

Modifier and Type	Method and Description
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.
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.
boolean	triggerShortcut(Key key) Looks for a shortcut that matches this key and, if one is found, executes it.

Method Detail

hasInteractable

boolean hasInteractable(Interactable interactable)

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

Parameters:

interactable - interactable to look for

Returns:

true if the container has interactable, otherwise false

nextFocus

Interactable nextFocus(Interactable fromThis)

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

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

Interactable previousFocus(Interactable fromThis)

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

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

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

Parameters:

key - Kind of key to trigger the shortcut

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

addShortcut

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. If you want to add a keyboard shortcut for a special keys, please use addShortcut(Key.Kind, Action).

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

boolean triggerShortcut(Key key)

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

Parameters:

key - Key to check for matching shortcuts

Returns:

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