|
libgdx API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.badlogic.gdx.scenes.scene2d.Actor
com.badlogic.gdx.scenes.scene2d.ui.Widget
com.badlogic.gdx.scenes.scene2d.ui.TextField
public class TextField
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 | |
---|---|
static class |
TextField.DefaultOnscreenKeyboard
The default TextField.OnscreenKeyboard used by all TextField instances. |
static interface |
TextField.OnscreenKeyboard
An interface for onscreen keyboards. |
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 inherited from class com.badlogic.gdx.scenes.scene2d.Actor |
---|
actions, color, height, name, originX, originY, parent, rotation, scaleX, scaleY, stage, touchable, visible, width, x, y |
Constructor Summary | |
---|---|
TextField(Skin skin)
|
|
TextField(java.lang.String text,
Skin skin)
|
|
TextField(java.lang.String text,
java.lang.String messageText,
Skin skin)
|
|
TextField(java.lang.String text,
java.lang.String messageText,
TextField.TextFieldStyle style)
|
|
TextField(java.lang.String text,
java.lang.String messageText,
TextField.TextFieldStyle style,
java.lang.String name)
|
|
TextField(java.lang.String text,
TextField.TextFieldStyle style)
|
|
TextField(TextField.TextFieldStyle style)
|
Method Summary | |
---|---|
void |
clearSelection()
|
void |
draw(SpriteBatch batch,
float parentAlpha)
If this method is overridden, the super method or Widget.validate() should be called to ensure the widget is laid out. |
int |
getCursorPosition()
|
java.lang.String |
getMessageText()
|
TextField.OnscreenKeyboard |
getOnscreenKeyboard()
Default is an instance of TextField.DefaultOnscreenKeyboard . |
float |
getPrefHeight()
|
float |
getPrefWidth()
|
TextField.TextFieldStyle |
getStyle()
Returns the text field's style. |
java.lang.String |
getText()
|
boolean |
keyDown(int keycode)
|
boolean |
keyTyped(char character)
|
void |
layout()
Computes and caches any information needed for drawing and, if this actor has children, positions and sizes each child and calls Layout.invalidate() and then Layout.validate() on each one. |
void |
next(boolean up)
Focuses the next TextField. |
void |
setClipboard(Clipboard clipboard)
|
void |
setCursorPosition(int cursorPosition)
Sets the cursor position and clears any selection. |
void |
setMessageText(java.lang.String messageText)
Sets the text that will be drawn in the text field if no text has been entered. |
void |
setOnscreenKeyboard(TextField.OnscreenKeyboard keyboard)
|
void |
setPasswordCharacter(char passwordCharacter)
|
void |
setPasswordMode(boolean passwordMode)
If true, the text in this text field will be shown as bullet characters. |
void |
setSelection(int selectionStart,
int selectionEnd)
Sets the selected text. |
void |
setStyle(TextField.TextFieldStyle style)
|
void |
setText(java.lang.String text)
|
void |
setTextFieldFilter(TextField.TextFieldFilter filter)
|
void |
setTextFieldListener(TextField.TextFieldListener listener)
|
boolean |
touchDown(float x,
float y,
int pointer)
|
Methods inherited from class com.badlogic.gdx.scenes.scene2d.ui.Widget |
---|
getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, hit, invalidate, invalidateHierarchy, needsLayout, pack, setFillParent, toScreenCoordinates, touchDragged, touchUp, validate |
Methods inherited from class com.badlogic.gdx.scenes.scene2d.Actor |
---|
act, action, clearActions, getStage, isMarkedToRemove, keyUp, markToRemove, remove, scrolled, toLocalCoordinates, toString, touchMoved |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public TextField(Skin skin)
public TextField(java.lang.String text, Skin skin)
public TextField(java.lang.String text, java.lang.String messageText, Skin skin)
messageText
- Text to show when empty. May be null.public TextField(TextField.TextFieldStyle style)
public TextField(java.lang.String text, TextField.TextFieldStyle style)
public TextField(java.lang.String text, java.lang.String messageText, TextField.TextFieldStyle style)
messageText
- Text to show when empty. May be null.public TextField(java.lang.String text, java.lang.String messageText, TextField.TextFieldStyle style, java.lang.String name)
messageText
- Text to show when empty. May be null.Method Detail |
---|
public void setStyle(TextField.TextFieldStyle style)
public void setPasswordCharacter(char passwordCharacter)
public TextField.TextFieldStyle getStyle()
setStyle(TextFieldStyle)
is called.
public void layout()
Layout
Layout.invalidate()
and then Layout.validate()
on each one. Usually this should not be called directly, instead
Layout.validate()
should be used.
layout
in interface Layout
layout
in class Widget
public void draw(SpriteBatch batch, float parentAlpha)
Widget
Widget.validate()
should be called to ensure the widget is laid out.
draw
in class Widget
batch
- the spritebatch to render withparentAlpha
- the parent's alpha value.public boolean touchDown(float x, float y, int pointer)
touchDown
in class Widget
public boolean keyDown(int keycode)
keyDown
in class Actor
public boolean keyTyped(char character)
keyTyped
in class Actor
public void next(boolean up)
up
- If true, the TextField with the same or next smallest y coordinate is found, else the next highest.public void setTextFieldListener(TextField.TextFieldListener listener)
listener
- May be null.public void setTextFieldFilter(TextField.TextFieldFilter filter)
filter
- May be null.public java.lang.String getMessageText()
public void setMessageText(java.lang.String messageText)
public void setText(java.lang.String text)
public java.lang.String getText()
public void setSelection(int selectionStart, int selectionEnd)
public void clearSelection()
public void setCursorPosition(int cursorPosition)
public int getCursorPosition()
public TextField.OnscreenKeyboard getOnscreenKeyboard()
TextField.DefaultOnscreenKeyboard
.
public void setOnscreenKeyboard(TextField.OnscreenKeyboard keyboard)
public void setClipboard(Clipboard clipboard)
public float getPrefWidth()
getPrefWidth
in interface Layout
getPrefWidth
in class Widget
public float getPrefHeight()
getPrefHeight
in interface Layout
getPrefHeight
in class Widget
public void setPasswordMode(boolean passwordMode)
|
libgdx API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |