Nested and Inner Type Summary

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

Field Summary

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

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
private int	calculateCurrentLineIndex(int cursor) Calculates the text area line for the given cursor position
protected void	calculateOffsets() Overrides com.badlogic.gdx.scenes.scene2d.ui.TextField.calculateOffsets.
protected boolean	continueCursor(int index, int offset) Overrides com.badlogic.gdx.scenes.scene2d.ui.TextField.continueCursor.
protected InputListener	createInputListener() Overrides com.badlogic.gdx.scenes.scene2d.ui.TextField.createInputListener.
protected void	drawCursor(Drawable cursorPatch, Batch batch, BitmapFont font, float x, float y) Overrides com.badlogic.gdx.scenes.scene2d.ui.TextField.drawCursor.
protected void	drawSelection(Drawable selection, Batch batch, BitmapFont font, float x, float y) Overrides com.badlogic.gdx.scenes.scene2d.ui.TextField.drawSelection. Draws selection rectangle
protected void	drawText(Batch batch, BitmapFont font, float x, float y) Overrides com.badlogic.gdx.scenes.scene2d.ui.TextField.drawText.
public int	getCursorLine()
public float	getCursorX()
public float	getCursorY()
public int	getFirstLineShowing()
public int	getLines() Returns total number of lines that the text occupies
public int	getLinesShowing()
public float	getPrefHeight() Overrides com.badlogic.gdx.scenes.scene2d.ui.TextField.getPrefHeight. Implements com.badlogic.gdx.scenes.scene2d.utils.Layout.getPrefHeight.
protected float	getTextY(BitmapFont font, Drawable background) Overrides com.badlogic.gdx.scenes.scene2d.ui.TextField.getTextY.
protected void	initialize() Overrides com.badlogic.gdx.scenes.scene2d.ui.TextField.initialize.
protected int	letterUnderCursor(float x) Overrides com.badlogic.gdx.scenes.scene2d.ui.TextField.letterUnderCursor.
protected void	moveCursor(boolean forward, boolean jump) Overrides com.badlogic.gdx.scenes.scene2d.ui.TextField.moveCursor.
public void	moveCursorLine(int line) Moves the cursor to the given number line
public boolean	newLineAtEnd() Returns if there's a new line at then end of the text
public void	setPrefRows(float prefRows) Sets the preferred number of rows (lines) for this text area.
public void	setSelection(int selectionStart, int selectionEnd) Overrides com.badlogic.gdx.scenes.scene2d.ui.TextField.setSelection. Sets the selected text.
public void	setStyle(TextField.TextFieldStyle style) Overrides com.badlogic.gdx.scenes.scene2d.ui.TextField.setStyle. Implements com.badlogic.gdx.scenes.scene2d.ui.Styleable.setStyle. Set the current style of the actor
pack-priv void	showCursor() Scroll the text area to show the line of the cursor
protected void	sizeChanged() Overrides com.badlogic.gdx.scenes.scene2d.ui.Widget.sizeChanged. Called when the actor's size has been changed.
pack-priv void	updateCurrentLine() Updates the current line, checking the cursor position in the text
pack-priv void	updateFirstLineShowing()

Field Detail

cursorLine	back to summary
pack-priv int cursorLine Current line for the cursor

firstLineShowing	back to summary
pack-priv int firstLineShowing Index of the first line showed by the text area

lastText	back to summary
private String lastText Last text processed. This attribute is used to avoid unnecessary computations while calculating offsets

linesBreak	back to summary
pack-priv IntArray linesBreak Array storing lines breaks positions

linesShowing	back to summary
private int linesShowing Number of lines showed by the text area

moveOffset	back to summary
pack-priv 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

prefRows	back to summary
private float prefRows

Constructor Detail

TextArea	back to summary
public TextArea(String text, Skin skin)

TextArea	back to summary
public TextArea(String text, Skin skin, String styleName)

TextArea	back to summary
public TextArea(String text, TextField.TextFieldStyle style)

Method Detail

calculateCurrentLineIndex	back to summary
private int calculateCurrentLineIndex(int cursor) Calculates the text area line for the given cursor position

calculateOffsets	back to summary
protected void calculateOffsets() Overrides com.badlogic.gdx.scenes.scene2d.ui.TextField.calculateOffsets.

continueCursor	back to summary
protected boolean continueCursor(int index, int offset) Overrides com.badlogic.gdx.scenes.scene2d.ui.TextField.continueCursor.

createInputListener	back to summary
protected InputListener createInputListener() Overrides com.badlogic.gdx.scenes.scene2d.ui.TextField.createInputListener.

