com.googlecode.lanterna.gui.component

Class TextBox

java.lang.Object

com.googlecode.lanterna.gui.component.AbstractComponent

com.googlecode.lanterna.gui.component.AbstractInteractableComponent

com.googlecode.lanterna.gui.component.TextBox

All Implemented Interfaces:

Component, InteractableComponent, Interactable

Direct Known Subclasses:

PasswordBox

public class TextBox
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
TextBox() Creates a text box component, where the user can enter text by typing on the keyboard.
TextBox(String initialContent) Creates a text box component, where the user can enter text by typing on the keyboard.
TextBox(String initialContent, int width) Creates a text box component, where the user can enter text by typing on the keyboard.

Method Summary

Methods

Modifier and Type	Method and Description
protected TerminalSize	calculatePreferredSize()
int	getEditPosition()
char	getFillCharacter()
String	getText()
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 String	prerenderTransformation(String textboxString)
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	setEditPosition(int editPosition)
void	setFillCharacter(char fillCharacter)
void	setText(String text)

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

TextBox

public TextBox()

Creates a text box component, where the user can enter text by typing on the keyboard. It will be empty and 10 columns wide.

TextBox

public TextBox(String initialContent)

Creates a text box component, where the user can enter text by typing on the keyboard. The width of the text box will be calculated from the size of the initial content, passed in as the first argument. The text box will at least be 10 columns wide, regardless of the content though.

Parameters:

initialContent - Initial text content of the text box

TextBox

public TextBox(String initialContent,
       int width)

Creates a text box component, where the user can enter text by typing on the keyboard.

Parameters:

initialContent - Initial text content of the text box

width - Width, in columns, of the text box. Set to 0 if you want to autodetect the width based on initial content (will be set to 10 columns in width at minimum)

Method Detail

getText

public String getText()

setText

public void setText(String text)

setEditPosition

public void setEditPosition(int editPosition)

getEditPosition

public int getEditPosition()

prerenderTransformation

protected String prerenderTransformation(String textboxString)

getFillCharacter

public char getFillCharacter()

setFillCharacter

public void setFillCharacter(char fillCharacter)

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

calculatePreferredSize

protected TerminalSize calculatePreferredSize()

Specified by:

calculatePreferredSize in class AbstractComponent

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