Text input component that allows a user to enter a single line of unformatted text. Unlike in previous releases of JavaFX, support for multi-line input is not available as part of the TextField control, however this is the sole-purpose of the TextArea control. Additionally, if you want a form of rich-text editing, there is also the HTMLEditor control.

TextField supports the notion of showing prompt text to the user when there is no text already in the TextField (either via the user, or set programmatically). This is a useful way of informing the user as to what is expected in the text field, without having to resort to tooltips or on-screen labels.

Example:

 var textField = new TextField("Hello World!");

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	TextField.StyleableProperties
private static class	TextField.TextFieldContent

Field Summary

Modifier and Type	Field and Description
private ObjectProperty<Pos>	alignment
public static final int	DEFAULT_PREF_COLUMN_COUNT The default value for `prefColumnCount`.
private ObjectProperty<EventHandler<ActionEvent>>	onAction The action handler associated with this text field, or `null` if no action handler is assigned.
private IntegerProperty	prefColumnCount The preferred number of text columns.

Access	Constructor and Description
public	TextField() Creates a `TextField` with empty text content.
public	TextField(String A string for text content. text) Creates a `TextField` with initial text content.

Modifier and Type	Method and Description
public final ObjectProperty<Pos>	Returns: the alignment property alignmentProperty() Specifies how the text should be aligned when there is empty space within the TextField.
protected Skin<?>	createDefaultSkin() Overrides javafx.scene.control.Control.createDefaultSkin. Create a new instance of the default skin for this control.
pack-priv String	filterInput(String text) Overrides javafx.scene.control.TextInputControl.filterInput.
public final Pos	getAlignment()
public CharSequence	Returns: the character sequence backing the text field's content getCharacters() Returns the character sequence backing the text field's content.
public static List<CssMetaData<? extends Styleable, ?>>	Returns: the `CssMetaData` getClassCssMetaData() Hides javafx.scene.control.TextInputControl.getClassCssMetaData. Gets the `CssMetaData` associated with this class, which may include the `CssMetaData` of its superclasses.
public List<CssMetaData<? extends Styleable, ?>>	getControlCssMetaData() Overrides javafx.scene.control.TextInputControl.getControlCssMetaData. Gets the unmodifiable list of the control's CSS-styleable properties.
public final EventHandler<ActionEvent>	getOnAction()
public final int	getPrefColumnCount()
public final ObjectProperty<EventHandler<ActionEvent>>	onActionProperty()
public final IntegerProperty	prefColumnCountProperty()
public final void	setAlignment(Pos value)
public final void	setOnAction(EventHandler<ActionEvent> value)
public final void	setPrefColumnCount(int value)

Field Detail

alignment	back to summary
private ObjectProperty<Pos> alignment

DEFAULT_PREF_COLUMN_COUNT	back to summary
public static final int DEFAULT_PREF_COLUMN_COUNT The default value for `prefColumnCount`.

onAction	back to summary
private ObjectProperty<EventHandler<ActionEvent>> onAction The action handler associated with this text field, or `null` if no action handler is assigned. The action handler is normally called when the user types the ENTER key.

prefColumnCount	back to summary
private IntegerProperty prefColumnCount The preferred number of text columns. This is used for calculating the `TextField`'s preferred width.

TextField	back to summary
public TextField() Creates a `TextField` with empty text content.

TextField	back to summary
public TextField(String text) Creates a `TextField` with initial text content. Parameters text:String A string for text content.

Method Detail

alignmentProperty	back to summary
public final ObjectProperty<Pos> alignmentProperty() Specifies how the text should be aligned when there is empty space within the TextField. Returns:ObjectProperty<Pos> the alignment property Since JavaFX 2.1

alignmentProperty

back to summary

public final ObjectProperty<Pos> alignmentProperty()

Specifies how the text should be aligned when there is empty space within the TextField.

Returns:ObjectProperty<Pos>: the alignment property
Since: JavaFX 2.1

createDefaultSkin back to summary

createDefaultSkin	back to summary
protected Skin<?> createDefaultSkin() Overrides javafx.scene.control.Control.createDefaultSkin. Doc from javafx.scene.control.Control.createDefaultSkin. Create a new instance of the default skin for this control. This is called to create a skin for the control if no skin is provided via CSS `-fx-skin` or set explicitly in a sub-class with `setSkin(...)`. Returns:Skin<?> new instance of default skin for this control. If null then the control will have no skin unless one is provided by css. Annotations @Override

