javafx.scene.control

Class TextInputControl

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.control.Control

javafx.scene.control.TextInputControl

All Implemented Interfaces:

EventTarget, Skinnable

Direct Known Subclasses:

TextArea, TextField

@DefaultProperty(value="text")
public abstract class TextInputControl
extends Control

Abstract base class for text input controls.

Property Summary

Properties

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.
ReadOnlyIntegerProperty	length The number of characters in the text input.
StringProperty	promptText The prompt text to display in the TextInputControl, or null if no prompt text is displayed.
ReadOnlyStringProperty	selectedText Defines the characters in the TextInputControl which are selected
ReadOnlyObjectProperty<IndexRange>	selection The current selection.
StringProperty	text The textual content of this TextInputControl.

Properties inherited from class javafx.scene.control.Control

contextMenu, height, maxHeight, maxWidth, minHeight, minWidth, prefHeight, prefWidth, skinClassName, skin, tooltip, width

Properties inherited from class javafx.scene.Parent

needsLayout

Properties inherited from class javafx.scene.Node

blendMode, boundsInLocal, boundsInParent, cacheHint, cache, clip, cursor, depthTest, disabled, disable, effect, eventDispatcher, focused, focusTraversable, hover, id, inputMethodRequests, layoutBounds, layoutX, layoutY, localToParentTransform, localToSceneTransform, managed, mouseTransparent, onContextMenuRequested, onDragDetected, onDragDone, onDragDropped, onDragEntered, onDragExited, onDragOver, onInputMethodTextChanged, onKeyPressed, onKeyReleased, onKeyTyped, onMouseClicked, onMouseDragEntered, onMouseDragExited, onMouseDragged, onMouseDragOver, onMouseDragReleased, onMouseEntered, onMouseExited, onMouseMoved, onMousePressed, onMouseReleased, onRotate, onRotationFinished, onRotationStarted, onScrollFinished, onScroll, onScrollStarted, onSwipeDown, onSwipeLeft, onSwipeRight, onSwipeUp, onTouchMoved, onTouchPressed, onTouchReleased, onTouchStationary, onZoomFinished, onZoom, onZoomStarted, opacity, parent, pickOnBounds, pressed, rotate, rotationAxis, scaleX, scaleY, scaleZ, scene, style, translateX, translateY, translateZ, visible

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	TextInputControl.Content Interface representing a text input's content.

Field Summary

Fields inherited from class javafx.scene.control.Control

USE_COMPUTED_SIZE, USE_PREF_SIZE

Constructor Summary

Constructors

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

Method Summary

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.
ReadOnlyIntegerProperty	caretPositionProperty() The current position of the caret within the text.
void	clear() Clears the text.
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.
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.
void	extendSelection(int pos) This function will extend the selection to include the specified pos.
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.
protected TextInputControl.Content	getContent() Returns the text input's content model.
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.
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.
ReadOnlyIntegerProperty	lengthProperty() The number of characters in the text input.
void	nextWord() Moves the caret to the beginning of next word.
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.
StringProperty	promptTextProperty() The prompt text to display in the TextInputControl, or null if no prompt text is displayed.
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.
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.
ReadOnlyObjectProperty<IndexRange>	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	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.
StringProperty	textProperty() The textual content of this TextInputControl.

Methods inherited from class javafx.scene.control.Control

computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, getBaselineOffset, getContextMenu, getHeight, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getPrefHeight, getPrefWidth, getSkin, getTooltip, getUserAgentStylesheet, getWidth, heightProperty, intersects, isResizable, layoutChildren, maxHeight, maxHeightProperty, maxWidth, maxWidthProperty, minHeight, minHeightProperty, minWidth, minWidthProperty, prefHeight, prefHeightProperty, prefWidth, prefWidthProperty, resize, setContextMenu, setHeight, setMaxHeight, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinWidth, setPrefHeight, setPrefSize, setPrefWidth, setSkin, setSkinClassName, setTooltip, setWidth, skinClassNameProperty, skinProperty, tooltipProperty, widthProperty

Methods inherited from class javafx.scene.Parent

getChildren, getChildrenUnmodifiable, getManagedChildren, getStylesheets, isNeedsLayout, layout, lookup, needsLayoutProperty, requestLayout, setNeedsLayout

Methods inherited from class javafx.scene.Node

