Package javafx.scene.control

Class TextInputControl

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.layout.Region

javafx.scene.control.Control

javafx.scene.control.TextInputControl

All Implemented Interfaces:

LayoutMeasurable, LayoutMeasurableMixin, HasBackgroundProperty, HasBlendModeProperty, HasBorderProperty, HasClipProperty, HasEffectProperty, HasFontProperty, HasHeightProperty, HasLayoutXProperty, HasLayoutYProperty, HasManagedProperty, HasMaxHeightProperty, HasMaxWidthProperty, HasMinHeightProperty, HasMinWidthProperty, HasMouseTransparentProperty, HasOnMouseClickedProperty, HasOpacityProperty, HasPaddingProperty, HasParentProperty, HasPrefHeightProperty, HasPrefWidthProperty, HasPromptTextProperty, HasSnapToPixelProperty, HasTextProperty, HasVisibleProperty, HasWidthProperty, Styleable, EventTarget, Skinnable, INode, PreferenceResizableNode

Direct Known Subclasses:

TextArea, TextField

public abstract class TextInputControl
extends Control
implements HasFontProperty, HasTextProperty, HasPromptTextProperty

Author:

Bruno Salmon

Property Summary

Properties

Type	Property	Description
final BooleanProperty	editable	Indicates whether this TextInputControl can be edited by the user.
Property<Font>	font
StringProperty	promptText
StringProperty	text

Properties inherited from class javafx.scene.control.Control

contextMenu, skin

Properties inherited from class javafx.scene.layout.Region

background, border, height, insets, maxHeight, maxWidth, minHeight, minWidth, padding, prefHeight, prefWidth, snapToPixel, width

Properties inherited from class javafx.scene.Parent

needsLayout

Properties inherited from class javafx.scene.Node

blendMode, cacheHint, cache, clip, cursor, disabled, disable, effect, eventDispatcher, focused, focusTraversable, hover, id, layoutBounds, layoutX, layoutY, managed, mouseTransparent, onContextMenuRequested, onDragDetected, onDragDone, onDragDropped, onDragEntered, onDragExited, onDragOver, onKeyPressed, onKeyReleased, onKeyTyped, onMouseClicked, onMouseDragged, onMouseEntered, onMouseExited, onMouseMoved, onMousePressed, onMouseReleased, onScroll, onSwipeDown, onSwipeLeft, onSwipeRight, onSwipeUp, onTouchMoved, onTouchPressed, onTouchReleased, onTouchStationary, opacity, parent, pressed, rotate, scaleX, scaleY, scaleZ, scene, style, translateX, translateY, visible

Properties inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.markers.HasBlendModeProperty

blendMode

Properties inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.markers.HasClipProperty

clip

Properties inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.markers.HasEffectProperty

effect

Properties inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.markers.HasLayoutXProperty

layoutX

Properties inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.markers.HasLayoutYProperty

layoutY

Properties inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.markers.HasManagedProperty

managed

Properties inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.markers.HasMouseTransparentProperty

mouseTransparent

Properties inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.markers.HasOnMouseClickedProperty

onMouseClicked

Properties inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.markers.HasOpacityProperty

opacity

Properties inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.markers.HasParentProperty

parent

Properties inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.markers.HasVisibleProperty

visible

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TextInputControl.SelectableTextInputControlPeer

Field Summary

Fields inherited from interface javafx.scene.INode

BASELINE_OFFSET_SAME_AS_HEIGHT

Fields inherited from interface javafx.scene.layout.PreferenceResizableNode

USE_COMPUTED_SIZE, USE_PREF_SIZE

Constructor Summary

Constructors

Constructor	Description
TextInputControl()

Method Summary

Modifier and Type	Method	Description
void	clear()	Clears the text.
final 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.
Property<Font>	fontProperty()
final int	getLength()
void	home()	Moves the caret to before the first char of the text.
final boolean	isEditable()	Gets the value of the editable property.
StringProperty	promptTextProperty()
void	selectAll()	Selects all text in the text input.
void	selectRange(int anchor, int caretPosition)	Positions the anchor and caretPosition explicitly.
final void	setEditable(boolean value)	Sets the value of the editable property.
StringProperty	textProperty()

Methods inherited from class javafx.scene.control.Control

computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, createDefaultSkin, getBaselineOffset, getContextMenu, getSkin, layoutChildren, setContextMenu, setSkin, shouldUseLayoutMeasurable, skinProperty

Methods inherited from class javafx.scene.layout.Region

backgroundProperty, borderProperty, boundedSize, getInsets, heightProperty, impl_computeGeomBounds, impl_computeLayoutBounds, impl_maxHeight, impl_maxWidth, impl_minHeight, impl_minWidth, impl_prefHeight, impl_prefWidth, insetsProperty, layoutInArea, layoutInArea, layoutInArea, layoutInArea, maxHeightProperty, maxWidthProperty, minHeightProperty, minWidthProperty, paddingProperty, positionInArea, positionInArea, prefHeightProperty, prefWidthProperty, resize, setMaxSize, setMinSize, setPrefSize, snappedBottomInset, snappedLeftInset, snappedRightInset, snappedTopInset, snapPosition, snapPositionX, snapPositionY, snapSize, snapSizeX, snapSizeY, snapSpace, snapSpaceX, snapSpaceY, snapToPixelProperty, widthProperty

Methods inherited from class javafx.scene.Parent

getChildren, getChildrenUnmodifiable, getManagedChildren, isNeedsLayout, layout, needsLayoutProperty, requestLayout, requestParentLayout, setLayoutFlag, setNeedsLayout, setSceneRoot

Methods inherited from class javafx.scene.Node

addEventFilter, addEventHandler, autosize, blendModeProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, createLayoutMeasurable, cursorProperty, disabledProperty, disableProperty, effectProperty, eventDispatcherProperty, fireEvent, focusedProperty, focusTraversableProperty, getAllNodeTransforms, getBoundsInLocal, getCacheHint, getCursor, getEventDispatcher, getId, getLayoutMeasurable, getNodePeer, getOnContextMenuRequested, getOnDragDetected, getOnDragDone, getOnDragDropped, getOnDragEntered, getOnDragExited, getOnDragOver, getOnKeyPressed, getOnKeyReleased, getOnKeyTyped, getOnMouseDragged, getOnMouseEntered, getOnMouseExited, getOnMouseMoved, getOnMousePressed, getOnMouseReleased, getOnScroll, getOnSwipeDown, getOnSwipeLeft, getOnSwipeRight, getOnSwipeUp, getOnTouchMoved, getOnTouchPressed, getOnTouchReleased, getOnTouchStationary, getOrCreateAndBindNodePeer, getProperties, getRotate, getScaleX, getScaleY, getScaleZ, getScene, getStyle, getStyleClass, getTransforms, getTranslateX, getTranslateY, getUserData, hasProperties, hoverProperty, idProperty, impl_getLayoutBounds, impl_isTreeVisible, impl_traverse, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isHover, isPressed, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToScene, localToScene, localToScreen, localToScreen, localToScreen, localToScreen, managedProperty, mouseTransparentProperty, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDraggedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onNodePeerReady, onPeerSizeChanged, onScrollProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, opacityProperty, parentProperty, parentToLocal, pressedProperty, removeEventFilter, removeEventHandler, requestFocus, requestPeerFocus, rotateProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, setCache, setCacheHint, setCursor, setDisable, setDisabled, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, setId, setNodePeer, setOnContextMenuRequested, setOnDragDetected, setOnDragDone, setOnDragDropped, setOnDragEntered, setOnDragExited, setOnDragOver, setOnKeyPressed, setOnKeyReleased, setOnKeyTyped, setOnMouseDragged, setOnMouseEntered, setOnMouseExited, setOnMouseMoved, setOnMousePressed, setOnMouseReleased, setOnScroll, setOnSwipeDown, setOnSwipeLeft, setOnSwipeRight, setOnSwipeUp, setOnTouchMoved, setOnTouchPressed, setOnTouchReleased, setOnTouchStationary, setPressed, setRotate, setScaleX, setScaleY, setScaleZ, setScene, setStyle, setTranslateX, setTranslateY, setUserData, snapshot, startDragAndDrop, styleProperty, toBack, toFront, translateXProperty, translateYProperty, visibleProperty

Methods inherited from class java.lang.Object

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

Methods inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.markers.HasBackgroundProperty

getBackground, setBackground

Methods inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.markers.HasBlendModeProperty

blendModeProperty, getBlendMode, setBlendMode

Methods inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.markers.HasBorderProperty

getBorder, setBorder

Methods inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.markers.HasClipProperty

clipProperty, getClip, setClip

Methods inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.markers.HasEffectProperty

effectProperty, getEffect, setEffect

Methods inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.markers.HasFontProperty

getFont, setFont

Methods inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.markers.HasHeightProperty

getHeight, setHeight

Methods inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.markers.HasLayoutXProperty

getLayoutX, layoutXProperty, setLayoutX

Methods inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.markers.HasLayoutYProperty

