com.googlecode.lanterna.gui

Interface Interactable

All Known Subinterfaces:

InteractableComponent

All Known Implementing Classes:

AbstractInteractableComponent, AbstractListBox, ActionListBox, Button, CheckBox, CheckBoxList, CommonCheckBox, EditArea, PasswordBox, RadioCheckBoxList, TextArea, TextBox

public interface Interactable

Any component which wants to receive keyboard events must implement this interface.

Author:

Martin

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Interactable.FocusChangeDirection When focus has changed, which direction.
static class	Interactable.Result The available results from a keyboard interaction

Method Summary

Methods

Modifier and Type	Method and Description
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.
Interactable.Result	keyboardInteraction(Key key) This method is called when this component has focus and the user has pressed a key on the keyboard.
void	onEnterFocus(Interactable.FocusChangeDirection direction) Method called when this component gained keyboard focus.
void	onLeaveFocus(Interactable.FocusChangeDirection direction) Method called when this component leaves keyboard focus.

Method Detail

keyboardInteraction

Interactable.Result keyboardInteraction(Key key)

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

onEnterFocus

void onEnterFocus(Interactable.FocusChangeDirection direction)

Method called when this component gained keyboard focus.

Parameters:

direction - What direction did the focus come from

onLeaveFocus

void onLeaveFocus(Interactable.FocusChangeDirection direction)

Method called when this component leaves keyboard focus.

Parameters:

direction - What direction is focus going to

getHotspot

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.

Returns:

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