drawCursor	back to summary
protected void drawCursor(Drawable cursorPatch, Batch batch, BitmapFont font, float x, float y) Overrides com.badlogic.gdx.scenes.scene2d.ui.TextField.drawCursor.

drawSelection	back to summary
protected void drawSelection(Drawable selection, Batch batch, BitmapFont font, float x, float y) Overrides com.badlogic.gdx.scenes.scene2d.ui.TextField.drawSelection. Doc from com.badlogic.gdx.scenes.scene2d.ui.TextField.drawSelection. Draws selection rectangle

drawSelection

back to summary

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

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

Doc from com.badlogic.gdx.scenes.scene2d.ui.TextField.drawSelection.

Draws selection rectangle

drawText	back to summary
protected void drawText(Batch batch, BitmapFont font, float x, float y) Overrides com.badlogic.gdx.scenes.scene2d.ui.TextField.drawText.

getCursorLine	back to summary
public int getCursorLine()

getCursorX	back to summary
public float getCursorX()

getCursorY	back to summary
public float getCursorY()

getFirstLineShowing	back to summary
public int getFirstLineShowing()

getLines	back to summary
public int getLines() Returns total number of lines that the text occupies

getLinesShowing	back to summary
public int getLinesShowing()

getPrefHeight	back to summary
public float getPrefHeight() Overrides com.badlogic.gdx.scenes.scene2d.ui.TextField.getPrefHeight. Implements com.badlogic.gdx.scenes.scene2d.utils.Layout.getPrefHeight.

getPrefHeight

back to summary

public float getPrefHeight()

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

Implements com.badlogic.gdx.scenes.scene2d.utils.Layout.getPrefHeight.

getTextY	back to summary
protected float getTextY(BitmapFont font, Drawable background) Overrides com.badlogic.gdx.scenes.scene2d.ui.TextField.getTextY.

initialize	back to summary
protected void initialize() Overrides com.badlogic.gdx.scenes.scene2d.ui.TextField.initialize.

letterUnderCursor	back to summary
protected int letterUnderCursor(float x) Overrides com.badlogic.gdx.scenes.scene2d.ui.TextField.letterUnderCursor.

moveCursor	back to summary
protected void moveCursor(boolean forward, boolean jump) Overrides com.badlogic.gdx.scenes.scene2d.ui.TextField.moveCursor.

moveCursorLine	back to summary
public void moveCursorLine(int line) Moves the cursor to the given number line

newLineAtEnd	back to summary
public boolean newLineAtEnd() Returns if there's a new line at then end of the text

setPrefRows	back to summary
public void setPrefRows(float prefRows) Sets the preferred number of rows (lines) for this text area. Used to calculate preferred height

setSelection	back to summary
public void setSelection(int selectionStart, int selectionEnd) Overrides com.badlogic.gdx.scenes.scene2d.ui.TextField.setSelection. Doc from com.badlogic.gdx.scenes.scene2d.ui.TextField.setSelection. Sets the selected text.

setSelection

back to summary

public void setSelection(int selectionStart, int selectionEnd)

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

Doc from com.badlogic.gdx.scenes.scene2d.ui.TextField.setSelection.

Sets the selected text.

setStyle	back to summary
public void setStyle(TextField.TextFieldStyle style) Overrides com.badlogic.gdx.scenes.scene2d.ui.TextField.setStyle. Implements com.badlogic.gdx.scenes.scene2d.ui.Styleable.setStyle. Doc from com.badlogic.gdx.scenes.scene2d.ui.Styleable.setStyle. Set the current style of the actor

setStyle

back to summary

public void setStyle(TextField.TextFieldStyle style)

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

Implements com.badlogic.gdx.scenes.scene2d.ui.Styleable.setStyle.

Doc from com.badlogic.gdx.scenes.scene2d.ui.Styleable.setStyle.

Set the current style of the actor

showCursor	back to summary
pack-priv void showCursor() Scroll the text area to show the line of the cursor

sizeChanged	back to summary
protected void sizeChanged() Overrides com.badlogic.gdx.scenes.scene2d.ui.Widget.sizeChanged. Doc from com.badlogic.gdx.scenes.scene2d.Actor.sizeChanged. Called when the actor's size has been changed.

sizeChanged

back to summary

protected void sizeChanged()

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

Doc from com.badlogic.gdx.scenes.scene2d.Actor.sizeChanged.

Called when the actor's size has been changed.

updateCurrentLine	back to summary
pack-priv void updateCurrentLine() Updates the current line, checking the cursor position in the text

updateFirstLineShowing	back to summary
pack-priv void updateFirstLineShowing()

com.badlogic.gdx.scenes.scene2d.ui back to summary

public Class TextArea.TextAreaListener

Class Inheritance

extends TextFieldClickListener