addEventFilter, addEventHandler, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, contains, contains, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectProperty, eventDispatcherProperty, fireEvent, focusedProperty, focusTraversableProperty, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getContentBias, getCursor, getDepthTest, getEffect, getEventDispatcher, getId, getInputMethodRequests, getLayoutBounds, getLayoutX, getLayoutY, getLocalToParentTransform, getLocalToSceneTransform, getOnContextMenuRequested, getOnDragDetected, getOnDragDone, getOnDragDropped, getOnDragEntered, getOnDragExited, getOnDragOver, getOnInputMethodTextChanged, getOnKeyPressed, getOnKeyReleased, getOnKeyTyped, getOnMouseClicked, getOnMouseDragEntered, getOnMouseDragExited, getOnMouseDragged, getOnMouseDragOver, getOnMouseDragReleased, getOnMouseEntered, getOnMouseExited, getOnMouseMoved, getOnMousePressed, getOnMouseReleased, getOnRotate, getOnRotationFinished, getOnRotationStarted, getOnScroll, getOnScrollFinished, getOnScrollStarted, getOnSwipeDown, getOnSwipeLeft, getOnSwipeRight, getOnSwipeUp, getOnTouchMoved, getOnTouchPressed, getOnTouchReleased, getOnTouchStationary, getOnZoom, getOnZoomFinished, getOnZoomStarted, getOpacity, getParent, getProperties, getRotate, getRotationAxis, getScaleX, getScaleY, getScaleZ, getScene, getStyle, getStyleClass, getTransforms, getTranslateX, getTranslateY, getTranslateZ, getUserData, hasProperties, hoverProperty, idProperty, inputMethodRequestsProperty, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isVisible, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToSceneTransformProperty, lookupAll, managedProperty, mouseTransparentProperty, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, parentToLocal, parentToLocal, parentToLocal, pickOnBoundsProperty, pressedProperty, relocate, removeEventFilter, removeEventHandler, requestFocus, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, setBlendMode, setCache, setCacheHint, setClip, setCursor, setDepthTest, setDisable, setDisabled, setEffect, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, setId, setInputMethodRequests, setLayoutX, setLayoutY, setManaged, setMouseTransparent, setOnContextMenuRequested, setOnDragDetected, setOnDragDone, setOnDragDropped, setOnDragEntered, setOnDragExited, setOnDragOver, setOnInputMethodTextChanged, setOnKeyPressed, setOnKeyReleased, setOnKeyTyped, setOnMouseClicked, setOnMouseDragEntered, setOnMouseDragExited, setOnMouseDragged, setOnMouseDragOver, setOnMouseDragReleased, setOnMouseEntered, setOnMouseExited, setOnMouseMoved, setOnMousePressed, setOnMouseReleased, setOnRotate, setOnRotationFinished, setOnRotationStarted, setOnScroll, setOnScrollFinished, setOnScrollStarted, setOnSwipeDown, setOnSwipeLeft, setOnSwipeRight, setOnSwipeUp, setOnTouchMoved, setOnTouchPressed, setOnTouchReleased, setOnTouchStationary, setOnZoom, setOnZoomFinished, setOnZoomStarted, setOpacity, setPickOnBounds, setPressed, setRotate, setRotationAxis, setScaleX, setScaleY, setScaleZ, setStyle, setTranslateX, setTranslateY, setTranslateZ, setUserData, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, visibleProperty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Property Detail

promptText

public final StringProperty promptTextProperty

The prompt text to display in the TextInputControl, or null if no prompt text is displayed.

See Also:

getPromptText(), setPromptText(String)

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 ReadOnlyObjectProperty<IndexRange> 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()

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

promptTextProperty

public final StringProperty promptTextProperty()

The prompt text to display in the TextInputControl, or null if no prompt text is displayed.

See Also:

getPromptText(), setPromptText(String)

getPromptText

public final java.lang.String getPromptText()

Gets the value of the property promptText.

Property description:

The prompt text to display in the TextInputControl, or null if no prompt text is displayed.

setPromptText

public final void setPromptText(java.lang.String value)

Sets the value of the property promptText.

Property description:

The prompt text to display in the TextInputControl, or null if no prompt text is displayed.

getContent

protected final TextInputControl.Content getContent()

Returns the text input's content model.

getText

public final java.lang.String getText()

Gets the value of the property text.

Property description:

The textual content of this TextInputControl.

setText

public final void setText(java.lang.String value)

Sets the value of the property text.

Property description:

The textual content of this TextInputControl.

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.

Property description:

The number of characters in the text input.

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.

Property description:

Indicates whether this TextInputControl can be edited by the user.

setEditable

public final void setEditable(boolean value)

Sets the value of the property editable.

Property description:

Indicates whether this TextInputControl can be edited by the user.

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.

Property description:

The current selection.

selectionProperty

public final ReadOnlyObjectProperty<IndexRange> selectionProperty()

The current selection.

See Also:

getSelection()

getSelectedText

public final java.lang.String getSelectedText()

Gets the value of the property selectedText.

Property description:

Defines the characters in the TextInputControl which are selected

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.

Property description:

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.

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.

Property description:

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.

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()

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

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 -

See Also:

deleteText(int, int)

deleteText

public void deleteText(int start,
              int end)

Removes a range of characters from the content.

Parameters:

start -

end -

replaceText

public void replaceText(IndexRange range,
               java.lang.String text)

Replaces a range of characters with the given text.

Parameters:

range -

text -

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 -

end -

text -

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.

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.

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.

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.

Since:

JavaFX 1.3

_{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.

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.

selectRange

public void selectRange(int anchor,
               int caretPosition)

Positions the anchor and caretPosition explicitly.

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.

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.