Package com.badlogic.gdx.scenes.scene2d.ui

Class TextField

java.lang.Object

com.badlogic.gdx.scenes.scene2d.Actor

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

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

All Implemented Interfaces:

Styleable<TextField.TextFieldStyle>, Disableable, Layout

Direct Known Subclasses:

TextArea

public class TextField
extends Widget
implements Disableable, Styleable<TextField.TextFieldStyle>

A single-line text input field.

The preferred height of a text field is the height of the TextField.TextFieldStyle.font and TextField.TextFieldStyle.background. The preferred width of a text field is 150, a relatively arbitrary size.

The text field will copy the currently selected text when ctrl+c is pressed, and paste any text in the clipboard when ctrl+v is pressed. Clipboard functionality is provided via the Clipboard interface. Currently there are two standard implementations, one for the desktop and one for Android. The Android clipboard is a stub, as copy & pasting on Android is not supported yet.

The text field allows you to specify an TextField.OnscreenKeyboard for displaying a softkeyboard and piping all key events generated by the keyboard to the text field. There are two standard implementations, one for the desktop and one for Android. The desktop keyboard is a stub, as a softkeyboard is not needed on the desktop. The Android TextField.OnscreenKeyboard implementation will bring up the default IME.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TextField.DefaultOnscreenKeyboard	The default TextField.OnscreenKeyboard used by all TextField instances.
static interface	TextField.OnscreenKeyboard	An interface for onscreen keyboards.
class	TextField.TextFieldClickListener	Basic input listener for the text field
static interface	TextField.TextFieldFilter	Interface for filtering characters entered into the text field.
static interface	TextField.TextFieldListener	Interface for listening to typed characters.
static class	TextField.TextFieldStyle	The style for a text field, see TextField.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final char	BACKSPACE
protected static final char	BULLET
protected static final char	CARRIAGE_RETURN
protected int	cursor
protected static final char	DELETE
protected CharSequence	displayText
protected float	fontOffset
protected final FloatArray	glyphPositions
protected boolean	hasSelection
static float	keyRepeatInitialTime
static float	keyRepeatTime
protected final GlyphLayout	layout
protected static final char	NEWLINE
protected int	selectionStart
protected static final char	TAB
protected String	text
protected float	textHeight
protected float	textOffset
protected int	visibleTextEnd
protected int	visibleTextStart
protected boolean	writeEnters

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	appendText(String str)
protected void	calculateOffsets()
void	clearSelection()
protected boolean	continueCursor(int index, int offset)
void	copy()	Copies the contents of this TextField to the Clipboard implementation set on this TextField.
protected InputListener	createInputListener()
void	cut()	Copies the selected contents of this TextField to the Clipboard implementation set on this TextField, then removes it.
void	draw(Batch batch, float parentAlpha)	If this method is overridden, the super method or Widget.validate() should be called to ensure the widget is laid out.
protected void	drawBackground(Drawable background, Batch batch, float x, float y, float width, float height)
protected void	drawCursor(Drawable cursorPatch, Batch batch, BitmapFont font, float x, float y)
protected void	drawMessageText(Batch batch, BitmapFont font, float x, float y, float maxWidth)
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	getAlignment()
protected Drawable	getBackgroundDrawable()
int	getCursorPosition()
InputListener	getDefaultInputListener()
boolean	getFocusTraversal()
int	getMaxLength()
String	getMessageText()
TextField.OnscreenKeyboard	getOnscreenKeyboard()	Default is an instance of TextField.DefaultOnscreenKeyboard.
float	getPrefHeight()
float	getPrefWidth()
boolean	getProgrammaticChangeEvents()
String	getSelection()
int	getSelectionStart()
TextField.TextFieldStyle	getStyle()	Returns the text field's style.
String	getText()
TextField.TextFieldFilter	getTextFieldFilter()
protected float	getTextY(BitmapFont font, Drawable background)
protected void	initialize()
boolean	isDisabled()
boolean	isPasswordMode()
protected boolean	isWordCharacter(char c)
protected int	letterUnderCursor(float x)
protected void	moveCursor(boolean forward, boolean jump)
void	next(boolean up)	Sets the keyboard focus to the next TextField.
void	selectAll()
void	setAlignment(int alignment)	Sets text horizontal alignment (left, center or right).
void	setBlinkTime(float blinkTime)
void	setClipboard(Clipboard clipboard)
void	setCursorPosition(int cursorPosition)	Sets the cursor position and clears any selection.
void	setDisabled(boolean disabled)
void	setFocusTraversal(boolean focusTraversal)	If true (the default), tab/shift+tab will move to the next text field.
void	setMaxLength(int maxLength)
void	setMessageText(String messageText)	Sets the text that will be drawn in the text field if no text has been entered.
void	setOnlyFontChars(boolean onlyFontChars)	When false, text set by setText(String) may contain characters not in the font, a space will be displayed instead.
void	setOnscreenKeyboard(TextField.OnscreenKeyboard keyboard)
void	setPasswordCharacter(char passwordCharacter)	Sets the password character for the text field.
void	setPasswordMode(boolean passwordMode)	If true, the text in this text field will be shown as bullet characters.
void	setProgrammaticChangeEvents(boolean programmaticChangeEvents)	If false, methods that change the text will not fire ChangeListener.ChangeEvent, the event will be fired only when the user changes the text.
void	setSelection(int selectionStart, int selectionEnd)	Sets the selected text.
void	setStyle(TextField.TextFieldStyle style)	Set the current style of the actor
void	setText(String str)
void	setTextFieldFilter(TextField.TextFieldFilter filter)
void	setTextFieldListener(TextField.TextFieldListener listener)
protected void	updateDisplayText()
protected int[]	wordUnderCursor(int at)

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

getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, invalidate, invalidateHierarchy, layout, needsLayout, pack, setFillParent, setLayoutEnabled, sizeChanged, 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

Field Details

BACKSPACE

protected static final char BACKSPACE

See Also:

• Constant Field Values

CARRIAGE_RETURN

protected static final char CARRIAGE_RETURN

See Also:

• Constant Field Values

NEWLINE

protected static final char NEWLINE

See Also:

• Constant Field Values

TAB

protected static final char TAB

See Also:

• Constant Field Values

DELETE

protected static final char DELETE

See Also:

• Constant Field Values

BULLET

protected static final char BULLET

See Also:

• Constant Field Values

keyRepeatInitialTime

public static float keyRepeatInitialTime

keyRepeatTime

public static float keyRepeatTime

text

protected String text

cursor

protected int cursor

selectionStart

protected int selectionStart

hasSelection

protected boolean hasSelection

writeEnters

protected boolean writeEnters

layout

protected final GlyphLayout layout

glyphPositions

protected final FloatArray glyphPositions

displayText

protected CharSequence displayText

fontOffset

protected float fontOffset

textHeight

protected float textHeight

textOffset

protected float textOffset

visibleTextStart

protected int visibleTextStart

visibleTextEnd

protected int visibleTextEnd

Constructor Details

TextField

public TextField(@Null
 String text,
 Skin skin)

TextField

public TextField(@Null
 String text,
 Skin skin,
 String styleName)

TextField

public TextField(@Null
 String text,
 TextField.TextFieldStyle style)

Method Details

initialize

protected void initialize()

createInputListener

protected InputListener createInputListener()

letterUnderCursor

protected int letterUnderCursor(float x)

isWordCharacter

protected boolean isWordCharacter(char c)

wordUnderCursor

protected int[] wordUnderCursor(int at)

setMaxLength

public void setMaxLength(int maxLength)

getMaxLength

public int getMaxLength()

setOnlyFontChars

public void setOnlyFontChars(boolean onlyFontChars)

When false, text set by setText(String) may contain characters not in the font, a space will be displayed instead. When true (the default), characters not in the font are stripped by setText. Characters not in the font are always stripped when typed or pasted.

setStyle

public void setStyle(TextField.TextFieldStyle style)

Description copied from interface: Styleable

Set the current style of the actor

Specified by:

setStyle in interface Styleable<TextField.TextFieldStyle>

getStyle

public TextField.TextFieldStyle getStyle()

Returns the text field's style. Modifying the returned style may not have an effect until setStyle(TextFieldStyle) is called.

Specified by:

getStyle in interface Styleable<TextField.TextFieldStyle>

calculateOffsets

protected void calculateOffsets()

getBackgroundDrawable

@Null
protected Drawable getBackgroundDrawable()

draw

public void draw(Batch batch,
 float parentAlpha)

Description copied from class: Widget

If this method is overridden, the super method or Widget.validate() should be called to ensure the widget is laid out.

