TextInputControl

java.lang.Object
- Region
- - javafx.scene.control.Control
  - - javafx.scene.control.TextInputControl

All Implemented Interfaces:

Skinnable

Direct Known Subclasses:

TextArea, TextField
```
public abstract class TextInputControl
extends Control
```
Abstract base class for text input controls.

Since:

JavaFX 2.0

Property Summary

All Methods Instance Methods Concrete Methods
Type	Property and Description
`ReadOnlyIntegerProperty`	`anchor` The `anchor` of the text selection.
`ReadOnlyIntegerProperty`	`caretPosition` The current position of the caret within the text.
`BooleanProperty`	`editable` Indicates whether this TextInputControl can be edited by the user.
`<any>`	`font` The default font to use for text in the TextInputControl.
`ReadOnlyIntegerProperty`	`length` The number of characters in the text input.
`StringProperty`	`promptText` The prompt text to display in the `TextInputControl`.
`ReadOnlyBooleanProperty`	`redoable` The property describes if it's currently possible to redo the latest change of the content that was undone.
`ReadOnlyStringProperty`	`selectedText` Defines the characters in the TextInputControl which are selected
`<any>`	`selection` The current selection.
`<any>`	`textFormatter` The property contains currently attached `TextFormatter`.
`StringProperty`	`text` The textual content of this TextInputControl.
`ReadOnlyBooleanProperty`	`undoable` The property describes if it's currently possible to undo the latest change of the content that was done.

Properties inherited from class javafx.scene.control.Control
contextMenuProperty, skinClassNameProperty, skinProperty, tooltipProperty

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected static interface`	`TextInputControl.Content` Interface representing a text input's content.
`private static class`	`TextInputControl.StyleableProperties`
`private class`	`TextInputControl.TextInputControlFromatterAccessor`
`private class`	`TextInputControl.TextProperty`
`(package private) static class`	`TextInputControl.UndoRedoChange` Used to form a linked-list of Undo / Redo changes.

Field Summary

Fields
Modifier and Type	Field and Description
`private FormatterAccessor`	`accessor`
`private ReadOnlyIntegerWrapper`	`anchor` The `anchor` of the text selection.
`private ReadOnlyIntegerWrapper`	`caretPosition` The current position of the caret within the text.
`private java.text.BreakIterator`	`charIterator` The break iterator instances for navigation over words and complex characters.
`private TextInputControl.Content`	`content`
`private boolean`	`createNewUndoRecord`
`private BooleanProperty`	`editable` Indicates whether this TextInputControl can be edited by the user.
`private <any>`	`font`
`private ReadOnlyIntegerWrapper`	`length` The number of characters in the text input.
`private StringProperty`	`promptText` The prompt text to display in the `TextInputControl`.
`private static PseudoClass`	`PSEUDO_CLASS_READONLY` * Stylesheet Handling * *
`private ReadOnlyBooleanWrapper`	`redoable` The property describes if it's currently possible to redo the latest change of the content that was undone.
`private ReadOnlyStringWrapper`	`selectedText` Defines the characters in the TextInputControl which are selected
`private <any>`	`selection` The current selection.
`private TextInputControl.TextProperty`	`text` The textual content of this TextInputControl.
`private <any>`	`textFormatter` The property contains currently attached `TextFormatter`.
`private ReadOnlyBooleanWrapper`	`undoable` The property describes if it's currently possible to undo the latest change of the content that was done.
`private TextInputControl.UndoRedoChange`	`undoChange`
`private TextInputControl.UndoRedoChange`	`undoChangeHead`
`private java.text.BreakIterator`	`wordIterator`

Constructor Summary

Constructors
Modifier Constructor and Description

protected TextInputControl(TextInputControl.Content content)
Creates a new TextInputControl.

Constructors
Modifier	Constructor and Description
`protected`	`TextInputControl(TextInputControl.Content content)` Creates a new TextInputControl.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ReadOnlyIntegerProperty`	`anchorProperty()` The `anchor` of the text selection.
`void`	`appendText(java.lang.String text)` Appends a sequence of characters to the content.
`void`	`backward()` Moves the caret position backward.
`void`	`cancelEdit()` If the field is currently being edited, this call will set text to the last commited value.
`ReadOnlyIntegerProperty`	`caretPositionProperty()` The current position of the caret within the text.
`void`	`clear()` Clears the text.
`void`	`commitValue()` Commit the current text and convert it to a value.
`(package private) static boolean`	`containsInvalidCharacters(java.lang.String txt, boolean newlineIllegal, boolean tabIllegal)`
`void`	`copy()` Transfers the currently selected range in the text to the clipboard, leaving the current selection.
`void`	`cut()` Transfers the currently selected range in the text to the clipboard, removing the current selection.
`boolean`	`deleteNextChar()` Deletes the character that follows the current caret position from the text if there is no selection, or deletes the selection if there is one.
`boolean`	`deletePreviousChar()` Deletes the character that precedes the current caret position from the text if there is no selection, or deletes the selection if there is one.
`void`	`deleteText(IndexRange range)` Removes a range of characters from the content.
`void`	`deleteText(int start, int end)` Removes a range of characters from the content.
`void`	`deselect()` Clears the selection.
`private void`	`doSelectRange(int anchor, int caretPosition)`
`BooleanProperty`	`editableProperty()` Indicates whether this TextInputControl can be edited by the user.
`void`	`end()` Moves the caret to after the last char of the text.
`void`	`endOfNextWord()` Moves the caret to the end of the next word.
`private void`	`endOfNextWord(boolean select)`
`void`	`executeAccessibleAction(AccessibleAction action, java.lang.Object... parameters)`
`void`	`extendSelection(int pos)` This function will extend the selection to include the specified pos.
`private boolean`	`filterAndSet(java.lang.String value)`
`(package private) static java.lang.String`	`filterInput(java.lang.String txt, boolean stripNewlines, boolean stripTabs)` A little utility method for stripping out unwanted characters.
`<any>`	`fontProperty()` The default font to use for text in the TextInputControl.
`void`	`forward()` Moves the caret position forward.
`int`	`getAnchor()` Gets the value of the property anchor.
`int`	`getCaretPosition()` Gets the value of the property caretPosition.
`static java.util.List<<any>>`	`getClassCssMetaData()`
`protected TextInputControl.Content`	`getContent()` Returns the text input's content model.
`java.util.List<<any>>`	`getControlCssMetaData()`
`Font`	`getFont()` Gets the value of the property font.
`private FormatterAccessor`	`getFormatterAccessor()`
`int`	`getLength()` Gets the value of the property length.
`java.lang.String`	`getPromptText()` Gets the value of the property promptText.
`java.lang.String`	`getSelectedText()` Gets the value of the property selectedText.
`IndexRange`	`getSelection()` Gets the value of the property selection.
`java.lang.String`	`getText()` Gets the value of the property text.
`java.lang.String`	`getText(int start, int end)` Returns a subset of the text input's content.
`TextFormatter<?>`	`getTextFormatter()` Gets the value of the property textFormatter.
`void`	`home()` Moves the caret to before the first char of the text.
`void`	`insertText(int index, java.lang.String text)` Inserts a sequence of characters into the content.
`boolean`	`isEditable()` Gets the value of the property editable.
`private static boolean`	`isInvalidCharacter(char c, boolean newlineIllegal, boolean tabIllegal)`
`boolean`	`isRedoable()` Gets the value of the property redoable.
`boolean`	`isUndoable()` Gets the value of the property undoable.
`ReadOnlyIntegerProperty`	`lengthProperty()` The number of characters in the text input.
`void`	`nextWord()` Moves the caret to the beginning of next word.
`private void`	`nextWord(boolean select)`
`void`	`paste()` Transfers the contents in the clipboard into this text, replacing the current selection.
`void`	`positionCaret(int pos)` Positions the caret to the position indicated by `pos`.
`void`	`previousWord()` Moves the caret to the beginning of previous word.
`private void`	`previousWord(boolean select)`
`StringProperty`	`promptTextProperty()` The prompt text to display in the `TextInputControl`.
`java.lang.Object`	`queryAccessibleAttribute(AccessibleAttribute attribute, java.lang.Object... parameters)`
`void`	`redo()` If possible, redoes the last undone modification.
`ReadOnlyBooleanProperty`	`redoableProperty()` The property describes if it's currently possible to redo the latest change of the content that was undone.
`void`	`replaceSelection(java.lang.String replacement)` Replaces the selection with the given replacement String.
`void`	`replaceText(IndexRange range, java.lang.String text)` Replaces a range of characters with the given text.
`void`	`replaceText(int start, int end, java.lang.String text)` Replaces a range of characters with the given text.
`private int`	`replaceText(int start, int end, java.lang.String value, int anchor, int caretPosition)` This is what is ultimately called by every code path that will update the content (except for undo / redo).
`private void`	`resetUndoRedoState()`
`void`	`selectAll()` Selects all text in the text input.
`void`	`selectBackward()` Moves the selection backward one char in the text.
`ReadOnlyStringProperty`	`selectedTextProperty()` Defines the characters in the TextInputControl which are selected
`void`	`selectEnd()` Moves the caret to after the last char of text.
`void`	`selectEndOfNextWord()` Moves the caret to the end of the next word.
`void`	`selectForward()` Moves the selection forward one char in the text.
`void`	`selectHome()` Moves the caret to before the first char of text.
`<any>`	`selectionProperty()` The current selection.
`void`	`selectNextWord()` Moves the caret to the beginning of next word.
`void`	`selectPositionCaret(int pos)` Positions the caret to the position indicated by `pos` and extends the selection, if there is one.
`void`	`selectPreviousWord()` Moves the caret to the beginning of previous word.
`void`	`selectRange(int anchor, int caretPosition)` Positions the anchor and caretPosition explicitly.
`void`	`setEditable(boolean value)` Sets the value of the property editable.
`void`	`setFont(Font value)` Sets the value of the property font.
`void`	`setPromptText(java.lang.String value)` Sets the value of the property promptText.
`void`	`setText(java.lang.String value)` Sets the value of the property text.
`void`	`setTextFormatter(TextFormatter<?> value)` Sets the value of the property textFormatter.
`<any>`	`textFormatterProperty()` The property contains currently attached `TextFormatter`.
`StringProperty`	`textProperty()` The textual content of this TextInputControl.
`(package private) void`	`textUpdated()`
`void`	`undo()` If possible, undoes the last modification.
`ReadOnlyBooleanProperty`	`undoableProperty()` The property describes if it's currently possible to undo the latest change of the content that was done.
`private void`	`updateContent(TextFormatter.Change change, boolean forceNewUndoRecord)`
`private <T> void`	`updateText(TextFormatter<T> formatter)`
`private void`	`updateUndoRedoState()`

Methods inherited from class javafx.scene.control.Control
computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, createDefaultSkin, getBaselineOffset, getContextMenu, getControlChildren, getCssMetaData, getInitialFocusTraversable, getSkin, getTooltip, isResizable, layoutChildren, loadSkinClass, setContextMenu, setSkin, setTooltip, skinClassNameProperty, skinProperty, tooltipProperty

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Property Detail
  - font
```
public final <any> fontProperty
```
    The default font to use for text in the TextInputControl. If the TextInputControl's text is rich text then this font may or may not be used depending on the font information embedded in the rich text, but in any case where a default font is required, this font will be used.
    
    Since:
    
    JavaFX 8.0
    
    See Also:
    
    getFont(), setFont(Font)
  - promptText
```
public final StringProperty promptTextProperty
```
    The prompt text to display in the TextInputControl. If set to null or an empty string, no prompt text is displayed.
    
    Since:
    
    JavaFX 2.2
    
    See Also:
    
    getPromptText(), setPromptText(String)
  - textFormatter
```
public final <any> textFormatterProperty
```
    The property contains currently attached TextFormatter. Since the value is part of the Formatter, changing the TextFormatter will update the text based on the new textFormatter.
    
    Since:
    
    JavaFX 8u40
    
    See Also:
    
    getTextFormatter(), setTextFormatter(TextFormatter)
  - text
```
public final StringProperty textProperty
```
    The textual content of this TextInputControl.
    
    See Also:
    
    getText(), setText(String)
  - length
```
public final ReadOnlyIntegerProperty lengthProperty
```
    The number of characters in the text input.
    
    See Also:
    
    getLength()
  - editable
```
public final BooleanProperty editableProperty
```
    Indicates whether this TextInputControl can be edited by the user.
    
    See Also:
    
    isEditable(), setEditable(boolean)
  - selection
```
public final <any> selectionProperty
```
    The current selection.
    
    See Also:
    
    getSelection()
  - selectedText
```
public final ReadOnlyStringProperty selectedTextProperty
```
    Defines the characters in the TextInputControl which are selected
    
    See Also:
    
    getSelectedText()
  - anchor
```
public final ReadOnlyIntegerProperty anchorProperty
```
    The anchor of the text selection. The anchor and caretPosition make up the selection range. Selection must always be specified in terms of begin <= end, but anchor may be less than, equal to, or greater than the caretPosition. Depending on how the user selects text, the anchor might represent the lower or upper bound of the selection.
    
    See Also:
    
    getAnchor()
  - caretPosition
```
public final ReadOnlyIntegerProperty caretPositionProperty
```
    The current position of the caret within the text. The anchor and caretPosition make up the selection range. Selection must always be specified in terms of begin <= end, but anchor may be less than, equal to, or greater than the caretPosition. Depending on how the user selects text, the caretPosition might represent the lower or upper bound of the selection.
    
    See Also:
    
    getCaretPosition()
  - undoable
```
public final ReadOnlyBooleanProperty undoableProperty
```
    The property describes if it's currently possible to undo the latest change of the content that was done.
    
    Since:
    
    JavaFX 8u40
    
    See Also:
    
    isUndoable()
  - redoable
```
public final ReadOnlyBooleanProperty redoableProperty
```
    The property describes if it's currently possible to redo the latest change of the content that was undone.
    
    Since:
    
    JavaFX 8u40
    
    See Also:
    
    isRedoable()
- Field Detail
  - font
```
private <any> font
```
  - promptText
```
private StringProperty promptText
```
    The prompt text to display in the TextInputControl. If set to null or an empty string, no prompt text is displayed.
    
    Since:
    
    JavaFX 2.2
  - textFormatter
```
private final <any> textFormatter
```
    The property contains currently attached TextFormatter. Since the value is part of the Formatter, changing the TextFormatter will update the text based on the new textFormatter.
    
    Since:
    
    JavaFX 8u40
  - content
```
private final TextInputControl.Content content
```
  - text
```
private TextInputControl.TextProperty text
```
    The textual content of this TextInputControl.
  - length
```
private ReadOnlyIntegerWrapper length
```
    The number of characters in the text input.
  - editable
```
private BooleanProperty editable
```
    Indicates whether this TextInputControl can be edited by the user.
  - selection
```
private <any> selection
```
    The current selection.
  - selectedText
```
private ReadOnlyStringWrapper selectedText
```
    Defines the characters in the TextInputControl which are selected
  - anchor
```
private ReadOnlyIntegerWrapper anchor
```
    The anchor of the text selection. The anchor and caretPosition make up the selection range. Selection must always be specified in terms of begin <= end, but anchor may be less than, equal to, or greater than the caretPosition. Depending on how the user selects text, the anchor might represent the lower or upper bound of the selection.
  - caretPosition
```
private ReadOnlyIntegerWrapper caretPosition
```
    The current position of the caret within the text. The anchor and caretPosition make up the selection range. Selection must always be specified in terms of begin <= end, but anchor may be less than, equal to, or greater than the caretPosition. Depending on how the user selects text, the caretPosition might represent the lower or upper bound of the selection.
  - undoChangeHead
```
private TextInputControl.UndoRedoChange undoChangeHead
```
  - undoChange
```
private TextInputControl.UndoRedoChange undoChange
```
  - createNewUndoRecord
```
private boolean createNewUndoRecord
```
  - undoable
```
private final ReadOnlyBooleanWrapper undoable
```
    The property describes if it's currently possible to undo the latest change of the content that was done.
    
    Since:
    
    JavaFX 8u40
  - redoable
```
private final ReadOnlyBooleanWrapper redoable
```
    The property describes if it's currently possible to redo the latest change of the content that was undone.
    
    Since:
    
    JavaFX 8u40
  - charIterator
```
private java.text.BreakIterator charIterator
```
    The break iterator instances for navigation over words and complex characters.
  - wordIterator
```
private java.text.BreakIterator wordIterator
```
  - accessor
```
private FormatterAccessor accessor
```
  - PSEUDO_CLASS_READONLY
```
private static final PseudoClass PSEUDO_CLASS_READONLY
```
    * Stylesheet Handling * *
- Constructor Detail
  - TextInputControl
```
protected TextInputControl(TextInputControl.Content content)
```
    Creates a new TextInputControl. The content is an immutable property and must be specified (as non-null) at the time of construction.
    
    Parameters:
    
    content - a non-null implementation of Content.
- Method Detail
  - fontProperty
```
public final <any> fontProperty()
```
    The default font to use for text in the TextInputControl. If the TextInputControl's text is rich text then this font may or may not be used depending on the font information embedded in the rich text, but in any case where a default font is required, this font will be used.
    
    Since:
    
    JavaFX 8.0
    
    See Also:
    
    getFont(), setFont(Font)
  - setFont
```
public final void setFont(Font value)
```
    Sets the value of the property font.
    
    Since:
    
    JavaFX 8.0
  - getFont
```
public final Font getFont()
```
    Gets the value of the property font.
    
    Since:
    
    JavaFX 8.0
  - promptTextProperty
```
public final StringProperty promptTextProperty()
```
    The prompt text to display in the TextInputControl. If set to null or an empty string, no prompt text is displayed.
    
    Since:
    
    JavaFX 2.2
    
    See Also:
    
    getPromptText(), setPromptText(String)
  - getPromptText
```
public final java.lang.String getPromptText()
```
    Gets the value of the property promptText.
    
    Since:
    
    JavaFX 2.2
  - setPromptText
```
public final void setPromptText(java.lang.String value)
```
    Sets the value of the property promptText.
    
    Since:
    
    JavaFX 2.2
  - textFormatterProperty
```
public final <any> textFormatterProperty()
```
    The property contains currently attached TextFormatter. Since the value is part of the Formatter, changing the TextFormatter will update the text based on the new textFormatter.
    
    Since:
    
    JavaFX 8u40
    
    See Also:
    
    getTextFormatter(), setTextFormatter(TextFormatter)
  - getTextFormatter
```
public final TextFormatter<?> getTextFormatter()
```
    Gets the value of the property textFormatter.
    
    Since:
    
    JavaFX 8u40
  - setTextFormatter
```
public final void setTextFormatter(TextFormatter<?> value)
```
    Sets the value of the property textFormatter.
    
    Since:
    
    JavaFX 8u40
  - getContent
```
protected final TextInputControl.Content getContent()
```
    Returns the text input's content model.
    
    Returns:
    
    the text input's content model
  - getText
```
public final java.lang.String getText()
```
    Gets the value of the property text.
  - setText
```
public final void setText(java.lang.String value)
```
    Sets the value of the property text.
  - textProperty
```
public final StringProperty textProperty()
```
    The textual content of this TextInputControl.
    
    See Also:
    
    getText(), setText(String)
  - getLength
```
public final int getLength()
```
    Gets the value of the property length.
  - lengthProperty
```
public final ReadOnlyIntegerProperty lengthProperty()
```
    The number of characters in the text input.
    
    See Also:
    
    getLength()
  - isEditable
```
public final boolean isEditable()
```
    Gets the value of the property editable.
  - setEditable
```
public final void setEditable(boolean value)
```
    Sets the value of the property editable.
  - editableProperty
```
public final BooleanProperty editableProperty()
```
    Indicates whether this TextInputControl can be edited by the user.
    
    See Also:
    
    isEditable(), setEditable(boolean)
  - getSelection
```
public final IndexRange getSelection()
```
    Gets the value of the property selection.
  - selectionProperty
```
public final <any> selectionProperty()
```
    The current selection.
    
    See Also:
    
    getSelection()
  - getSelectedText
```
public final java.lang.String getSelectedText()
```
    Gets the value of the property selectedText.
  - selectedTextProperty
```
public final ReadOnlyStringProperty selectedTextProperty()
```
    Defines the characters in the TextInputControl which are selected
    
    See Also:
    
    getSelectedText()
  - getAnchor
```
public final int getAnchor()
```
    Gets the value of the property anchor.
  - anchorProperty
```
public final ReadOnlyIntegerProperty anchorProperty()
```
    The anchor of the text selection. The anchor and caretPosition make up the selection range. Selection must always be specified in terms of begin <= end, but anchor may be less than, equal to, or greater than the caretPosition. Depending on how the user selects text, the anchor might represent the lower or upper bound of the selection.
    
    See Also:
    
    getAnchor()
  - getCaretPosition
```
public final int getCaretPosition()
```
    Gets the value of the property caretPosition.
  - caretPositionProperty
```
public final ReadOnlyIntegerProperty caretPositionProperty()
```
    The current position of the caret within the text. The anchor and caretPosition make up the selection range. Selection must always be specified in terms of begin <= end, but anchor may be less than, equal to, or greater than the caretPosition. Depending on how the user selects text, the caretPosition might represent the lower or upper bound of the selection.
    
    See Also:
    
    getCaretPosition()
  - isUndoable
```
public final boolean isUndoable()
```
    Gets the value of the property undoable.
    
    Since:
    
    JavaFX 8u40
  - undoableProperty
```
public final ReadOnlyBooleanProperty undoableProperty()
```
    The property describes if it's currently possible to undo the latest change of the content that was done.
    
    Since:
    
    JavaFX 8u40
    
    See Also:
    
    isUndoable()
  - isRedoable
```
public final boolean isRedoable()
```
    Gets the value of the property redoable.
    
    Since:
    
    JavaFX 8u40
  - redoableProperty
```
public final ReadOnlyBooleanProperty redoableProperty()
```
    The property describes if it's currently possible to redo the latest change of the content that was undone.
    
    Since:
    
    JavaFX 8u40
    
    See Also:
    
    isRedoable()
  - getText
```
public java.lang.String getText(int start,
                                int end)
```
    Returns a subset of the text input's content.
    
    Parameters:
    
    start - must be a value between 0 and end - 1.
    
    end - must be less than or equal to the length
    
    Returns:
    
    the subset of the text input's content
  - appendText
```
public void appendText(java.lang.String text)
```
    Appends a sequence of characters to the content.
    
    Parameters:
    
    text - a non null String
  - insertText
```
public void insertText(int index,
                       java.lang.String text)
```
    Inserts a sequence of characters into the content.
    
    Parameters:
    
    index - The location to insert the text.
    
    text - The text to insert.
  - deleteText
```
public void deleteText(IndexRange range)
```
    Removes a range of characters from the content.
    
    Parameters:
    
    range - The range of text to delete. The range object must not be null.
    
    See Also:
    
    deleteText(int, int)
  - deleteText
```
public void deleteText(int start,
                       int end)
```
    Removes a range of characters from the content.
    
    Parameters:
    
    start - The starting index in the range, inclusive. This must be >= 0 and < the end.
    
    end - The ending index in the range, exclusive. This is one-past the last character to delete (consistent with the String manipulation methods). This must be > the start, and <= the length of the text.
  - replaceText
```
public void replaceText(IndexRange range,
                        java.lang.String text)
```
    Replaces a range of characters with the given text.
    
    Parameters:
    
    range - The range of text to replace. The range object must not be null.
    
    text - The text that is to replace the range. This must not be null.
    
    See Also:
    
    replaceText(int, int, String)
  - replaceText
```
public void replaceText(int start,
                        int end,
                        java.lang.String text)
```
    Replaces a range of characters with the given text.
    
    Parameters:
    
    start - The starting index in the range, inclusive. This must be >= 0 and < the end.
    
    end - The ending index in the range, exclusive. This is one-past the last character to delete (consistent with the String manipulation methods). This must be > the start, and <= the length of the text.
    
    text - The text that is to replace the range. This must not be null.
  - updateContent
```
private void updateContent(TextFormatter.Change change,
                           boolean forceNewUndoRecord)
```
  - cut
```
public void cut()
```
    Transfers the currently selected range in the text to the clipboard, removing the current selection.
  - copy
```
public void copy()
```
    Transfers the currently selected range in the text to the clipboard, leaving the current selection.
  - paste
```
public void paste()
```
    Transfers the contents in the clipboard into this text, replacing the current selection. If there is no selection, the contents in the clipboard is inserted at the current caret position.
  - selectBackward
```
public void selectBackward()
```
    Moves the selection backward one char in the text. This may have the effect of deselecting, depending on the location of the anchor relative to the caretPosition. This function effectively just moves the caretPosition.
  - selectForward
```
public void selectForward()
```
    Moves the selection forward one char in the text. This may have the effect of deselecting, depending on the location of the anchor relative to the caretPosition. This function effectively just moves the caret forward.
  - previousWord
```
public void previousWord()
```
    Moves the caret to the beginning of previous word. This function also has the effect of clearing the selection.
  - nextWord
```
public void nextWord()
```
    Moves the caret to the beginning of next word. This function also has the effect of clearing the selection.
  - endOfNextWord
```
public void endOfNextWord()
```
    Moves the caret to the end of the next word. This function also has the effect of clearing the selection.
  - selectPreviousWord
```
public void selectPreviousWord()
```
    Moves the caret to the beginning of previous word. This does not cause the selection to be cleared. Rather, the anchor stays put and the caretPosition is moved to the beginning of previous word.
  - selectNextWord
```
public void selectNextWord()
```
    Moves the caret to the beginning of next word. This does not cause the selection to be cleared. Rather, the anchor stays put and the caretPosition is moved to the beginning of next word.
  - selectEndOfNextWord
```
public void selectEndOfNextWord()
```
    Moves the caret to the end of the next word. This does not cause the selection to be cleared.
  - previousWord
```
private void previousWord(boolean select)
```
  - nextWord
```
private void nextWord(boolean select)
```
  - endOfNextWord
```
private void endOfNextWord(boolean select)
```
  - selectAll
```
public void selectAll()
```
    Selects all text in the text input.
  - home
```
public void home()
```
    Moves the caret to before the first char of the text. This function also has the effect of clearing the selection.
  - end
```
public void end()
```
    Moves the caret to after the last char of the text. This function also has the effect of clearing the selection.
  - selectHome
```
public void selectHome()
```
    Moves the caret to before the first char of text. This does not cause the selection to be cleared. Rather, the anchor stays put and the caretPosition is moved to before the first char.
  - selectEnd
```
public void selectEnd()
```
    Moves the caret to after the last char of text. This does not cause the selection to be cleared. Rather, the anchor stays put and the caretPosition is moved to after the last char.
  - deletePreviousChar
```
public boolean deletePreviousChar()
```
    Deletes the character that precedes the current caret position from the text if there is no selection, or deletes the selection if there is one. This function returns true if the deletion succeeded, false otherwise.
    
    Returns:
    
    true if the deletion succeeded, false otherwise
  - deleteNextChar
```
public boolean deleteNextChar()
```
    Deletes the character that follows the current caret position from the text if there is no selection, or deletes the selection if there is one. This function returns true if the deletion succeeded, false otherwise.
    
    Returns:
    
    true if the deletion succeeded, false otherwise
  - forward
```
public void forward()
```
    Moves the caret position forward. If there is no selection, then the caret position is moved one character forward. If there is a selection, then the caret position is moved to the end of the selection and the selection cleared.
  - backward
```
public void backward()
```
    Moves the caret position backward. If there is no selection, then the caret position is moved one character backward. If there is a selection, then the caret position is moved to the beginning of the selection and the selection cleared. Note: This function is intended to be used by experts, primarily by those implementing new Skins or Behaviors. It is not common for developers or designers to access this function directly.
  - positionCaret
```
public void positionCaret(int pos)
```
    Positions the caret to the position indicated by pos. This function will also clear the selection.
    
    Parameters:
    
    pos - the position
  - selectPositionCaret
```
public void selectPositionCaret(int pos)
```
    Positions the caret to the position indicated by pos and extends the selection, if there is one. If there is no selection, then a selection is formed where the anchor is at the current caret position and the caretPosition is moved to pos.
    
    Parameters:
    
    pos - the position
  - selectRange
```
public void selectRange(int anchor,
                        int caretPosition)
```
    Positions the anchor and caretPosition explicitly.
    
    Parameters:
    
    anchor - the anchor
    
    caretPosition - the caretPosition
  - doSelectRange
```
private void doSelectRange(int anchor,
                           int caretPosition)
```
  - extendSelection
```
public void extendSelection(int pos)
```
    This function will extend the selection to include the specified pos. This is different from selectPositionCaret in that it does not simply move the caret. Rather, it will reposition the caret and anchor as necessary to ensure that pos becomes the new caret and the far other end of the selection becomes the anchor.
    
    Parameters:
    
    pos - the position
  - clear
```
public void clear()
```
    Clears the text.
  - deselect
```
public void deselect()
```
    Clears the selection.
  - replaceSelection
```
public void replaceSelection(java.lang.String replacement)
```
    Replaces the selection with the given replacement String. If there is no selection, then the replacement text is simply inserted at the current caret position. If there was a selection, then the selection is cleared and the given replacement text inserted.
    
    Parameters:
    
    replacement - the replacement string
  - undo
```
public final void undo()
```
    If possible, undoes the last modification. If isUndoable() returns false, then calling this method has no effect.
    
    Since:
    
    JavaFX 8u40
  - redo
```
public final void redo()
```
    If possible, redoes the last undone modification. If isRedoable() returns false, then calling this method has no effect.
    
    Since:
    
    JavaFX 8u40
  - textUpdated
```
void textUpdated()
```
  - resetUndoRedoState
```
private void resetUndoRedoState()
```
  - updateUndoRedoState
```
private void updateUndoRedoState()
```
  - filterAndSet
```
private boolean filterAndSet(java.lang.String value)
```
  - replaceText
```
private int replaceText(int start,
                        int end,
                        java.lang.String value,
                        int anchor,
                        int caretPosition)
```
    This is what is ultimately called by every code path that will update the content (except for undo / redo). The input into this method has already run through the textFormatter where appropriate.
    
    Parameters:
    
    start - The start index into the existing text which will be replaced by the new value
    
    end - The end index into the existing text which will be replaced by the new value. As with String.replace this is a lastIndex+1 value
    
    value - The new text value
    
    anchor - The new selection anchor after the change is made
    
    caretPosition - The new selection caretPosition after the change is made.
    
    Returns:
    
    The amount of adjustment made to the end / anchor / caretPosition to accommodate for subsequent filtering (such as the filtering of new lines by the TextField)
  - updateText
```
private <T> void updateText(TextFormatter<T> formatter)
```
  - commitValue
```
public final void commitValue()
```
    Commit the current text and convert it to a value.
    
    Since:
    
    JavaFX 8u40
  - cancelEdit
```
public final void cancelEdit()
```
    If the field is currently being edited, this call will set text to the last commited value.
    
    Since:
    
    JavaFX 8u40
  - getFormatterAccessor
```
private FormatterAccessor getFormatterAccessor()
```
  - filterInput
```
static java.lang.String filterInput(java.lang.String txt,
                                    boolean stripNewlines,
                                    boolean stripTabs)
```
    A little utility method for stripping out unwanted characters.
    
    Parameters:
    
    txt -
    
    stripNewlines -
    
    stripTabs -
    
    Returns:
    
    The string after having the unwanted characters stripped out.
  - containsInvalidCharacters
```
static boolean containsInvalidCharacters(java.lang.String txt,
                                         boolean newlineIllegal,
                                         boolean tabIllegal)
```
  - isInvalidCharacter
```
private static boolean isInvalidCharacter(char c,
                                          boolean newlineIllegal,
                                          boolean tabIllegal)
```
  - getClassCssMetaData
```
public static java.util.List<<any>> getClassCssMetaData()
```
    Returns:
    
    The CssMetaData associated with this class, which may include the CssMetaData of its superclasses.
    
    Since:
    
    JavaFX 8.0
  - getControlCssMetaData
```
public java.util.List<<any>> getControlCssMetaData()
```
    Overrides:
    
    getControlCssMetaData in class Control
    
    Returns:
    
    unmodifiable list of the controls css styleable properties
    
    Since:
    
    JavaFX 8.0
  - queryAccessibleAttribute
```
public java.lang.Object queryAccessibleAttribute(AccessibleAttribute attribute,
                                                 java.lang.Object... parameters)
```
    Overrides:
    
    queryAccessibleAttribute in class Control
  - executeAccessibleAction
```
public void executeAccessibleAction(AccessibleAction action,
                                    java.lang.Object... parameters)
```
    Overrides:
    
    executeAccessibleAction in class Control

Class TextInputControl

Property Summary

Properties inherited from class javafx.scene.control.Control

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class javafx.scene.control.Control

Methods inherited from class java.lang.Object

Property Detail

font

promptText

textFormatter

text

length

editable

selection

selectedText

anchor

caretPosition

undoable

redoable

Field Detail

font

promptText

textFormatter

content

text

length

editable

selection

selectedText

anchor

caretPosition

undoChangeHead

undoChange

createNewUndoRecord

undoable

redoable

charIterator

wordIterator

accessor

PSEUDO_CLASS_READONLY

Constructor Detail

TextInputControl

Method Detail

fontProperty

setFont

getFont

promptTextProperty

getPromptText

setPromptText

textFormatterProperty

getTextFormatter

setTextFormatter

getContent

getText

setText

textProperty

getLength

lengthProperty

isEditable

setEditable

editableProperty

getSelection

selectionProperty

getSelectedText

selectedTextProperty

getAnchor

anchorProperty

getCaretPosition

caretPositionProperty

isUndoable

undoableProperty

isRedoable

redoableProperty

getText

appendText

insertText

deleteText