com.googlecode.lanterna.gui.component

Class CommonCheckBox

java.lang.Object

com.googlecode.lanterna.gui.component.AbstractComponent

com.googlecode.lanterna.gui.component.AbstractInteractableComponent

com.googlecode.lanterna.gui.component.CommonCheckBox

All Implemented Interfaces:

Component, InteractableComponent, Interactable

Direct Known Subclasses:

CheckBox

public abstract class CommonCheckBox
extends AbstractInteractableComponent

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
CommonCheckBox(String label)

Method Summary

Methods

Modifier and Type	Method and Description
protected TerminalSize	calculatePreferredSize()
protected abstract char	getSelectionCharacter()
abstract boolean	isSelected()
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 abstract void	onActivated()
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	select()
protected abstract String	surroundCharacter(char character)

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

afterEnteredFocus, 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, 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.Component

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

Constructor Detail

CommonCheckBox

public CommonCheckBox(String label)

Method Detail

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.

Parameters:

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

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

isSelected

public abstract boolean isSelected()

getSelectionCharacter

protected abstract char getSelectionCharacter()

surroundCharacter

protected abstract String surroundCharacter(char character)

onActivated

protected abstract void onActivated()

select

public void select()