protected Skin<?> createDefaultSkin()

Overrides javafx.scene.control.Control.createDefaultSkin.

Doc from javafx.scene.control.Control.createDefaultSkin.

Create a new instance of the default skin for this control. This is called to create a skin for the control if no skin is provided via CSS -fx-skin or set explicitly in a sub-class with setSkin(...).

Returns:Skin<?>

new instance of default skin for this control. If null then the control will have no skin unless one is provided by css.

Annotations

@Override

filterInput	back to summary
pack-priv String filterInput(String text) Overrides javafx.scene.control.TextInputControl.filterInput. Annotations @Override

filterInput

back to summary

pack-priv String filterInput(String text)

Overrides javafx.scene.control.TextInputControl.filterInput.

Annotations

@Override

getAlignment	back to summary
public final Pos getAlignment()

getCharacters	back to summary
public CharSequence getCharacters() Returns the character sequence backing the text field's content. Returns:CharSequence the character sequence backing the text field's content

getCharacters

back to summary

public CharSequence getCharacters()

Returns the character sequence backing the text field's content.

Returns:CharSequence: the character sequence backing the text field's content

getClassCssMetaData back to summary

public static List<CssMetaData<? extends Styleable, ?>> getClassCssMetaData()

Hides javafx.scene.control.TextInputControl.getClassCssMetaData.

Gets the CssMetaData associated with this class, which may include the CssMetaData of its superclasses.

Returns:List<CssMetaData<? extends Styleable, ?>>: the CssMetaData
Since: JavaFX 8.0

getControlCssMetaData

back to summary

public List<CssMetaData<? extends Styleable, ?>> getControlCssMetaData()

Overrides javafx.scene.control.TextInputControl.getControlCssMetaData.

Doc from javafx.scene.control.TextInputControl.getControlCssMetaData.

Gets the unmodifiable list of the control's CSS-styleable properties.

Returns:List<CssMetaData<? extends Styleable, ?>>

Doc from javafx.scene.control.Control.getControlCssMetaData.

the unmodifiable list of the control's CSS-styleable properties

Annotations

@Override

Since

JavaFX 8.0

getOnAction	back to summary
public final EventHandler<ActionEvent> getOnAction()

getPrefColumnCount	back to summary
public final int getPrefColumnCount()

onActionProperty	back to summary
public final ObjectProperty<EventHandler<ActionEvent>> onActionProperty()

prefColumnCountProperty	back to summary
public final IntegerProperty prefColumnCountProperty()

setAlignment	back to summary
public final void setAlignment(Pos value)

setOnAction	back to summary
public final void setOnAction(EventHandler<ActionEvent> value)

setPrefColumnCount	back to summary
public final void setPrefColumnCount(int value)

javafx.scene.control back to summary

private Class TextField.StyleableProperties

Class Inheritance

extends Object

java.lang.Object
javafx.scene.control.TextField.StyleableProperties

Field Summary

Modifier and Type	Field and Description
private static final CssMetaData<TextField, Pos>	ALIGNMENT
private static final CssMetaData<TextField, Number>	PREF_COLUMN_COUNT
private static final List<CssMetaData<? extends Styleable, ?>>	STYLEABLES

Constructor Summary

Access	Constructor and Description
private	StyleableProperties()

Method Summary

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

ALIGNMENT	back to summary
private static final CssMetaData<TextField, Pos> ALIGNMENT

PREF_COLUMN_COUNT	back to summary
private static final CssMetaData<TextField, Number> PREF_COLUMN_COUNT

STYLEABLES	back to summary
private static final List<CssMetaData<? extends Styleable, ?>> STYLEABLES

Constructor Detail

StyleableProperties	back to summary
private StyleableProperties()

javafx.scene.control back to summary

private final Class TextField.TextFieldContent

Class Inheritance

extends ContentBase

java.lang.Object
javafx.scene.control.TextInputControl.ContentBase
javafx.scene.control.TextField.TextFieldContent

Field Summary

Modifier and Type	Field and Description
private StringBuilder	characters

Constructor Summary

Access	Constructor and Description
private	TextFieldContent()

Method Summary

