libGDX 1.14.2 · com.badlogic.gdx.scenes.scene2d.ui.TextField

Modifier and Type	Class and Description
public static class	TextField.DefaultOnscreenKeyboard The default `OnscreenKeyboard` used by all `TextField` instances.
pack-priv class	TextField.KeyRepeatTask
public static class	TextField.NativeOnscreenKeyboard An advanced `OnscreenKeyboard` utilising `Input#openTextInputField`.
public static interface	TextField.OnscreenKeyboard An interface for onscreen keyboards.
public class	TextField.TextFieldClickListener Basic input listener for the text field
public static interface	TextField.TextFieldFilter Interface for filtering characters entered into the text field.
public static interface	TextField.TextFieldListener Interface for listening to typed characters.
public static class	TextField.TextFieldStyle The style for a text field, see `TextField`.
pack-priv static class	TextField.Undo
pack-priv static class	TextField.UndoState

Field Summary

Modifier and Type	Field and Description
private String[]	autocompleteOptions
protected static final char	BACKSPACE
pack-priv final Timer.Task	blinkTask
pack-priv float	blinkTime
protected static final char	BULLET This is the default char used in password fields, a Unicode bullet at code point 0x2022.
protected static final char	CARRIAGE_RETURN
pack-priv Clipboard	clipboard
protected int	cursor
pack-priv boolean	cursorOn
public static TextField.OnscreenKeyboard	DEFAULT_ONSCREEN_KEYBOARD
protected static final char	DELETE
pack-priv boolean	disabled
protected CharSequence	displayText
pack-priv TextField.TextFieldFilter	filter
pack-priv boolean	focused
pack-priv boolean	focusTraversal
protected float	fontOffset
protected final FloatArray	glyphPositions
protected boolean	hasSelection
pack-priv InputListener	inputListener
pack-priv TextField.OnscreenKeyboard	keyboard
private Input.OnscreenKeyboardType	keyboardType
public static float	keyRepeatInitialTime
pack-priv final TextField.KeyRepeatTask	keyRepeatTask
public static float	keyRepeatTime
protected final GlyphLayout	layout
pack-priv TextField.TextFieldListener	listener
private int	maxLength
private String	messageText
protected static final char	NEWLINE
pack-priv boolean	onlyFontChars
private StringBuilder	passwordBuffer
private char	passwordCharacter
pack-priv boolean	passwordMode
private boolean	preventAutoCorrection
pack-priv boolean	programmaticChangeEvents
pack-priv float	renderOffset
protected int	selectionStart
private float	selectionWidth
private float	selectionX
pack-priv TextField.TextFieldStyle	style
protected static final char	TAB
protected String	text
private int	textHAlign
protected float	textHeight
protected float	textOffset
private static final Vector2	tmp1
private static final Vector2	tmp2
private static final Vector2	tmp3
private final TextField.Undo	undo
public static int	undoMax
protected int	visibleTextEnd
protected int	visibleTextStart
protected boolean	writeEnters

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

Method Summary

Modifier and Type	Method and Description
public void	appendText(String If null, "" is used. str)
protected void	calculateOffsets()
pack-priv boolean	changeText(String oldText, String newText) Returns: True if the text was changed.
public void	clearSelection()
protected boolean	continueCursor(int index, int offset)
public void	copy() Copies the contents of this TextField to the `Clipboard` implementation set on this TextField.
protected InputListener	createInputListener()
public void	cut() Copies the selected contents of this TextField to the `Clipboard` implementation set on this TextField, then removes it.
pack-priv void	cut(boolean fireChangeEvent)
pack-priv int	delete(boolean fireChangeEvent)
public void	draw(Batch batch, float parentAlpha) Overrides com.badlogic.gdx.scenes.scene2d.ui.Widget.draw. If this method is overridden, the super method or `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)
private TextField	findNextTextField(Array<Actor> actors, TextField best, Vector2 bestCoords, Vector2 currentCoords, boolean up) Returns: May be null.
public int	getAlignment()
protected Drawable	getBackgroundDrawable()
public int	getCursorPosition()
public InputListener	getDefaultInputListener()
public boolean	getFocusTraversal()
public int	getMaxLength()
public String	getMessageText() Returns: May be null.
public TextField.OnscreenKeyboard	getOnscreenKeyboard() Default is an instance of `DefaultOnscreenKeyboard`.
public float	getPrefHeight() Overrides com.badlogic.gdx.scenes.scene2d.ui.Widget.getPrefHeight. Implements com.badlogic.gdx.scenes.scene2d.utils.Layout.getPrefHeight.
public float	getPrefWidth() Overrides com.badlogic.gdx.scenes.scene2d.ui.Widget.getPrefWidth. Implements com.badlogic.gdx.scenes.scene2d.utils.Layout.getPrefWidth.
public boolean	getProgrammaticChangeEvents()
public String	getSelection()
public int	getSelectionStart()
public TextField.TextFieldStyle	getStyle() Implements com.badlogic.gdx.scenes.scene2d.ui.Styleable.getStyle. Returns the text field's style.
public String	getText() Returns: Never null, might be an empty string.
public TextField.TextFieldFilter	getTextFieldFilter()
protected float	getTextY(BitmapFont font, Drawable background)
protected void	initialize()
pack-priv String	insert(int position, CharSequence text, String to)
public boolean	isDisabled() Implements com.badlogic.gdx.scenes.scene2d.utils.Disableable.isDisabled.
public boolean	isPasswordMode()
protected boolean	isWordCharacter(char c)
protected int	letterUnderCursor(float x)
protected void	moveCursor(boolean forward, boolean jump)
public TextField	Returns: The textfield, the focus has been transferred too next(boolean If true, the text field with the same or next smallest y coordinate is found, else the next highest. up) Sets the `keyboard focus` to the next TextField.
pack-priv void	paste(String content, boolean fireChangeEvent)
public void	redo() Restores the next text and selection history state.
pack-priv void	redo(boolean fireChangeEvent)
public void	selectAll()
public void	setAlignment(int alignment) Sets text horizontal alignment (left, center or right).
public void	setAutocompleteOptions(String[] autocompleteOptions) A list of possible strings that are valid to autocomplete Currently only has an effect on mobile with `NativeOnscreenKeyboard`
public void	setBlinkTime(float blinkTime)
public void	setClipboard(Clipboard clipboard)
public void	setCursorPosition(int cursorPosition) Sets the cursor position and clears any selection.
public void	setDisabled(boolean disabled) Implements com.badlogic.gdx.scenes.scene2d.utils.Disableable.setDisabled.
public void	setFocusTraversal(boolean focusTraversal) If true (the default), tab/shift+tab will move to the next text field.
public void	setKeyboardType(Input.OnscreenKeyboardType keyboardType) Which `OnscreenKeyboardType` to use.
public void	setMaxLength(int maxLength)
public void	setMessageText(String may be null. messageText) Sets the text that will be drawn in the text field if no text has been entered.
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.
public void	setOnscreenKeyboard(TextField.OnscreenKeyboard keyboard)
public void	setPasswordCharacter(char passwordCharacter) Sets the password character for the text field.
public void	setPasswordMode(boolean passwordMode) If true, the text in this text field will be shown as bullet characters.
public void	setPreventAutoCorrection(boolean preventAutoCorrection) Whether if auto correction is provided by the system, it should be surpressed Will be considered true, if `OnscreenKeyboardType` is `Password`
public void	setProgrammaticChangeEvents(boolean programmaticChangeEvents) If false, methods that change the text will not fire `ChangeEvent`, the event will be fired only when the user changes the text.
public void	setSelection(int selectionStart, int selectionEnd) Sets the selected text.
public void	setStyle(TextField.TextFieldStyle style) Implements com.badlogic.gdx.scenes.scene2d.ui.Styleable.setStyle. Set the current style of the actor
public void	setText(String If null, "" is used. str)
public void	setTextFieldFilter(TextField.TextFieldFilter May be null. filter)
public void	setTextFieldListener(TextField.TextFieldListener May be null. listener)
public void	undo() Restores the previous text and selection history state.
pack-priv void	undo(boolean fireChangeEvent)
protected void	updateDisplayText()
pack-priv boolean	withinMaxLength(int size)
protected int[]	wordUnderCursor(int at)
pack-priv int[]	wordUnderCursor(float x)

Inherited from com.badlogic.gdx.scenes.scene2d.ui.Widget:: getMaxHeight getMaxWidth getMinHeight getMinWidth invalidate invalidateHierarchy layout needsLayout pack setFillParent setLayoutEnabled sizeChanged validate

public Class TextField

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary