com.googlecode.lanterna.gui.component

Class TextArea

java.lang.Object

com.googlecode.lanterna.gui.component.AbstractComponent

com.googlecode.lanterna.gui.component.AbstractInteractableComponent

com.googlecode.lanterna.gui.component.TextArea

All Implemented Interfaces:

Component, InteractableComponent, Interactable

public class TextArea
extends AbstractInteractableComponent

This component is designed for displaying large chunks of text. If the text is larger than the component, it will display scrollbars and letting the user scroll through the text using the arrow keys.

Author:

mberglun

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
TextArea()
TextArea(String text)
TextArea(TerminalSize preferredSize, String text)

Method Summary

Methods

Modifier and Type	Method and Description
void	appendLine(String line)
protected TerminalSize	calculatePreferredSize()
void	clear()
String	getLine(int index)
TerminalSize	getMaximumSize()
TerminalSize	getMinimumSize() This method is called by the layout system to figure out what the absolute minimum size is for this component.
void	insertLine(int index, String line)
boolean	isScrollable() This method is used by the layout system when it needs to shrink components because the available space is too small.
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 void	printItem(TextGraphics graphics, int x, int y, String text)
void	removeLine(int lineNumber)
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	setLine(int index, String line)
void	setMaximumSize(TerminalSize maximumSize)
void	setMinimumSize(TerminalSize minimumSize)

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, getParent, getPreferredSize, getWindow, invalidate, 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, getParent, getPreferredSize, getWindow, isVisible, removeComponentListener, setAlignment, setPreferredSize, setVisible

Constructor Detail

TextArea

public TextArea()

TextArea

public TextArea(String text)

TextArea

public TextArea(TerminalSize preferredSize,
        String text)

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

isScrollable

public boolean isScrollable()

Description copied from interface: Component

This method is used by the layout system when it needs to shrink components because the available space is too small. Scrollable components will be shrunk first.

Specified by:

isScrollable in interface Component

Overrides:

isScrollable in class AbstractComponent

Returns:

True if this component has a scrollable area and can contain more text than fits on the screen

setMaximumSize

public void setMaximumSize(TerminalSize maximumSize)

getMaximumSize

public TerminalSize getMaximumSize()

setMinimumSize

public void setMinimumSize(TerminalSize minimumSize)

getMinimumSize

public TerminalSize getMinimumSize()

Description copied from interface: Component

This method is called by the layout system to figure out what the absolute minimum size is for this component. If the component cannot be assigned this space, it will be inactivated and not rendered.

Specified by:

getMinimumSize in interface Component

Overrides:

getMinimumSize in class AbstractComponent

Returns:

The absolutely minimum space that needs to be available for this component

clear

public void clear()

getLine

public String getLine(int index)

appendLine

public void appendLine(String line)

insertLine

public void insertLine(int index,
              String line)

setLine

public void setLine(int index,
           String line)

removeLine

public void removeLine(int lineNumber)

printItem

protected void printItem(TextGraphics graphics,
             int x,
             int y,
             String text)