Modifier and Type	Method and Description
public void	delete(int the start start, int the end end, boolean the notify listener flag notifyListeners) Implements javafx.scene.control.TextInputControl.Content.delete. Removes a sequence of characters from the content.
public String	get(int the start start, int the end end) Implements javafx.scene.control.TextInputControl.Content.get. Retrieves a subset of the content.
public String	get() Implements javafx.beans.value.ObservableObjectValue.get. Returns the current value of this `ObservableObjectValue<T>`.
public String	getValue() Implements javafx.beans.value.ObservableValue.getValue. Returns the current value of this `ObservableValue`
public void	insert(int the index index, String the text string text, boolean the notify listener flag notifyListeners) Implements javafx.scene.control.TextInputControl.Content.insert. Inserts a sequence of characters into the content.
public int	length() Implements javafx.scene.control.TextInputControl.Content.length. Returns the number of characters represented by the content.

Inherited from javafx.scene.control.TextInputControl.ContentBase:: addListener addListener fireValueChangedEvent removeListener removeListener

Field Detail

characters	back to summary
private StringBuilder characters

Constructor Detail

TextFieldContent	back to summary
private TextFieldContent()

Method Detail

delete	back to summary
public void delete(int start, int end, boolean notifyListeners) Implements javafx.scene.control.TextInputControl.Content.delete. Doc from javafx.scene.control.TextInputControl.Content.delete. Removes a sequence of characters from the content. Parameters start:int the start end:int the end notifyListeners:boolean the notify listener flag Annotations @Override

delete

back to summary

public void delete(int start, int end, boolean notifyListeners)

Implements javafx.scene.control.TextInputControl.Content.delete.

Doc from javafx.scene.control.TextInputControl.Content.delete.

Removes a sequence of characters from the content.

Parameters

start:int: the start
end:int: the end
notifyListeners:boolean: the notify listener flag

Annotations

@Override

get	back to summary
public String get(int start, int end) Implements javafx.scene.control.TextInputControl.Content.get. Doc from javafx.scene.control.TextInputControl.Content.get. Retrieves a subset of the content. Parameters start:int the start end:int the end Returns:String a subset of the content Annotations @Override

get

back to summary

public String get(int start, int end)

Implements javafx.scene.control.TextInputControl.Content.get.

Doc from javafx.scene.control.TextInputControl.Content.get.

Retrieves a subset of the content.

Parameters

start:int: the start
end:int: the end

Returns:String

a subset of the content

Annotations

@Override

get back to summary

get	back to summary
public String get() Implements javafx.beans.value.ObservableObjectValue.get. Doc from javafx.beans.value.ObservableObjectValue.get. Returns the current value of this `ObservableObjectValue<T>`. Returns:String The current value Annotations @Override

public String get()

Implements javafx.beans.value.ObservableObjectValue.get.

Doc from javafx.beans.value.ObservableObjectValue.get.

Returns the current value of this ObservableObjectValue<T>.

Returns:String

The current value

Annotations

@Override

getValue back to summary

getValue	back to summary
public String getValue() Implements javafx.beans.value.ObservableValue.getValue. Doc from javafx.beans.value.ObservableValue.getValue. Returns the current value of this `ObservableValue` Returns:String The current value Annotations @Override

public String getValue()

Implements javafx.beans.value.ObservableValue.getValue.

Doc from javafx.beans.value.ObservableValue.getValue.

Returns the current value of this ObservableValue

Returns:String

The current value

Annotations

@Override

insert	back to summary
public void insert(int index, String text, boolean notifyListeners) Implements javafx.scene.control.TextInputControl.Content.insert. Doc from javafx.scene.control.TextInputControl.Content.insert. Inserts a sequence of characters into the content. Parameters index:int the index text:String the text string notifyListeners:boolean the notify listener flag Annotations @Override

insert

back to summary

public void insert(int index, String text, boolean notifyListeners)

Implements javafx.scene.control.TextInputControl.Content.insert.

Doc from javafx.scene.control.TextInputControl.Content.insert.

Inserts a sequence of characters into the content.

Parameters

index:int: the index
text:String: the text string
notifyListeners:boolean: the notify listener flag

Annotations

@Override

length	back to summary
public int length() Implements javafx.scene.control.TextInputControl.Content.length. Doc from javafx.scene.control.TextInputControl.Content.length. Returns the number of characters represented by the content. Returns:int the number of characters Annotations @Override

length

back to summary

public int length()

Implements javafx.scene.control.TextInputControl.Content.length.

Doc from javafx.scene.control.TextInputControl.Content.length.

Returns the number of characters represented by the content.

Returns:int

the number of characters

Annotations

@Override

public Class TextField

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class TextField.StyleableProperties

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

private final Class TextField.TextFieldContent

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail