Package 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	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

BACKSPACE, BULLET, CARRIAGE_RETURN, cursor, DELETE, displayText, fontOffset, glyphPositions, hasSelection, keyRepeatInitialTime, keyRepeatTime, layout, NEWLINE, selectionStart, TAB, text, textHeight, textOffset, visibleTextEnd, visibleTextStart, writeEnters

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected void	calculateOffsets()
protected boolean	continueCursor(int index, int offset)
protected InputListener	createInputListener()
protected void	drawCursor(Drawable cursorPatch, Batch batch, BitmapFont font, float x, float y)
protected void	drawSelection(Drawable selection, Batch batch, BitmapFont font, float x, float y)	Draws selection rectangle
protected void	drawText(Batch batch, BitmapFont font, float x, float y)
int	getCursorLine()
float	getCursorX()
float	getCursorY()
int	getFirstLineShowing()
int	getLines()	Returns total number of lines that the text occupies
int	getLinesShowing()
float	getPrefHeight()
protected float	getTextY(BitmapFont font, Drawable background)
protected void	initialize()
protected int	letterUnderCursor(float x)
protected void	moveCursor(boolean forward, boolean jump)
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)
protected void	sizeChanged()	Called when the actor's size has been changed.

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

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

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, drawDebugBounds, 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, positionChanged, remove, removeAction, removeCaptureListener, removeListener, rotateBy, rotationChanged, scaleBy, scaleBy, scaleChanged, screenToLocalCoordinates, setBounds, setColor, setColor, setDebug, setHeight, setName, setOrigin, setOrigin, setOriginX, setOriginY, setParent, setPosition, setPosition, setRotation, setScale, setScale, setScaleX, setScaleY, setSize, setStage, setTouchable, setUserObject, setVisible, setWidth, setX, setX, setY, setY, setZIndex, sizeBy, sizeBy, stageToLocalCoordinates, toBack, toFront, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TextArea

public TextArea(java.lang.String text,
                Skin skin)

TextArea

public TextArea(java.lang.String text,
                Skin skin,
                java.lang.String styleName)

TextArea

public TextArea(java.lang.String text,
                TextField.TextFieldStyle style)

Method Detail

initialize

protected void initialize()

Overrides:

initialize in class TextField

letterUnderCursor

protected int letterUnderCursor(float x)

Overrides:

letterUnderCursor in class TextField

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

sizeChanged

protected void sizeChanged()

Description copied from class: Actor

Called when the actor's size has been changed.

Overrides:

sizeChanged in class Widget

getTextY

protected float getTextY(BitmapFont font,
                         @Null
                         Drawable background)

Overrides:

getTextY in class TextField

drawSelection

protected void drawSelection(Drawable selection,
                             Batch batch,
                             BitmapFont font,
                             float x,
                             float y)

Description copied from class: TextField

Draws selection rectangle

Overrides:

drawSelection in class TextField

drawText

protected void drawText(Batch batch,
                        BitmapFont font,
                        float x,
                        float y)

Overrides:

drawText in class TextField

drawCursor

protected void drawCursor(Drawable cursorPatch,
                          Batch batch,
                          BitmapFont font,
                          float x,
                          float y)

Overrides:

drawCursor in class TextField

calculateOffsets

protected void calculateOffsets()

Overrides:

calculateOffsets in class TextField

createInputListener

protected InputListener createInputListener()

Overrides:

createInputListener in class TextField

setSelection

public void setSelection(int selectionStart,
                         int selectionEnd)

Description copied from class: TextField

Sets the selected text.

Overrides:

setSelection in class TextField

moveCursor

protected void moveCursor(boolean forward,
                          boolean jump)

Overrides:

moveCursor in class TextField

continueCursor

protected boolean continueCursor(int index,
                                 int offset)

Overrides:

continueCursor in class TextField

getCursorLine

public int getCursorLine()

getFirstLineShowing

public int getFirstLineShowing()

getLinesShowing

public int getLinesShowing()

getCursorX

public float getCursorX()

getCursorY

public float getCursorY()