com.badlogic.gdx.scenes.scene2d.ui

Class TextArea

java.lang.Object

com.badlogic.gdx.scenes.scene2d.Actor

com.badlogic.gdx.scenes.scene2d.ui.Widget

com.badlogic.gdx.scenes.scene2d.ui.TextField

com.badlogic.gdx.scenes.scene2d.ui.TextArea

All Implemented Interfaces:

Disableable, Layout

public class TextArea
extends TextField

A text input field with multiple lines.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	TextArea.TextAreaListener Input listener for the text area

Nested classes/interfaces inherited from class com.badlogic.gdx.scenes.scene2d.ui.TextField

TextField.DefaultOnscreenKeyboard, TextField.OnscreenKeyboard, TextField.TextFieldClickListener, TextField.TextFieldFilter, TextField.TextFieldListener, TextField.TextFieldStyle

Field Summary

Fields inherited from class com.badlogic.gdx.scenes.scene2d.ui.TextField

keyRepeatInitialTime, keyRepeatTime

Constructor Summary

Constructors

Constructor and Description
TextArea(String text, Skin skin)
TextArea(String text, Skin skin, String styleName)
TextArea(String text, TextField.TextFieldStyle style)

Method Summary

Modifier and Type	Method and Description
int	getCursorLine()
float	getCursorX()
float	getCursorY()
int	getFirstLineShowing()
int	getLines() Returns total number of lines that the text occupies
int	getLinesShowing()
float	getPrefHeight()
void	moveCursorLine(int line) Moves the cursor to the given number line
boolean	newLineAtEnd() Returns if there's a new line at then end of the text
void	setPrefRows(float prefRows) Sets the preferred number of rows (lines) for this text area.
void	setSelection(int selectionStart, int selectionEnd) Sets the selected text.
void	setStyle(TextField.TextFieldStyle style)

Methods inherited from class com.badlogic.gdx.scenes.scene2d.ui.TextField

appendText, clearSelection, copy, cut, draw, getAlignment, getCursorPosition, getDefaultInputListener, getMaxLength, getMessageText, getOnscreenKeyboard, getPrefWidth, getProgrammaticChangeEvents, getSelection, getSelectionStart, getStyle, getText, getTextFieldFilter, isDisabled, isPasswordMode, next, selectAll, setAlignment, setBlinkTime, setClipboard, setCursorPosition, setDisabled, setFocusTraversal, setMaxLength, setMessageText, setOnlyFontChars, setOnscreenKeyboard, setPasswordCharacter, setPasswordMode, setProgrammaticChangeEvents, setText, setTextFieldFilter, setTextFieldListener

Methods inherited from class com.badlogic.gdx.scenes.scene2d.ui.Widget

getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, invalidate, invalidateHierarchy, layout, needsLayout, pack, setFillParent, setLayoutEnabled, validate

Methods inherited from class com.badlogic.gdx.scenes.scene2d.Actor

act, addAction, addCaptureListener, addListener, ancestorsVisible, ascendantsVisible, clear, clearActions, clearListeners, clipBegin, clipBegin, clipEnd, debug, drawDebug, fire, firstAscendant, getActions, getCaptureListeners, getColor, getDebug, getHeight, getListeners, getName, getOriginX, getOriginY, getParent, getRight, getRotation, getScaleX, getScaleY, getStage, getTop, getTouchable, getUserObject, getWidth, getX, getX, getY, getY, getZIndex, hasActions, hasKeyboardFocus, hasParent, hasScrollFocus, hit, isAscendantOf, isDescendantOf, isTouchable, isTouchFocusListener, isTouchFocusTarget, isVisible, localToActorCoordinates, localToAscendantCoordinates, localToParentCoordinates, localToScreenCoordinates, localToStageCoordinates, moveBy, notify, parentToLocalCoordinates, remove, removeAction, removeCaptureListener, removeListener, rotateBy, scaleBy, scaleBy, screenToLocalCoordinates, setBounds, setColor, setColor, setDebug, setHeight, setName, setOrigin, setOrigin, setOriginX, setOriginY, setPosition, setPosition, setRotation, setScale, setScale, setScaleX, setScaleY, setSize, setTouchable, setUserObject, setVisible, setWidth, setX, setX, setY, setY, setZIndex, sizeBy, sizeBy, stageToLocalCoordinates, toBack, toFront, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TextArea

public TextArea(String text,
                Skin skin)

TextArea

public TextArea(String text,
                Skin skin,
                String styleName)

TextArea

public TextArea(String text,
                TextField.TextFieldStyle style)

Method Detail

setStyle

public void setStyle(TextField.TextFieldStyle style)

Overrides:

setStyle in class TextField

setPrefRows

public void setPrefRows(float prefRows)

Sets the preferred number of rows (lines) for this text area. Used to calculate preferred height

getPrefHeight

public float getPrefHeight()

Specified by:

getPrefHeight in interface Layout

Overrides:

getPrefHeight in class TextField

getLines

public int getLines()

Returns total number of lines that the text occupies

newLineAtEnd

public boolean newLineAtEnd()

Returns if there's a new line at then end of the text

moveCursorLine

public void moveCursorLine(int line)

Moves the cursor to the given number line

setSelection

public void setSelection(int selectionStart,
                         int selectionEnd)

Description copied from class: TextField

Sets the selected text.

Overrides:

setSelection in class TextField

getCursorLine

public int getCursorLine()

getFirstLineShowing

public int getFirstLineShowing()

getLinesShowing

public int getLinesShowing()

getCursorX

public float getCursorX()

getCursorY

public float getCursorY()