Package arc.scene.ui

Class TextArea

java.lang.Object

arc.scene.Element

arc.scene.ui.TextField

arc.scene.ui.TextArea

All Implemented Interfaces:

Disableable

public class TextArea
extends TextField

A multiple-line text input field, entirely based on TextField

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 arc.scene.ui.TextField

TextField.TextFieldClickListener, TextField.TextFieldFilter, TextField.TextFieldListener, TextField.TextFieldStyle, TextField.TextFieldValidator

Field Summary

Fields

Modifier and Type	Field	Description
protected int	cursorLine	Current line for the cursor
protected int	firstLineShowing	Index of the first line showed by the text area
protected String	lastText	Last text processed.
protected IntSeq	linesBreak	Array storing starting and ending positions of each line.
protected int	linesShowing	Number of lines showed by the text area
protected float	moveOffset	Variable to maintain the x offset of the cursor when moving up and down.
protected float	prefRows

Fields inherited from class arc.scene.ui.TextField

BACKSPACE, blinkTime, BULLET, cursor, cursorOn, DELETE, disabled, displayText, filter, focusTraversal, fontOffset, glyphPositions, hasInputDialog, hasSelection, imeData, inputDialogListener, inputListener, keyRepeatInitialTime, keyRepeatTask, keyRepeatTime, lastBlink, lastChangeTime, layout, listener, maxLength, messageText, onlyFontChars, passwordBuffer, passwordCharacter, passwordMode, programmaticChangeEvents, renderOffset, selectionStart, selectionWidth, selectionX, style, TAB, text, textHAlign, textHeight, textOffset, undoText, validator, visibleTextEnd, visibleTextStart, writeEnters

Fields inherited from class arc.scene.Element

color, cullable, fillParent, height, name, originX, originY, parent, parentAlpha, rotation, scaleX, scaleY, touchable, touchablility, translation, userObject, visibility, visible, width, x, y

Constructor Summary

Constructors

Constructor	Description
TextArea(String text)
TextArea(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, Font font, float x, float y)
protected void	drawSelection(Drawable selection, Font font, float x, float y)	Draws selection rectangle
protected void	drawText(Font 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(Font 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.
protected void	sizeChanged()	Called when the actor's size has been changed.

Methods inherited from class arc.scene.ui.TextField

addInputDialog, appendText, clearSelection, clearText, copy, cut, draw, getCursorPosition, getDefaultInputListener, getFilter, getMaxLength, getMessageText, getPrefWidth, getProgrammaticChangeEvents, getSelection, getSelectionStart, getStyle, getText, getValidator, isDisabled, isPasswordMode, isValid, isWordCharacter, next, paste, removeInputDialog, selectAll, setAlignment, setBlinkTime, setCursorPosition, setDisabled, setFilter, setFocusTraversal, setMaxLength, setMessageText, setOnlyFontChars, setPasswordCharacter, setPasswordMode, setProgrammaticChangeEvents, setStyle, setText, setTextFieldListener, setValidator, typed, typed, updateDisplayText, wordUnderCursor

Methods inherited from class arc.scene.Element

act, actions, addAction, addCaptureListener, addListener, change, changed, clear, clearActions, clearListeners, clicked, clicked, clicked, clicked, clipBegin, clipBegin, clipEnd, dragged, exited, fire, fireClick, getActions, getCaptureListeners, getHeight, getListeners, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getRight, getRotation, getScene, getTop, getWidth, getX, getY, getZIndex, hasActions, hasKeyboard, hasMouse, hasParent, hasScroll, hit, hovered, invalidate, invalidateHierarchy, isAscendantOf, isDescendantOf, isDescendantOf, isTouchable, keepInStage, keyDown, keyDown, layout, localToAscendantCoordinates, localToParentCoordinates, localToStageCoordinates, moveBy, needsLayout, notify, pack, parentToLocalCoordinates, released, remove, removeAction, removeCaptureListener, removeListener, requestKeyboard, requestScroll, rotateBy, rotationChanged, scaleBy, scaleBy, screenToLocalCoordinates, scrolled, setBounds, setColor, setColor, setFillParent, setHeight, setLayoutEnabled, setOrigin, setOrigin, setPosition, setPosition, setRotation, setRotationOrigin, setScale, setScale, setScene, setSize, setSize, setTranslation, setWidth, setZIndex, sizeBy, sizeBy, stageToLocalCoordinates, tapped, toBack, toFront, toString, touchable, update, updateVisibility, validate, visible

Methods inherited from class java.lang.Object

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

Field Details

linesBreak

protected IntSeq linesBreak

Array storing starting and ending positions of each line.

cursorLine

protected int cursorLine

Current line for the cursor

firstLineShowing

protected int firstLineShowing

Index of the first line showed by the text area

moveOffset

protected float moveOffset

Variable to maintain the x offset of the cursor when moving up and down. If it's set to -1, the offset is reset

lastText

protected String lastText

Last text processed. This attribute is used to avoid unnecessary computations while calculating offsets

linesShowing

protected int linesShowing

Number of lines showed by the text area

prefRows

protected float prefRows

Constructor Details

TextArea

public TextArea(String text)

TextArea

public TextArea(String text,
 TextField.TextFieldStyle style)

Method Details

initialize

protected void initialize()

Overrides:

initialize in class TextField

letterUnderCursor

protected int letterUnderCursor(float x)

Overrides:

letterUnderCursor 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()

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: Element

Called when the actor's size has been changed.

Overrides:

sizeChanged in class Element

getTextY

protected float getTextY(Font font,
 Drawable background)

Overrides:

getTextY in class TextField

drawSelection

protected void drawSelection(Drawable selection,
 Font font,
 float x,
 float y)

Description copied from class: TextField

Draws selection rectangle

Overrides:

drawSelection in class TextField

drawText

protected void drawText(Font font,
 float x,
 float y)

Overrides:

drawText in class TextField

drawCursor

protected void drawCursor(Drawable cursorPatch,
 Font 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()