java.lang.Object
com.badlogic.gdx.scenes.scene2d.InputListener
com.badlogic.gdx.scenes.scene2d.utils.ClickListener
com.badlogic.gdx.scenes.scene2d.ui.TextField.TextFieldClickListener
com.badlogic.gdx.scenes.scene2d.ui.TextArea.TextAreaListener

Input listener for the text area

Constructor Summary

Access	Constructor and Description
public	TextAreaListener()

Method Summary

Modifier and Type	Method and Description
protected boolean	checkFocusTraversal(char character) Overrides com.badlogic.gdx.scenes.scene2d.ui.TextField.TextFieldClickListener.checkFocusTraversal. Checks if focus traversal should be triggered.
protected void	goEnd(boolean jump) Overrides com.badlogic.gdx.scenes.scene2d.ui.TextField.TextFieldClickListener.goEnd.
protected void	goHome(boolean jump) Overrides com.badlogic.gdx.scenes.scene2d.ui.TextField.TextFieldClickListener.goHome.
public boolean	keyDown(InputEvent event, int keycode) Overrides com.badlogic.gdx.scenes.scene2d.ui.TextField.TextFieldClickListener.keyDown. Called when a key goes down.
public boolean	keyTyped(InputEvent event, char character) Overrides com.badlogic.gdx.scenes.scene2d.ui.TextField.TextFieldClickListener.keyTyped. Called when a key is typed.
protected void	setCursorPosition(float x, float y) Overrides com.badlogic.gdx.scenes.scene2d.ui.TextField.TextFieldClickListener.setCursorPosition.

Inherited from com.badlogic.gdx.scenes.scene2d.ui.TextField.TextFieldClickListener:: clicked keyUp scheduleKeyRepeatTask touchDown touchDragged touchUp

Constructor Detail

TextAreaListener	back to summary
public TextAreaListener()

Method Detail

checkFocusTraversal back to summary

checkFocusTraversal	back to summary
protected boolean checkFocusTraversal(char character) Overrides com.badlogic.gdx.scenes.scene2d.ui.TextField.TextFieldClickListener.checkFocusTraversal. Doc from com.badlogic.gdx.scenes.scene2d.ui.TextField.TextFieldClickListener.checkFocusTraversal. Checks if focus traversal should be triggered. The default implementation uses `TextField#focusTraversal` and the typed character, depending on the OS.

protected boolean checkFocusTraversal(char character)

Overrides com.badlogic.gdx.scenes.scene2d.ui.TextField.TextFieldClickListener.checkFocusTraversal.

Doc from com.badlogic.gdx.scenes.scene2d.ui.TextField.TextFieldClickListener.checkFocusTraversal.

Checks if focus traversal should be triggered. The default implementation uses TextField#focusTraversal and the typed character, depending on the OS.

goEnd	back to summary
protected void goEnd(boolean jump) Overrides com.badlogic.gdx.scenes.scene2d.ui.TextField.TextFieldClickListener.goEnd.

goHome	back to summary
protected void goHome(boolean jump) Overrides com.badlogic.gdx.scenes.scene2d.ui.TextField.TextFieldClickListener.goHome.

keyDown back to summary

keyDown	back to summary
public boolean keyDown(InputEvent event, int keycode) Overrides com.badlogic.gdx.scenes.scene2d.ui.TextField.TextFieldClickListener.keyDown. Doc from com.badlogic.gdx.scenes.scene2d.InputListener.keyDown. Called when a key goes down. When true is returned, the event is `handled`.

public boolean keyDown(InputEvent event, int keycode)

Overrides com.badlogic.gdx.scenes.scene2d.ui.TextField.TextFieldClickListener.keyDown.

Doc from com.badlogic.gdx.scenes.scene2d.InputListener.keyDown.

Called when a key goes down. When true is returned, the event is handled.

keyTyped back to summary

keyTyped	back to summary
public boolean keyTyped(InputEvent event, char character) Overrides com.badlogic.gdx.scenes.scene2d.ui.TextField.TextFieldClickListener.keyTyped. Doc from com.badlogic.gdx.scenes.scene2d.InputListener.keyTyped. Called when a key is typed. When true is returned, the event is `handled`.

public boolean keyTyped(InputEvent event, char character)

Overrides com.badlogic.gdx.scenes.scene2d.ui.TextField.TextFieldClickListener.keyTyped.

Doc from com.badlogic.gdx.scenes.scene2d.InputListener.keyTyped.

Called when a key is typed. When true is returned, the event is handled.

setCursorPosition	back to summary
protected void setCursorPosition(float x, float y) Overrides com.badlogic.gdx.scenes.scene2d.ui.TextField.TextFieldClickListener.setCursorPosition.