Overrides:

draw in class Widget

parentAlpha - The parent alpha, to be multiplied with this actor's alpha, allowing the parent's alpha to affect all children.

getTextY

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

drawBackground

protected void drawBackground(Drawable background,
 Batch batch,
 float x,
 float y,
 float width,
 float height)

drawSelection

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

Draws selection rectangle

drawText

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

drawMessageText

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

drawCursor

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

updateDisplayText

protected void updateDisplayText()

copy

public void copy()

Copies the contents of this TextField to the Clipboard implementation set on this TextField.

cut

public void cut()

Copies the selected contents of this TextField to the Clipboard implementation set on this TextField, then removes it.

next

public void next(boolean up)

Sets the keyboard focus to the next TextField. If no next text field is found, the onscreen keyboard is hidden. Does nothing if the text field is not in a stage.

Parameters:

up - If true, the text field with the same or next smallest y coordinate is found, else the next highest.

getDefaultInputListener

public InputListener getDefaultInputListener()

setTextFieldListener

public void setTextFieldListener(@Null
 TextField.TextFieldListener listener)

Parameters:

listener - May be null.

setTextFieldFilter

public void setTextFieldFilter(@Null
 TextField.TextFieldFilter filter)

Parameters:

filter - May be null.

getTextFieldFilter

@Null
public TextField.TextFieldFilter getTextFieldFilter()

setFocusTraversal

public void setFocusTraversal(boolean focusTraversal)

If true (the default), tab/shift+tab will move to the next text field.

getFocusTraversal

public boolean getFocusTraversal()

getMessageText

@Null
public String getMessageText()

Returns:

May be null.

setMessageText

public void setMessageText(@Null
 String messageText)

Sets the text that will be drawn in the text field if no text has been entered.

Parameters:

messageText - may be null.

appendText

public void appendText(@Null
 String str)

Parameters:

str - If null, "" is used.

setText

public void setText(@Null
 String str)

Parameters:

str - If null, "" is used.

getText

public String getText()

Returns:

Never null, might be an empty string.

setProgrammaticChangeEvents

public void setProgrammaticChangeEvents(boolean programmaticChangeEvents)

If false, methods that change the text will not fire ChangeListener.ChangeEvent, the event will be fired only when the user changes the text.

getProgrammaticChangeEvents

public boolean getProgrammaticChangeEvents()

getSelectionStart

public int getSelectionStart()

getSelection

public String getSelection()

setSelection

public void setSelection(int selectionStart,
 int selectionEnd)

Sets the selected text.

selectAll

public void selectAll()

clearSelection

public void clearSelection()

setCursorPosition

public void setCursorPosition(int cursorPosition)

Sets the cursor position and clears any selection.

getCursorPosition

public int getCursorPosition()

getOnscreenKeyboard

public TextField.OnscreenKeyboard getOnscreenKeyboard()

Default is an instance of TextField.DefaultOnscreenKeyboard.

setOnscreenKeyboard

public void setOnscreenKeyboard(TextField.OnscreenKeyboard keyboard)

setClipboard

public void setClipboard(Clipboard clipboard)

getPrefWidth

public float getPrefWidth()

Specified by:

getPrefWidth in interface Layout

Overrides:

getPrefWidth in class Widget

getPrefHeight

public float getPrefHeight()

Specified by:

getPrefHeight in interface Layout

Overrides:

getPrefHeight in class Widget

setAlignment

public void setAlignment(int alignment)

Sets text horizontal alignment (left, center or right).

See Also:

• Align

getAlignment

public int getAlignment()

setPasswordMode

public void setPasswordMode(boolean passwordMode)

If true, the text in this text field will be shown as bullet characters.

See Also:

• setPasswordCharacter(char)

isPasswordMode

public boolean isPasswordMode()

setPasswordCharacter

public void setPasswordCharacter(char passwordCharacter)

Sets the password character for the text field. The character must be present in the BitmapFont. Default is 149 (bullet).

setBlinkTime

public void setBlinkTime(float blinkTime)

setDisabled

public void setDisabled(boolean disabled)

Specified by:

setDisabled in interface Disableable

isDisabled

public boolean isDisabled()

Specified by:

isDisabled in interface Disableable

moveCursor

protected void moveCursor(boolean forward,
 boolean jump)

continueCursor

protected boolean continueCursor(int index,
 int offset)