getLayoutY, layoutYProperty, setLayoutY

Methods inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.markers.HasManagedProperty

isManaged, managedProperty, setManaged

Methods inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.markers.HasMaxHeightProperty

getMaxHeight, setMaxHeight

Methods inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.markers.HasMaxWidthProperty

getMaxWidth, setMaxWidth

Methods inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.markers.HasMinHeightProperty

getMinHeight, setMinHeight

Methods inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.markers.HasMinWidthProperty

getMinWidth, setMinWidth

Methods inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.markers.HasMouseTransparentProperty

isMouseTransparent, mouseTransparentProperty, setMouseTransparent

Methods inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.markers.HasOnMouseClickedProperty

getOnMouseClicked, onMouseClickedProperty, setOnMouseClicked

Methods inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.markers.HasOpacityProperty

getOpacity, opacityProperty, setOpacity

Methods inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.markers.HasPaddingProperty

getPadding, setPadding

Methods inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.markers.HasParentProperty

getParent, parentProperty, setParent

Methods inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.markers.HasPrefHeightProperty

getPrefHeight, setPrefHeight

Methods inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.markers.HasPrefWidthProperty

getPrefWidth, setPrefWidth

Methods inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.markers.HasPromptTextProperty

getPromptText, setPromptText

Methods inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.markers.HasSnapToPixelProperty

isSnapToPixel, setSnapToPixel

Methods inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.markers.HasTextProperty

getText, setText

Methods inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.markers.HasVisibleProperty

isVisible, setVisible, visibleProperty

Methods inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.markers.HasWidthProperty

getWidth, setWidth

Methods inherited from interface javafx.scene.INode

autosize, getAllNodeTransforms, getContentBias, getNodePeer, getOrCreateAndBindNodePeer, getProperties, getScene, getTransforms, hasProperties, relocate, resizeRelocate

Methods inherited from interface dev.webfx.kit.mapper.peers.javafxgraphics.emul_coupling.LayoutMeasurableMixin

clearCache, getLayoutBounds, getLayoutMeasurable, maxHeight, maxWidth, minHeight, minWidth, prefHeight, prefWidth

Methods inherited from interface javafx.scene.layout.PreferenceResizableNode

isResizable

Property Details

font

public Property<Font> fontProperty

Specified by:

fontProperty in interface HasFontProperty

Returns:

the font property

See Also:

• fontProperty()

text

public StringProperty textProperty

Specified by:

textProperty in interface HasTextProperty

Returns:

the text property

See Also:

• textProperty()

promptText

public StringProperty promptTextProperty

Specified by:

promptTextProperty in interface HasPromptTextProperty

Returns:

the promptText property

See Also:

• promptTextProperty()

editable

public final BooleanProperty editableProperty

Indicates whether this TextInputControl can be edited by the user.

See Also:

• isEditable()
• setEditable(boolean)
• editableProperty()

Constructor Details

TextInputControl

public TextInputControl()

Method Details

fontProperty

public Property<Font> fontProperty()

Specified by:

fontProperty in interface HasFontProperty

Returns:

the font property

See Also:

• HasFontProperty.getFont()
• HasFontProperty.setFont(Font)

textProperty

public StringProperty textProperty()

Specified by:

textProperty in interface HasTextProperty

Returns:

the text property

See Also:

• HasTextProperty.getText()
• HasTextProperty.setText(String)

promptTextProperty

public StringProperty promptTextProperty()

Specified by:

promptTextProperty in interface HasPromptTextProperty

Returns:

the promptText property

See Also:

• HasPromptTextProperty.getPromptText()
• HasPromptTextProperty.setPromptText(String)

isEditable

public final boolean isEditable()

Gets the value of the editable property.

Property description:

Indicates whether this TextInputControl can be edited by the user.

Returns:

the value of the editable property

See Also:

• setEditable(boolean)
• editableProperty()

setEditable

public final void setEditable(boolean value)

Sets the value of the editable property.

Property description:

Indicates whether this TextInputControl can be edited by the user.

Parameters:

value - the value for the editable property

See Also:

• isEditable()
• editableProperty()

editableProperty

public final BooleanProperty editableProperty()

Indicates whether this TextInputControl can be edited by the user.

Returns:

the editable property

See Also:

• isEditable()
• setEditable(boolean)

clear

public void clear()

Clears the text.

getLength

public final int getLength()

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.

selectRange

public void selectRange(int anchor,
 int caretPosition)

Positions the anchor and caretPosition explicitly.

Parameters:

anchor - the anchor

caretPosition - the caretPosition