com.googlecode.lanterna.gui.component

Class AbstractInteractableComponent

java.lang.Object

com.googlecode.lanterna.gui.component.AbstractComponent

com.googlecode.lanterna.gui.component.AbstractInteractableComponent

All Implemented Interfaces:

Component, InteractableComponent, Interactable

Direct Known Subclasses:

AbstractListBox, Button, CommonCheckBox, EditArea, TextArea, TextBox

public abstract class AbstractInteractableComponent
extends AbstractComponent
implements InteractableComponent

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
AbstractInteractableComponent()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	afterEnteredFocus(Interactable.FocusChangeDirection direction)
protected void	afterLeftFocus(Interactable.FocusChangeDirection direction)
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.
boolean	hasFocus() This method will return true if the component currently has input focus in the GUI
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.
protected void	setHotspot(TerminalPosition point) Sets the hotspot, in global coordinates, of where to put the text cursor when this component is active.

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

addBorder, addComponentListener, calculatePreferredSize, getAlignment, getComponentListeners, getGUIScreen, getMinimumSize, getParent, getPreferredSize, getWindow, invalidate, isScrollable, 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.Interactable

keyboardInteraction

Methods inherited from interface com.googlecode.lanterna.gui.Component

addBorder, addComponentListener, getAlignment, getMinimumSize, getParent, getPreferredSize, getWindow, isScrollable, isVisible, removeComponentListener, repaint, setAlignment, setPreferredSize, setVisible

Constructor Detail

AbstractInteractableComponent

public AbstractInteractableComponent()

Method Detail

onEnterFocus

public final void onEnterFocus(Interactable.FocusChangeDirection direction)

Description copied from interface: Interactable

Method called when this component gained keyboard focus.

Specified by:

onEnterFocus in interface Interactable

Parameters:

direction - What direction did the focus come from

onLeaveFocus

public final void onLeaveFocus(Interactable.FocusChangeDirection direction)

Description copied from interface: Interactable

Method called when this component leaves keyboard focus.

Specified by:

onLeaveFocus in interface Interactable

Parameters:

direction - What direction is focus going to

afterEnteredFocus

protected void afterEnteredFocus(Interactable.FocusChangeDirection direction)

afterLeftFocus

protected void afterLeftFocus(Interactable.FocusChangeDirection direction)

hasFocus

public boolean hasFocus()

This method will return true if the component currently has input focus in the GUI

Returns:

true if the component has input focus, otherwise false

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

Returns:

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

setHotspot

protected void setHotspot(TerminalPosition point)

Sets the hotspot, in global coordinates, of where to put the text cursor when this component is active. If called with a null argument, the cursor will be hidden while this component has focus.

Parameters:

point - Global coordinates of the hotspot position for this component, or null if the cursor is to be hidden