com.googlecode.lanterna.gui.component

Class EditArea

java.lang.Object

com.googlecode.lanterna.gui.component.AbstractComponent

com.googlecode.lanterna.gui.component.AbstractInteractableComponent

com.googlecode.lanterna.gui.component.EditArea

All Implemented Interfaces:

Component, InteractableComponent, Interactable

public class EditArea
extends AbstractInteractableComponent

Multi-line text edit component

Author:

David John Truman, Nicolas Pellegrin

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
EditArea()
EditArea(TerminalSize preferredSize)
EditArea(TerminalSize preferredSize, String text)
EditArea(TerminalSize preferredSize, String text, boolean lockPreferredSize)

Method Summary

Methods

Modifier and Type	Method and Description
void	backspace() Action for "Backspace" key
protected TerminalSize	calculatePreferredSize()
void	delete() Action for "Del" key.
protected void	drawDisplay(TextGraphics g)
void	fix_issue()
String	getData()
TerminalSize	getDataSize()
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	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	scrollLeft() Scroll left all text in the area.
void	scrollRight() Scroll right all text in the area.
void	setCharacterLimit(int limit) Set the line limit.
void	setData(String data) Change all the text in the area.

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

EditArea

public EditArea()

EditArea

public EditArea(TerminalSize preferredSize)

EditArea

public EditArea(TerminalSize preferredSize,
        String text)

EditArea

public EditArea(TerminalSize preferredSize,
        String text,
        boolean lockPreferredSize)

Method Detail

backspace

public void backspace()

Action for "Backspace" key

calculatePreferredSize

protected TerminalSize calculatePreferredSize()

Specified by:

calculatePreferredSize in class AbstractComponent

delete

public void delete()

Action for "Del" key.

drawDisplay

protected void drawDisplay(TextGraphics g)

fix_issue

public void fix_issue()

getData

public String getData()

getDataSize

public TerminalSize getDataSize()

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

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

scrollLeft

public void scrollLeft()

Scroll left all text in the area.

scrollRight

public void scrollRight()

Scroll right all text in the area.

setCharacterLimit

public void setCharacterLimit(int limit)

Set the line limit.

setData

public void setData(String data)

Change all the text in the area.