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:
Styleable, EventTarget, Skinnable
Abstract base class for text input controls.
- Since:
- JavaFX 2.0
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprotected static interfaceInterface representing a text input's content. -
Property Summary
PropertiesTypePropertyDescriptionfinal ReadOnlyIntegerPropertyTheanchorof the text selection.final ReadOnlyIntegerPropertyThe current position of the caret within the text.final BooleanPropertyIndicates whether this TextInputControl can be edited by the user.final ObjectProperty<Font> The default font to use for text in the TextInputControl.final ReadOnlyIntegerPropertyThe number of characters in the text input.final StringPropertyThe prompt text to display in theTextInputControl.final ReadOnlyBooleanPropertyThe property describes if it's currently possible to redo the latest change of the content that was undone.final ReadOnlyStringPropertyDefines the characters in the TextInputControl which are selectedfinal ReadOnlyObjectProperty<IndexRange> The current selection.final ObjectProperty<TextFormatter<?>> The property contains currently attachedTextFormatter.final StringPropertyThe textual content of this TextInputControl.final ReadOnlyBooleanPropertyThe property describes if it's currently possible to undo the latest change of the content that was done.Properties declared in class Control
contextMenu, skin, tooltipTypePropertyDescriptionfinal ObjectProperty<ContextMenu> The ContextMenu to show for this control.final ObjectProperty<Skin<?>> Skin is responsible for rendering thisControl.final ObjectProperty<Tooltip> The ToolTip for this control.Properties declared in class Region
background, border, cacheShape, centerShape, height, insets, maxHeight, maxWidth, minHeight, minWidth, opaqueInsets, padding, prefHeight, prefWidth, scaleShape, shape, snapToPixel, widthTypePropertyDescriptionfinal ObjectProperty<Background> The background of the Region, which is made up of zero or more BackgroundFills, and zero or more BackgroundImages.final ObjectProperty<Border> The border of the Region, which is made up of zero or more BorderStrokes, and zero or more BorderImages.final BooleanPropertyDefines a hint to the system indicating that the Shape used to define the region's background is stable and would benefit from caching.final BooleanPropertyDefines whether the shape is centered within theRegion's width and height.final ReadOnlyDoublePropertyThe height of this resizable node.final ReadOnlyObjectProperty<Insets> The insets of the Region define the distance from the edge of the region (its layout bounds, or (0, 0, width, height)) to the edge of the content area.final DoublePropertyProperty for overriding the region's computed maximum height.final DoublePropertyProperty for overriding the region's computed maximum width.final DoublePropertyProperty for overriding the region's computed minimum height.final DoublePropertyProperty for overriding the region's computed minimum width.final ObjectProperty<Insets> Defines the area of the region within which completely opaque pixels are drawn.final ObjectProperty<Insets> The top, right, bottom, and left padding around the region's content.final DoublePropertyProperty for overriding the region's computed preferred height.final DoublePropertyProperty for overriding the region's computed preferred width.final BooleanPropertySpecifies whether the shape, if defined, is scaled to match the size of the Region.final ObjectProperty<Shape> When specified, theShapewill cause the region to be rendered as the specified shape rather than as a rounded rectangle.final BooleanPropertyDefines whether this region adjusts position, spacing, and size values of its children to pixel boundaries.final ReadOnlyDoublePropertyThe width of this resizable node.Properties declared in class Parent
needsLayoutTypePropertyDescriptionfinal ReadOnlyBooleanPropertyIndicates that this Node and its subnodes requires a layout pass on the next pulse.Properties declared in class Node
accessibleHelp, accessibleRoleDescription, accessibleRole, accessibleText, blendMode, boundsInLocal, boundsInParent, cacheHint, cache, clip, cursor, depthTest, disabled, disable, effectiveNodeOrientation, effect, eventDispatcher, focused, focusTraversable, focusVisible, focusWithin, hover, id, inputMethodRequests, layoutBounds, layoutX, layoutY, localToParentTransform, localToSceneTransform, managed, mouseTransparent, nodeOrientation, onContextMenuRequested, onDragDetected, onDragDone, onDragDropped, onDragEntered, onDragExited, onDragOver, onInputMethodTextChanged, onKeyPressed, onKeyReleased, onKeyTyped, onMouseClicked, onMouseDragDone, 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, viewOrder, visibleTypePropertyDescriptionfinal ObjectProperty<String> The accessible help text for thisNode.final ObjectProperty<String> The role description of thisNode.final ObjectProperty<AccessibleRole> The accessible role for thisNode.final ObjectProperty<String> The accessible text for thisNode.final ObjectProperty<BlendMode> TheBlendModeused to blend this individual node into the scene behind it.final ReadOnlyObjectProperty<Bounds> The rectangular bounds of thisNodein the node's untransformed local coordinate space.final ReadOnlyObjectProperty<Bounds> The rectangular bounds of thisNodein the parent coordinate system.final ObjectProperty<CacheHint> Additional hint for controlling bitmap caching.final BooleanPropertyA performance hint to the system to indicate that thisNodeshould be cached as a bitmap.final ObjectProperty<Node> Specifies aNodeto use to define the clipping shape for this Node.final ObjectProperty<Cursor> Defines the mouse cursor for thisNodeand subnodes.final ObjectProperty<DepthTest> Indicates whether depth testing is used when rendering this node.final ReadOnlyBooleanPropertyIndicates whether or not thisNodeis disabled.final BooleanPropertyDefines the individual disabled state of thisNode.The effective orientation of a node resolves the inheritance of node orientation, returning either left-to-right or right-to-left.final ObjectProperty<Effect> Specifies an effect to apply to thisNode.final ObjectProperty<EventDispatcher> Specifies the event dispatcher for this node.final ReadOnlyBooleanPropertyIndicates whether thisNodecurrently has the input focus.final BooleanPropertySpecifies whether thisNodeshould be a part of focus traversal cycle.final ReadOnlyBooleanPropertyIndicates whether thisNodeshould visibly indicate focus.final ReadOnlyBooleanPropertyIndicates whether thisNodeor any of its descendants currently has the input focus.final ReadOnlyBooleanPropertyWhether or not thisNodeis being hovered over.final StringPropertyThe id of thisNode.Property holding InputMethodRequests.final ReadOnlyObjectProperty<Bounds> The rectangular bounds that should be used for layout calculations for this node.final DoublePropertyDefines the x coordinate of the translation that is added to thisNode's transform for the purpose of layout.final DoublePropertyDefines the y coordinate of the translation that is added to thisNode's transform for the purpose of layout.final ReadOnlyObjectProperty<Transform> An affine transform that holds the computed local-to-parent transform.final ReadOnlyObjectProperty<Transform> An affine transform that holds the computed local-to-scene transform.final BooleanPropertyDefines whether or not this node's layout will be managed by its parent.final BooleanPropertyIftrue, this node (together with all its children) is completely transparent to mouse events.final ObjectProperty<NodeOrientation> Node orientation describes the flow of visual data within a node.final ObjectProperty<EventHandler<? super ContextMenuEvent>> Defines a function to be called when a context menu has been requested on thisNode.final ObjectProperty<EventHandler<? super MouseEvent>> Defines a function to be called when drag gesture has been detected.final ObjectProperty<EventHandler<? super DragEvent>> Defines a function to be called when thisNodeis a drag and drop gesture source after its data has been dropped on a drop target.final ObjectProperty<EventHandler<? super DragEvent>> Defines a function to be called when the mouse button is released on thisNodeduring drag and drop gesture.final ObjectProperty<EventHandler<? super DragEvent>> Defines a function to be called when drag gesture enters thisNode.final ObjectProperty<EventHandler<? super DragEvent>> Defines a function to be called when drag gesture exits thisNode.final ObjectProperty<EventHandler<? super DragEvent>> Defines a function to be called when drag gesture progresses within thisNode.final ObjectProperty<EventHandler<? super InputMethodEvent>> Defines a function to be called when thisNodehas input focus and the input method text has changed.final ObjectProperty<EventHandler<? super KeyEvent>> Defines a function to be called when thisNodeor its childNodehas input focus and a key has been pressed.final ObjectProperty<EventHandler<? super KeyEvent>> Defines a function to be called when thisNodeor its childNodehas input focus and a key has been released.final ObjectProperty<EventHandler<? super KeyEvent>> Defines a function to be called when thisNodeor its childNodehas input focus and a key has been typed.final ObjectProperty<EventHandler<? super MouseEvent>> Defines a function to be called when a mouse button has been clicked (pressed and released) on thisNode.final ObjectProperty<EventHandler<? super MouseDragEvent>> Defines a function to be called when a full press-drag-release gesture ends with this node as its source.final ObjectProperty<EventHandler<? super MouseDragEvent>> Defines a function to be called when a full press-drag-release gesture enters thisNode.final ObjectProperty<EventHandler<? super MouseDragEvent>> Defines a function to be called when a full press-drag-release gesture leaves thisNode.final ObjectProperty<EventHandler<? super MouseEvent>> Defines a function to be called when a mouse button is pressed on thisNodeand then dragged.final ObjectProperty<EventHandler<? super MouseDragEvent>> Defines a function to be called when a full press-drag-release gesture progresses within thisNode.final ObjectProperty<EventHandler<? super MouseDragEvent>> Defines a function to be called when a full press-drag-release gesture ends (by releasing mouse button) within thisNode.final ObjectProperty<EventHandler<? super MouseEvent>> Defines a function to be called when the mouse enters thisNode.final ObjectProperty<EventHandler<? super MouseEvent>> Defines a function to be called when the mouse exits thisNode.final ObjectProperty<EventHandler<? super MouseEvent>> Defines a function to be called when mouse cursor moves within thisNodebut no buttons have been pushed.final ObjectProperty<EventHandler<? super MouseEvent>> Defines a function to be called when a mouse button has been pressed on thisNode.final ObjectProperty<EventHandler<? super MouseEvent>> Defines a function to be called when a mouse button has been released on thisNode.final ObjectProperty<EventHandler<? super RotateEvent>> Defines a function to be called when user performs a rotation action.final ObjectProperty<EventHandler<? super RotateEvent>> Defines a function to be called when a rotation gesture ends.final ObjectProperty<EventHandler<? super RotateEvent>> Defines a function to be called when a rotation gesture is detected.final ObjectProperty<EventHandler<? super ScrollEvent>> Defines a function to be called when a scrolling gesture ends.final ObjectProperty<EventHandler<? super ScrollEvent>> Defines a function to be called when user performs a scrolling action.final ObjectProperty<EventHandler<? super ScrollEvent>> Defines a function to be called when a scrolling gesture is detected.final ObjectProperty<EventHandler<? super SwipeEvent>> Defines a function to be called when a downward swipe gesture centered over this node happens.final ObjectProperty<EventHandler<? super SwipeEvent>> Defines a function to be called when a leftward swipe gesture centered over this node happens.final ObjectProperty<EventHandler<? super SwipeEvent>> Defines a function to be called when an rightward swipe gesture centered over this node happens.final ObjectProperty<EventHandler<? super SwipeEvent>> Defines a function to be called when an upward swipe gesture centered over this node happens.final ObjectProperty<EventHandler<? super TouchEvent>> Defines a function to be called when a touch point is moved.final ObjectProperty<EventHandler<? super TouchEvent>> Defines a function to be called when a new touch point is pressed.final ObjectProperty<EventHandler<? super TouchEvent>> Defines a function to be called when a touch point is released.final ObjectProperty<EventHandler<? super TouchEvent>> Defines a function to be called when a touch point stays pressed and still.final ObjectProperty<EventHandler<? super ZoomEvent>> Defines a function to be called when a zooming gesture ends.final ObjectProperty<EventHandler<? super ZoomEvent>> Defines a function to be called when user performs a zooming action.final ObjectProperty<EventHandler<? super ZoomEvent>> Defines a function to be called when a zooming gesture is detected.final DoublePropertySpecifies how opaque (that is, solid) theNodeappears.final ReadOnlyObjectProperty<Parent> The parent of thisNode.final BooleanPropertyDefines how the picking computation is done for this node when triggered by aMouseEventor acontainsfunction call.final ReadOnlyBooleanPropertyWhether or not theNodeis pressed.final DoublePropertyDefines the angle of rotation about theNode's center, measured in degrees.final ObjectProperty<Point3D> Defines the axis of rotation of thisNode.final DoublePropertyDefines the factor by which coordinates are scaled about the center of the object along the X axis of thisNode.final DoublePropertyDefines the factor by which coordinates are scaled about the center of the object along the Y axis of thisNode.final DoublePropertyDefines the factor by which coordinates are scaled about the center of the object along the Z axis of thisNode.final ReadOnlyObjectProperty<Scene> TheScenethat thisNodeis part of.final StringPropertyA string representation of the CSS style associated with this specificNode.final DoublePropertyDefines the x coordinate of the translation that is added to thisNode's transform.final DoublePropertyDefines the y coordinate of the translation that is added to thisNode's transform.final DoublePropertyDefines the Z coordinate of the translation that is added to the transformed coordinates of thisNode.final DoublePropertyDefines the rendering and picking order of thisNodewithin its parent.final BooleanPropertySpecifies whether thisNodeand any subnodes should be rendered as part of the scene graph. -
Field Summary
Fields declared in class Region
USE_COMPUTED_SIZE, USE_PREF_SIZEModifier and TypeFieldDescriptionstatic final doubleSentinel value which can be passed to a region'ssetMinWidth,setMinHeight,setPrefWidth,setPrefHeight,setMaxWidth,setMaxHeightmethods to reset the region's size constraint back to it's intrinsic size returned bycomputeMinWidth,computeMinHeight,computePrefWidth,computePrefHeight,computeMaxWidth, orcomputeMaxHeight.static final doubleSentinel value which can be passed to a region'ssetMinWidth,setMinHeight,setMaxWidthorsetMaxHeightmethods to indicate that the preferred dimension should be used for that max and/or min constraint.Fields declared in class Node
BASELINE_OFFSET_SAME_AS_HEIGHTModifier and TypeFieldDescriptionstatic final doubleThis is a special value that might be returned byNode.getBaselineOffset(). -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedTextInputControl(TextInputControl.Content content) Creates a new TextInputControl. -
Method Summary
Modifier and TypeMethodDescriptionfinal ReadOnlyIntegerPropertyTheanchorof the text selection.voidappendText(String text) Appends a sequence of characters to the content.voidbackward()Moves the caret position backward.final voidIf the field is currently being edited, this call will set text to the last committed value.final ReadOnlyIntegerPropertyThe current position of the caret within the text.voidclear()Clears the text.final voidCommit the current text and convert it to a value.voidcopy()Transfers the currently selected range in the text to the clipboard, leaving the current selection.voidcut()Transfers the currently selected range in the text to the clipboard, removing the current selection.booleanDeletes the character that follows the current caret position from the text if there is no selection, or deletes the selection if there is one.booleanDeletes the character that precedes the current caret position from the text if there is no selection, or deletes the selection if there is one.voiddeleteText(int start, int end) Removes a range of characters from the content.voiddeleteText(IndexRange range) Removes a range of characters from the content.voiddeselect()Clears the selection.final BooleanPropertyIndicates whether this TextInputControl can be edited by the user.voidend()Moves the caret to after the last char of the text.voidMoves the caret to the end of the next word.voidextendSelection(int pos) This function will extend the selection to include the specified pos.final ObjectProperty<Font> The default font to use for text in the TextInputControl.voidforward()Moves the caret position forward.final intGets the value of theanchorproperty.final intGets the value of thecaretPositionproperty.static List<CssMetaData<? extends Styleable, ?>> Gets theCssMetaDataassociated with this class, which may include theCssMetaDataof its superclasses.protected final TextInputControl.ContentReturns the text input's content model.List<CssMetaData<? extends Styleable, ?>> Gets the unmodifiable list of the control's CSS-styleable properties.final FontgetFont()Gets the value of thefontproperty.final intGets the value of thelengthproperty.final StringGets the value of thepromptTextproperty.final StringGets the value of theselectedTextproperty.final IndexRangeGets the value of theselectionproperty.final StringgetText()Gets the value of thetextproperty.getText(int start, int end) Returns a subset of the text input's content.final TextFormatter<?> Gets the value of thetextFormatterproperty.voidhome()Moves the caret to before the first char of the text.voidinsertText(int index, String text) Inserts a sequence of characters into the content.final booleanGets the value of theeditableproperty.final booleanGets the value of theredoableproperty.final booleanGets the value of theundoableproperty.final ReadOnlyIntegerPropertyThe number of characters in the text input.voidnextWord()Moves the caret to the beginning of next word.voidpaste()Transfers the contents in the clipboard into this text, replacing the current selection.voidpositionCaret(int pos) Positions the caret to the position indicated bypos.voidMoves the caret to the beginning of previous word.final StringPropertyThe prompt text to display in theTextInputControl.final voidredo()If possible, redoes the last undone modification.final ReadOnlyBooleanPropertyThe property describes if it's currently possible to redo the latest change of the content that was undone.voidreplaceSelection(String replacement) Replaces the selection with the given replacement String.voidreplaceText(int start, int end, String text) Replaces a range of characters with the given text.voidreplaceText(IndexRange range, String text) Replaces a range of characters with the given text.voidSelects all text in the text input.voidMoves the selection backward one char in the text.final ReadOnlyStringPropertyDefines the characters in the TextInputControl which are selectedvoidMoves the caret to after the last char of text.voidMoves the caret to the end of the next word.voidMoves the selection forward one char in the text.voidMoves the caret to before the first char of text.final ReadOnlyObjectProperty<IndexRange> The current selection.voidMoves the caret to the beginning of next word.voidselectPositionCaret(int pos) Positions the caret to the position indicated byposand extends the selection, if there is one.voidMoves the caret to the beginning of previous word.voidselectRange(int anchor, int caretPosition) Positions the anchor and caretPosition explicitly.final voidsetEditable(boolean value) Sets the value of theeditableproperty.final voidSets the value of thefontproperty.final voidsetPromptText(String value) Sets the value of thepromptTextproperty.final voidSets the value of thetextproperty.final voidsetTextFormatter(TextFormatter<?> value) Sets the value of thetextFormatterproperty.final ObjectProperty<TextFormatter<?>> The property contains currently attachedTextFormatter.final StringPropertyThe textual content of this TextInputControl.final voidundo()If possible, undoes the last modification.final ReadOnlyBooleanPropertyThe property describes if it's currently possible to undo the latest change of the content that was done.Methods declared in class Control
computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, contextMenuProperty, createDefaultSkin, getContextMenu, getCssMetaData, getInitialFocusTraversable, getSkin, getTooltip, isResizable, setContextMenu, setSkin, setTooltip, skinProperty, tooltipPropertyModifier and TypeMethodDescriptionprotected doublecomputeMaxHeight(double width) Computes the maximum allowable height of the Control, based on the provided width.protected doublecomputeMaxWidth(double height) Computes the maximum allowable width of the Control, based on the provided height.protected doublecomputeMinHeight(double width) Computes the minimum allowable height of the Control, based on the provided width.protected doublecomputeMinWidth(double height) Computes the minimum allowable width of the Control, based on the provided height.final ObjectProperty<ContextMenu> The ContextMenu to show for this control.protected Skin<?> Create a new instance of the default skin for this control.final ContextMenuGets the value of thecontextMenuproperty.final List<CssMetaData<? extends Styleable, ?>> This method returns aListcontaining allCssMetaDatafor both this Control (returned fromControl.getControlCssMetaData()and itsSkin, assuming theskin propertyis aSkinBase.protected BooleanReturns the initial focus traversable state of this control, for use by the JavaFX CSS engine to correctly set its initial value.final Skin<?> getSkin()Gets the value of theskinproperty.final TooltipGets the value of thetooltipproperty.booleanReturnstruesince all Controls are resizable.final voidsetContextMenu(ContextMenu value) Sets the value of thecontextMenuproperty.final voidSets the value of theskinproperty.final voidsetTooltip(Tooltip value) Sets the value of thetooltipproperty.final ObjectProperty<Skin<?>> Skin is responsible for rendering thisControl.final ObjectProperty<Tooltip> The ToolTip for this control.Methods declared in class Region
backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, computePrefHeight, computePrefWidth, getBackground, getBorder, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefHeight, getPrefWidth, getShape, getUserAgentStylesheet, getWidth, heightProperty, insetsProperty, isCacheShape, isCenterShape, isScaleShape, isSnapToPixel, layoutInArea, layoutInArea, layoutInArea, layoutInArea, maxHeight, maxHeightProperty, maxWidth, maxWidthProperty, minHeight, minHeightProperty, minWidth, minWidthProperty, opaqueInsetsProperty, paddingProperty, positionInArea, positionInArea, prefHeight, prefHeightProperty, prefWidth, prefWidthProperty, resize, scaleShapeProperty, setBackground, setBorder, setCacheShape, setCenterShape, setHeight, setMaxHeight, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinWidth, setOpaqueInsets, setPadding, setPrefHeight, setPrefSize, setPrefWidth, setScaleShape, setShape, setSnapToPixel, setWidth, shapeProperty, snappedBottomInset, snappedLeftInset, snappedRightInset, snappedTopInset, snapPosition, snapPositionX, snapPositionY, snapSize, snapSizeX, snapSizeY, snapSpace, snapSpaceX, snapSpaceY, snapToPixelProperty, widthPropertyModifier and TypeMethodDescriptionfinal ObjectProperty<Background> The background of the Region, which is made up of zero or more BackgroundFills, and zero or more BackgroundImages.final ObjectProperty<Border> The border of the Region, which is made up of zero or more BorderStrokes, and zero or more BorderImages.final BooleanPropertyDefines a hint to the system indicating that the Shape used to define the region's background is stable and would benefit from caching.final BooleanPropertyDefines whether the shape is centered within theRegion's width and height.protected doublecomputePrefHeight(double width) Computes the preferred height of this region for the specified width.protected doublecomputePrefWidth(double height) Computes the preferred width of this region for the specified height.final BackgroundGets the value of thebackgroundproperty.final BorderGets the value of theborderproperty.final doubleGets the value of theheightproperty.final InsetsGets the value of theinsetsproperty.final doubleGets the value of themaxHeightproperty.final doubleGets the value of themaxWidthproperty.final doubleGets the value of theminHeightproperty.final doubleGets the value of theminWidthproperty.final InsetsGets the value of theopaqueInsetsproperty.final InsetsGets the value of thepaddingproperty.final doubleGets the value of theprefHeightproperty.final doubleGets the value of theprefWidthproperty.final ShapegetShape()Gets the value of theshapeproperty.An implementation may specify its own user-agent styles for this Region, and its children, by overriding this method.final doublegetWidth()Gets the value of thewidthproperty.final ReadOnlyDoublePropertyThe height of this resizable node.final ReadOnlyObjectProperty<Insets> The insets of the Region define the distance from the edge of the region (its layout bounds, or (0, 0, width, height)) to the edge of the content area.final booleanGets the value of thecacheShapeproperty.final booleanGets the value of thecenterShapeproperty.final booleanGets the value of thescaleShapeproperty.final booleanGets the value of thesnapToPixelproperty.protected voidlayoutInArea(Node child, double areaX, double areaY, double areaWidth, double areaHeight, double areaBaselineOffset, HPos halignment, VPos valignment) Utility method which lays out the child within an area of this region defined byareaX,areaY,areaWidthxareaHeight, with a baseline offset relative to that area.protected voidlayoutInArea(Node child, double areaX, double areaY, double areaWidth, double areaHeight, double areaBaselineOffset, Insets margin, boolean fillWidth, boolean fillHeight, HPos halignment, VPos valignment) Utility method which lays out the child within an area of this region defined byareaX,areaY,areaWidthxareaHeight, with a baseline offset relative to that area.static voidlayoutInArea(Node child, double areaX, double areaY, double areaWidth, double areaHeight, double areaBaselineOffset, Insets margin, boolean fillWidth, boolean fillHeight, HPos halignment, VPos valignment, boolean isSnapToPixel) Utility method which lays out the child within an area of it's parent defined byareaX,areaY,areaWidthxareaHeight, with a baseline offset relative to that area.protected voidlayoutInArea(Node child, double areaX, double areaY, double areaWidth, double areaHeight, double areaBaselineOffset, Insets margin, HPos halignment, VPos valignment) Utility method which lays out the child within an area of this region defined byareaX,areaY,areaWidthxareaHeight, with a baseline offset relative to that area.final doublemaxHeight(double width) Called during layout to determine the maximum height for this node.final DoublePropertyProperty for overriding the region's computed maximum height.final doublemaxWidth(double height) Called during layout to determine the maximum width for this node.final DoublePropertyProperty for overriding the region's computed maximum width.final doubleminHeight(double width) Called during layout to determine the minimum height for this node.final DoublePropertyProperty for overriding the region's computed minimum height.final doubleminWidth(double height) Called during layout to determine the minimum width for this node.final DoublePropertyProperty for overriding the region's computed minimum width.final ObjectProperty<Insets> Defines the area of the region within which completely opaque pixels are drawn.final ObjectProperty<Insets> The top, right, bottom, and left padding around the region's content.protected voidpositionInArea(Node child, double areaX, double areaY, double areaWidth, double areaHeight, double areaBaselineOffset, HPos halignment, VPos valignment) Utility method which positions the child within an area of this region defined byareaX,areaY,areaWidthxareaHeight, with a baseline offset relative to that area.static voidpositionInArea(Node child, double areaX, double areaY, double areaWidth, double areaHeight, double areaBaselineOffset, Insets margin, HPos halignment, VPos valignment, boolean isSnapToPixel) Utility method which positions the child within an area of this region defined byareaX,areaY,areaWidthxareaHeight, with a baseline offset relative to that area.final doubleprefHeight(double width) Called during layout to determine the preferred height for this node.final DoublePropertyProperty for overriding the region's computed preferred height.final doubleprefWidth(double height) Called during layout to determine the preferred width for this node.final DoublePropertyProperty for overriding the region's computed preferred width.voidresize(double width, double height) Invoked by the region's parent during layout to set the region's width and height.final BooleanPropertySpecifies whether the shape, if defined, is scaled to match the size of the Region.final voidsetBackground(Background value) Sets the value of thebackgroundproperty.final voidSets the value of theborderproperty.final voidsetCacheShape(boolean value) Sets the value of thecacheShapeproperty.final voidsetCenterShape(boolean value) Sets the value of thecenterShapeproperty.protected voidsetHeight(double value) Sets the value of theheightproperty.final voidsetMaxHeight(double value) Sets the value of themaxHeightproperty.voidsetMaxSize(double maxWidth, double maxHeight) Convenience method for overriding the region's computed maximum width and height.final voidsetMaxWidth(double value) Sets the value of themaxWidthproperty.final voidsetMinHeight(double value) Sets the value of theminHeightproperty.voidsetMinSize(double minWidth, double minHeight) Convenience method for overriding the region's computed minimum width and height.final voidsetMinWidth(double value) Sets the value of theminWidthproperty.final voidsetOpaqueInsets(Insets value) Sets the value of theopaqueInsetsproperty.final voidsetPadding(Insets value) Sets the value of thepaddingproperty.final voidsetPrefHeight(double value) Sets the value of theprefHeightproperty.voidsetPrefSize(double prefWidth, double prefHeight) Convenience method for overriding the region's computed preferred width and height.final voidsetPrefWidth(double value) Sets the value of theprefWidthproperty.final voidsetScaleShape(boolean value) Sets the value of thescaleShapeproperty.final voidSets the value of theshapeproperty.final voidsetSnapToPixel(boolean value) Sets the value of thesnapToPixelproperty.protected voidsetWidth(double value) Sets the value of thewidthproperty.final ObjectProperty<Shape> When specified, theShapewill cause the region to be rendered as the specified shape rather than as a rounded rectangle.final doubleUtility method to get the bottom inset which includes padding and border inset.final doubleUtility method to get the left inset which includes padding and border inset.final doubleUtility method to get the right inset which includes padding and border inset.final doubleUtility method to get the top inset which includes padding and border inset.protected doublesnapPosition(double value) Deprecated, for removal: This API element is subject to removal in a future version.doublesnapPositionX(double value) If this region's snapToPixel property is true, returns a value rounded to the nearest pixel in the horizontal direction, else returns the same value.doublesnapPositionY(double value) If this region's snapToPixel property is true, returns a value rounded to the nearest pixel in the vertical direction, else returns the same value.protected doublesnapSize(double value) Deprecated, for removal: This API element is subject to removal in a future version.replaced bysnapSizeX()andsnapSizeY()doublesnapSizeX(double value) If this region's snapToPixel property is true, returns a value ceiled to the nearest pixel in the horizontal direction, else returns the same value.doublesnapSizeY(double value) If this region's snapToPixel property is true, returns a value ceiled to the nearest pixel in the vertical direction, else returns the same value.protected doublesnapSpace(double value) Deprecated, for removal: This API element is subject to removal in a future version.replaced bysnapSpaceX()andsnapSpaceY()doublesnapSpaceX(double value) If this region's snapToPixel property is true, returns a value rounded to the nearest pixel in the horizontal direction, else returns the same value.doublesnapSpaceY(double value) If this region's snapToPixel property is true, returns a value rounded to the nearest pixel in the vertical direction, else returns the same value.final BooleanPropertyDefines whether this region adjusts position, spacing, and size values of its children to pixel boundaries.final ReadOnlyDoublePropertyThe width of this resizable node.Methods declared in class Parent
getBaselineOffset, getChildren, getChildrenUnmodifiable, getManagedChildren, getStylesheets, isNeedsLayout, layout, layoutChildren, needsLayoutProperty, requestLayout, requestParentLayout, setNeedsLayout, updateBoundsModifier and TypeMethodDescriptiondoubleCalculates the baseline offset based on the first managed child.protected ObservableList<Node> Gets the list of children of thisParent.Gets the list of children of thisParentas a read-only list.Gets the list of all managed children of thisParent.final ObservableList<String> Gets an observable list of string URLs linking to the stylesheets to use with this Parent's contents.final booleanGets the value of theneedsLayoutproperty.final voidlayout()Executes a top-down layout pass on the scene graph under this parent.protected voidInvoked byParent.layout()during a layout pass to position and resize the managed children.final ReadOnlyBooleanPropertyIndicates that this Node and its subnodes requires a layout pass on the next pulse.voidRequests a layout pass to be performed before the next scene is rendered.protected final voidRequests a layout pass of the parent to be performed before the next scene is rendered.protected final voidsetNeedsLayout(boolean value) Sets the value of theneedsLayoutproperty.protected voidUpdates the bounds of thisParentand its children.Methods declared in class Node
accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, addEventFilter, addEventHandler, applyCss, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, executeAccessibleAction, fireEvent, focusedProperty, focusTraversableProperty, focusVisibleProperty, focusWithinProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getContentBias, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInitialCursor, getInputMethodRequests, getLayoutBounds, getLayoutX, getLayoutY, getLocalToParentTransform, getLocalToSceneTransform, getNodeOrientation, getOnContextMenuRequested, getOnDragDetected, getOnDragDone, getOnDragDropped, getOnDragEntered, getOnDragExited, getOnDragOver, getOnInputMethodTextChanged, getOnKeyPressed, getOnKeyReleased, getOnKeyTyped, getOnMouseClicked, getOnMouseDragDone, 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, getPseudoClassStates, getRotate, getRotationAxis, getScaleX, getScaleY, getScaleZ, getScene, getStyle, getStyleableParent, getStyleClass, getTransforms, getTranslateX, getTranslateY, getTranslateZ, getTypeSelector, getUserData, getViewOrder, hasProperties, hoverProperty, idProperty, inputMethodRequestsProperty, intersects, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isFocusVisible, isFocusWithin, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isVisible, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, lookup, lookupAll, managedProperty, mouseTransparentProperty, nodeOrientationProperty, notifyAccessibleAttributeChanged, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragDoneProperty, 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, parentToLocal, parentToLocal, pickOnBoundsProperty, pressedProperty, pseudoClassStateChanged, queryAccessibleAttribute, relocate, removeEventFilter, removeEventHandler, requestFocus, requestFocusTraversal, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, screenToLocal, screenToLocal, screenToLocal, setAccessibleHelp, setAccessibleRole, setAccessibleRoleDescription, setAccessibleText, setBlendMode, setCache, setCacheHint, setClip, setCursor, setDepthTest, setDisable, setDisabled, setEffect, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, setId, setInputMethodRequests, setLayoutX, setLayoutY, setManaged, setMouseTransparent, setNodeOrientation, setOnContextMenuRequested, setOnDragDetected, setOnDragDone, setOnDragDropped, setOnDragEntered, setOnDragExited, setOnDragOver, setOnInputMethodTextChanged, setOnKeyPressed, setOnKeyReleased, setOnKeyTyped, setOnMouseClicked, setOnMouseDragDone, 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, setViewOrder, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, viewOrderProperty, visiblePropertyModifier and TypeMethodDescriptionfinal ObjectProperty<String> The accessible help text for thisNode.final ObjectProperty<String> The role description of thisNode.final ObjectProperty<AccessibleRole> The accessible role for thisNode.final ObjectProperty<String> The accessible text for thisNode.final <T extends Event>
voidaddEventFilter(EventType<T> eventType, EventHandler<? super T> eventFilter) Registers an event filter for this target.final <T extends Event>
voidaddEventHandler(EventType<T> eventType, EventHandler<? super T> eventHandler) Registers an event handler for this target.final voidapplyCss()If required, apply styles to this Node and its children, if any.final voidautosize()If the node is resizable, will set its layout bounds to its current preferred width and height.final ObjectProperty<BlendMode> TheBlendModeused to blend this individual node into the scene behind it.final ReadOnlyObjectProperty<Bounds> The rectangular bounds of thisNodein the node's untransformed local coordinate space.final ReadOnlyObjectProperty<Bounds> The rectangular bounds of thisNodein the parent coordinate system.Construct an event dispatch chain for this target.final ObjectProperty<CacheHint> Additional hint for controlling bitmap caching.final BooleanPropertyA performance hint to the system to indicate that thisNodeshould be cached as a bitmap.final ObjectProperty<Node> Specifies aNodeto use to define the clipping shape for this Node.doubleReturns the area of thisNodeprojected onto the physical screen in pixel units.booleancontains(double localX, double localY) Returnstrueif the given point (specified in the local coordinate space of thisNode) is contained within the shape of thisNode.booleanReturnstrueif the given point (specified in the local coordinate space of thisNode) is contained within the shape of thisNode.final ObjectProperty<Cursor> Defines the mouse cursor for thisNodeand subnodes.final ObjectProperty<DepthTest> Indicates whether depth testing is used when rendering this node.final ReadOnlyBooleanPropertyIndicates whether or not thisNodeis disabled.final BooleanPropertyDefines the individual disabled state of thisNode.The effective orientation of a node resolves the inheritance of node orientation, returning either left-to-right or right-to-left.final ObjectProperty<Effect> Specifies an effect to apply to thisNode.final ObjectProperty<EventDispatcher> Specifies the event dispatcher for this node.voidexecuteAccessibleAction(AccessibleAction action, Object... parameters) This method is called by the assistive technology to request the action indicated by the argument should be executed.final voidFires the specified event.final ReadOnlyBooleanPropertyIndicates whether thisNodecurrently has the input focus.final BooleanPropertySpecifies whether thisNodeshould be a part of focus traversal cycle.final ReadOnlyBooleanPropertyIndicates whether thisNodeshould visibly indicate focus.final ReadOnlyBooleanPropertyIndicates whether thisNodeor any of its descendants currently has the input focus.final StringGets the value of theaccessibleHelpproperty.final AccessibleRoleGets the value of theaccessibleRoleproperty.final StringGets the value of theaccessibleRoleDescriptionproperty.final StringGets the value of theaccessibleTextproperty.final BlendModeGets the value of theblendModeproperty.final BoundsGets the value of theboundsInLocalproperty.final BoundsGets the value of theboundsInParentproperty.final CacheHintGets the value of thecacheHintproperty.final NodegetClip()Gets the value of theclipproperty.Returns the orientation of a node's resizing bias for layout purposes.final CursorGets the value of thecursorproperty.final DepthTestGets the value of thedepthTestproperty.final EffectGets the value of theeffectproperty.final NodeOrientationGets the value of theeffectiveNodeOrientationproperty.final EventDispatcherGets the value of theeventDispatcherproperty.final StringgetId()The id of thisNode.protected CursorReturns the initial cursor state of this node, for use by the JavaFX CSS engine to correctly set its initial value.final InputMethodRequestsGets the value of theinputMethodRequestsproperty.final BoundsGets the value of thelayoutBoundsproperty.final doubleGets the value of thelayoutXproperty.final doubleGets the value of thelayoutYproperty.final TransformGets the value of thelocalToParentTransformproperty.final TransformGets the value of thelocalToSceneTransformproperty.final NodeOrientationGets the value of thenodeOrientationproperty.final EventHandler<? super ContextMenuEvent> Gets the value of theonContextMenuRequestedproperty.final EventHandler<? super MouseEvent> Gets the value of theonDragDetectedproperty.final EventHandler<? super DragEvent> Gets the value of theonDragDoneproperty.final EventHandler<? super DragEvent> Gets the value of theonDragDroppedproperty.final EventHandler<? super DragEvent> Gets the value of theonDragEnteredproperty.final EventHandler<? super DragEvent> Gets the value of theonDragExitedproperty.final EventHandler<? super DragEvent> Gets the value of theonDragOverproperty.final EventHandler<? super InputMethodEvent> Gets the value of theonInputMethodTextChangedproperty.final EventHandler<? super KeyEvent> Gets the value of theonKeyPressedproperty.final EventHandler<? super KeyEvent> Gets the value of theonKeyReleasedproperty.final EventHandler<? super KeyEvent> Gets the value of theonKeyTypedproperty.final EventHandler<? super MouseEvent> Gets the value of theonMouseClickedproperty.final EventHandler<? super MouseDragEvent> Gets the value of theonMouseDragDoneproperty.final EventHandler<? super MouseDragEvent> Gets the value of theonMouseDragEnteredproperty.final EventHandler<? super MouseDragEvent> Gets the value of theonMouseDragExitedproperty.final EventHandler<? super MouseEvent> Gets the value of theonMouseDraggedproperty.final EventHandler<? super MouseDragEvent> Gets the value of theonMouseDragOverproperty.final EventHandler<? super MouseDragEvent> Gets the value of theonMouseDragReleasedproperty.final EventHandler<? super MouseEvent> Gets the value of theonMouseEnteredproperty.final EventHandler<? super MouseEvent> Gets the value of theonMouseExitedproperty.final EventHandler<? super MouseEvent> Gets the value of theonMouseMovedproperty.final EventHandler<? super MouseEvent> Gets the value of theonMousePressedproperty.final EventHandler<? super MouseEvent> Gets the value of theonMouseReleasedproperty.final EventHandler<? super RotateEvent> Gets the value of theonRotateproperty.final EventHandler<? super RotateEvent> Gets the value of theonRotationFinishedproperty.final EventHandler<? super RotateEvent> Gets the value of theonRotationStartedproperty.final EventHandler<? super ScrollEvent> Gets the value of theonScrollproperty.final EventHandler<? super ScrollEvent> Gets the value of theonScrollFinishedproperty.final EventHandler<? super ScrollEvent> Gets the value of theonScrollStartedproperty.final EventHandler<? super SwipeEvent> Gets the value of theonSwipeDownproperty.final EventHandler<? super SwipeEvent> Gets the value of theonSwipeLeftproperty.final EventHandler<? super SwipeEvent> Gets the value of theonSwipeRightproperty.final EventHandler<? super SwipeEvent> Gets the value of theonSwipeUpproperty.final EventHandler<? super TouchEvent> Gets the value of theonTouchMovedproperty.final EventHandler<? super TouchEvent> Gets the value of theonTouchPressedproperty.final EventHandler<? super TouchEvent> Gets the value of theonTouchReleasedproperty.final EventHandler<? super TouchEvent> Gets the value of theonTouchStationaryproperty.final EventHandler<? super ZoomEvent> Gets the value of theonZoomproperty.final EventHandler<? super ZoomEvent> Gets the value of theonZoomFinishedproperty.final EventHandler<? super ZoomEvent> Gets the value of theonZoomStartedproperty.final doubleGets the value of theopacityproperty.final ParentGets the value of theparentproperty.final ObservableMap<Object, Object> Returns an observable map of properties on this node for use primarily by application developers.final ObservableSet<PseudoClass> Return the pseudo-class state of this Styleable.final doubleGets the value of therotateproperty.final Point3DGets the value of therotationAxisproperty.final doubleGets the value of thescaleXproperty.final doubleGets the value of thescaleYproperty.final doubleGets the value of thescaleZproperty.final ScenegetScene()Gets the value of thesceneproperty.final StringgetStyle()A string representation of the CSS style associated with this specificNode.Return the parent of this Styleable, or null if there is no parent.final ObservableList<String> A list of String identifiers which can be used to logically group Nodes, specifically for an external style engine.final ObservableList<Transform> final doubleGets the value of thetranslateXproperty.final doubleGets the value of thetranslateYproperty.final doubleGets the value of thetranslateZproperty.The type of thisStyleablethat is to be used in selector matching.Returns a previously set Object property, or null if no such property has been set using theNode.setUserData(java.lang.Object)method.final doubleGets the value of theviewOrderproperty.booleanTests if Node has properties.final ReadOnlyBooleanPropertyWhether or not thisNodeis being hovered over.final StringPropertyThe id of thisNode.Property holding InputMethodRequests.booleanintersects(double localX, double localY, double localWidth, double localHeight) Returnstrueif the given rectangle (specified in the local coordinate space of thisNode) intersects the shape of thisNode.booleanintersects(Bounds localBounds) Returnstrueif the given bounds (specified in the local coordinate space of thisNode) intersects the shape of thisNode.final booleanisCache()Gets the value of thecacheproperty.final booleanGets the value of thedisableproperty.final booleanGets the value of thedisabledproperty.final booleanGets the value of thefocusedproperty.final booleanGets the value of thefocusTraversableproperty.final booleanGets the value of thefocusVisibleproperty.final booleanGets the value of thefocusWithinproperty.final booleanisHover()Gets the value of thehoverproperty.final booleanGets the value of themanagedproperty.final booleanGets the value of themouseTransparentproperty.final booleanGets the value of thepickOnBoundsproperty.final booleanGets the value of thepressedproperty.final booleanGets the value of thevisibleproperty.final ReadOnlyObjectProperty<Bounds> The rectangular bounds that should be used for layout calculations for this node.final DoublePropertyDefines the x coordinate of the translation that is added to thisNode's transform for the purpose of layout.final DoublePropertyDefines the y coordinate of the translation that is added to thisNode's transform for the purpose of layout.localToParent(double localX, double localY) Transforms a point from the local coordinate space of thisNodeinto the coordinate space of its parent.localToParent(double x, double y, double z) Transforms a point from the local coordinate space of thisNodeinto the coordinate space of its parent.localToParent(Bounds localBounds) Transforms a bounds from the local coordinate space of thisNodeinto the coordinate space of its parent.localToParent(Point2D localPoint) Transforms a point from the local coordinate space of thisNodeinto the coordinate space of its parent.localToParent(Point3D localPoint) Transforms a point from the local coordinate space of thisNodeinto the coordinate space of its parent.final ReadOnlyObjectProperty<Transform> An affine transform that holds the computed local-to-parent transform.localToScene(double localX, double localY) Transforms a point from the local coordinate space of thisNodeinto the coordinate space of its scene.localToScene(double x, double y, boolean rootScene) Transforms a point from the local coordinate space of thisNodeinto the coordinate space of its scene.localToScene(double x, double y, double z) Transforms a point from the local coordinate space of thisNodeinto the coordinate space of its scene.localToScene(double x, double y, double z, boolean rootScene) Transforms a point from the local coordinate space of thisNodeinto the coordinate space of its scene.localToScene(Bounds localBounds) Transforms a bounds from the local coordinate space of thisNodeinto the coordinate space of its scene.localToScene(Bounds localBounds, boolean rootScene) Transforms a bounds from the local coordinate space of thisNodeinto the coordinate space of its scene.localToScene(Point2D localPoint) Transforms a point from the local coordinate space of thisNodeinto the coordinate space of its scene.localToScene(Point2D localPoint, boolean rootScene) Transforms a point from the local coordinate space of thisNodeinto the coordinate space of its scene.localToScene(Point3D localPoint) Transforms a point from the local coordinate space of thisNodeinto the coordinate space of its scene.localToScene(Point3D localPoint, boolean rootScene) Transforms a point from the local coordinate space of thisNodeinto the coordinate space of its scene.final ReadOnlyObjectProperty<Transform> An affine transform that holds the computed local-to-scene transform.localToScreen(double localX, double localY) Transforms a point from the local coordinate space of thisNodeinto the coordinate space of itsScreen.localToScreen(double localX, double localY, double localZ) Transforms a point from the local coordinate space of thisNodeinto the coordinate space of itsScreen.localToScreen(Bounds localBounds) Transforms a bounds from the local coordinate space of thisNodeinto the coordinate space of itsScreen.localToScreen(Point2D localPoint) Transforms a point from the local coordinate space of thisNodeinto the coordinate space of itsScreen.localToScreen(Point3D localPoint) Transforms a point from the local coordinate space of thisNodeinto the coordinate space of itsScreen.Finds thisNode, or the first sub-node, based on the given CSS selector.Finds allNodes, including this one and any children, which match the given CSS selector.final BooleanPropertyDefines whether or not this node's layout will be managed by its parent.final BooleanPropertyIftrue, this node (together with all its children) is completely transparent to mouse events.final ObjectProperty<NodeOrientation> Node orientation describes the flow of visual data within a node.final voidnotifyAccessibleAttributeChanged(AccessibleAttribute attributes) This method is called by the application to notify the assistive technology that the value for an attribute has changed.final ObjectProperty<EventHandler<? super ContextMenuEvent>> Defines a function to be called when a context menu has been requested on thisNode.final ObjectProperty<EventHandler<? super MouseEvent>> Defines a function to be called when drag gesture has been detected.final ObjectProperty<EventHandler<? super DragEvent>> Defines a function to be called when thisNodeis a drag and drop gesture source after its data has been dropped on a drop target.final ObjectProperty<EventHandler<? super DragEvent>> Defines a function to be called when the mouse button is released on thisNodeduring drag and drop gesture.final ObjectProperty<EventHandler<? super DragEvent>> Defines a function to be called when drag gesture enters thisNode.final ObjectProperty<EventHandler<? super DragEvent>> Defines a function to be called when drag gesture exits thisNode.final ObjectProperty<EventHandler<? super DragEvent>> Defines a function to be called when drag gesture progresses within thisNode.final ObjectProperty<EventHandler<? super InputMethodEvent>> Defines a function to be called when thisNodehas input focus and the input method text has changed.final ObjectProperty<EventHandler<? super KeyEvent>> Defines a function to be called when thisNodeor its childNodehas input focus and a key has been pressed.final ObjectProperty<EventHandler<? super KeyEvent>> Defines a function to be called when thisNodeor its childNodehas input focus and a key has been released.final ObjectProperty<EventHandler<? super KeyEvent>> Defines a function to be called when thisNodeor its childNodehas input focus and a key has been typed.final ObjectProperty<EventHandler<? super MouseEvent>> Defines a function to be called when a mouse button has been clicked (pressed and released) on thisNode.final ObjectProperty<EventHandler<? super MouseDragEvent>> Defines a function to be called when a full press-drag-release gesture ends with this node as its source.final ObjectProperty<EventHandler<? super MouseDragEvent>> Defines a function to be called when a full press-drag-release gesture enters thisNode.final ObjectProperty<EventHandler<? super MouseDragEvent>> Defines a function to be called when a full press-drag-release gesture leaves thisNode.final ObjectProperty<EventHandler<? super MouseEvent>> Defines a function to be called when a mouse button is pressed on thisNodeand then dragged.final ObjectProperty<EventHandler<? super MouseDragEvent>> Defines a function to be called when a full press-drag-release gesture progresses within thisNode.final ObjectProperty<EventHandler<? super MouseDragEvent>> Defines a function to be called when a full press-drag-release gesture ends (by releasing mouse button) within thisNode.final ObjectProperty<EventHandler<? super MouseEvent>> Defines a function to be called when the mouse enters thisNode.final ObjectProperty<EventHandler<? super MouseEvent>> Defines a function to be called when the mouse exits thisNode.final ObjectProperty<EventHandler<? super MouseEvent>> Defines a function to be called when mouse cursor moves within thisNodebut no buttons have been pushed.final ObjectProperty<EventHandler<? super MouseEvent>> Defines a function to be called when a mouse button has been pressed on thisNode.final ObjectProperty<EventHandler<? super MouseEvent>> Defines a function to be called when a mouse button has been released on thisNode.final ObjectProperty<EventHandler<? super RotateEvent>> Defines a function to be called when user performs a rotation action.final ObjectProperty<EventHandler<? super RotateEvent>> Defines a function to be called when a rotation gesture ends.final ObjectProperty<EventHandler<? super RotateEvent>> Defines a function to be called when a rotation gesture is detected.final ObjectProperty<EventHandler<? super ScrollEvent>> Defines a function to be called when a scrolling gesture ends.final ObjectProperty<EventHandler<? super ScrollEvent>> Defines a function to be called when user performs a scrolling action.final ObjectProperty<EventHandler<? super ScrollEvent>> Defines a function to be called when a scrolling gesture is detected.final ObjectProperty<EventHandler<? super SwipeEvent>> Defines a function to be called when a downward swipe gesture centered over this node happens.final ObjectProperty<EventHandler<? super SwipeEvent>> Defines a function to be called when a leftward swipe gesture centered over this node happens.final ObjectProperty<EventHandler<? super SwipeEvent>> Defines a function to be called when an rightward swipe gesture centered over this node happens.final ObjectProperty<EventHandler<? super SwipeEvent>> Defines a function to be called when an upward swipe gesture centered over this node happens.final ObjectProperty<EventHandler<? super TouchEvent>> Defines a function to be called when a touch point is moved.final ObjectProperty<EventHandler<? super TouchEvent>> Defines a function to be called when a new touch point is pressed.final ObjectProperty<EventHandler<? super TouchEvent>> Defines a function to be called when a touch point is released.final ObjectProperty<EventHandler<? super TouchEvent>> Defines a function to be called when a touch point stays pressed and still.final ObjectProperty<EventHandler<? super ZoomEvent>> Defines a function to be called when a zooming gesture ends.final ObjectProperty<EventHandler<? super ZoomEvent>> Defines a function to be called when user performs a zooming action.final ObjectProperty<EventHandler<? super ZoomEvent>> Defines a function to be called when a zooming gesture is detected.final DoublePropertySpecifies how opaque (that is, solid) theNodeappears.final ReadOnlyObjectProperty<Parent> The parent of thisNode.parentToLocal(double parentX, double parentY) Transforms a point from the coordinate space of the parent into the local coordinate space of thisNode.parentToLocal(double parentX, double parentY, double parentZ) Transforms a point from the coordinate space of the parent into the local coordinate space of thisNode.parentToLocal(Bounds parentBounds) Transforms a rectangle from the coordinate space of the parent into the local coordinate space of thisNode.parentToLocal(Point2D parentPoint) Transforms a point from the coordinate space of the parent into the local coordinate space of thisNode.parentToLocal(Point3D parentPoint) Transforms a point from the coordinate space of the parent into the local coordinate space of thisNode.final BooleanPropertyDefines how the picking computation is done for this node when triggered by aMouseEventor acontainsfunction call.final ReadOnlyBooleanPropertyWhether or not theNodeis pressed.final voidpseudoClassStateChanged(PseudoClass pseudoClass, boolean active) Used to specify that a pseudo-class of this Node has changed.queryAccessibleAttribute(AccessibleAttribute attribute, Object... parameters) This method is called by the assistive technology to request the value for an attribute.voidrelocate(double x, double y) Sets the node's layoutX and layoutY translation properties in order to relocate this node to the x,y location in the parent.final <T extends Event>
voidremoveEventFilter(EventType<T> eventType, EventHandler<? super T> eventFilter) Unregisters a previously registered event filter from this target.final <T extends Event>
voidremoveEventHandler(EventType<T> eventType, EventHandler<? super T> eventHandler) Unregisters a previously registered event handler from this target.voidRequests that thisNodeget the input focus, and that thisNode's top-level ancestor become the focused window.final booleanrequestFocusTraversal(TraversalDirection direction) Requests to move the focus from thisNodein the specified direction.voidresizeRelocate(double x, double y, double width, double height) If the node is resizable, will set its layout bounds to the specified width and height.final DoublePropertyDefines the angle of rotation about theNode's center, measured in degrees.final ObjectProperty<Point3D> Defines the axis of rotation of thisNode.final DoublePropertyDefines the factor by which coordinates are scaled about the center of the object along the X axis of thisNode.final DoublePropertyDefines the factor by which coordinates are scaled about the center of the object along the Y axis of thisNode.final DoublePropertyDefines the factor by which coordinates are scaled about the center of the object along the Z axis of thisNode.final ReadOnlyObjectProperty<Scene> TheScenethat thisNodeis part of.sceneToLocal(double sceneX, double sceneY) Transforms a point from the coordinate space of the scene into the local coordinate space of thisNode.sceneToLocal(double x, double y, boolean rootScene) Transforms a point from the coordinate space of the scene into the local coordinate space of thisNode.sceneToLocal(double sceneX, double sceneY, double sceneZ) Transforms a point from the coordinate space of the scene into the local coordinate space of thisNode.sceneToLocal(Bounds sceneBounds) Transforms a rectangle from the coordinate space of the scene into the local coordinate space of thisNode.sceneToLocal(Bounds bounds, boolean rootScene) Transforms a bounds from the coordinate space of the scene into the local coordinate space of thisNode.sceneToLocal(Point2D scenePoint) Transforms a point from the coordinate space of the scene into the local coordinate space of thisNode.sceneToLocal(Point2D point, boolean rootScene) Transforms a point from the coordinate space of the scene into the local coordinate space of thisNode.sceneToLocal(Point3D scenePoint) Transforms a point from the coordinate space of the scene into the local coordinate space of thisNode.screenToLocal(double screenX, double screenY) Transforms a point from the coordinate space of theScreeninto the local coordinate space of thisNode.screenToLocal(Bounds screenBounds) Transforms a rectangle from the coordinate space of theScreeninto the local coordinate space of thisNode.screenToLocal(Point2D screenPoint) Transforms a point from the coordinate space of theScreeninto the local coordinate space of thisNode.final voidsetAccessibleHelp(String value) Sets the value of theaccessibleHelpproperty.final voidsetAccessibleRole(AccessibleRole value) Sets the value of theaccessibleRoleproperty.final voidSets the value of theaccessibleRoleDescriptionproperty.final voidsetAccessibleText(String value) Sets the value of theaccessibleTextproperty.final voidsetBlendMode(BlendMode value) Sets the value of theblendModeproperty.final voidsetCache(boolean value) Sets the value of thecacheproperty.final voidsetCacheHint(CacheHint value) Sets the value of thecacheHintproperty.final voidSets the value of theclipproperty.final voidSets the value of thecursorproperty.final voidsetDepthTest(DepthTest value) Sets the value of thedepthTestproperty.final voidsetDisable(boolean value) Sets the value of thedisableproperty.protected final voidsetDisabled(boolean value) Sets the value of thedisabledproperty.final voidSets the value of theeffectproperty.final voidSets the value of theeventDispatcherproperty.protected final <T extends Event>
voidsetEventHandler(EventType<T> eventType, EventHandler<? super T> eventHandler) Sets the handler to use for this event type.protected final voidsetFocused(boolean value) Sets the value of thefocusedproperty.final voidsetFocusTraversable(boolean value) Sets the value of thefocusTraversableproperty.protected final voidsetHover(boolean value) Sets the value of thehoverproperty.final voidSets the value of theidproperty.final voidSets the value of theinputMethodRequestsproperty.final voidsetLayoutX(double value) Sets the value of thelayoutXproperty.final voidsetLayoutY(double value) Sets the value of thelayoutYproperty.final voidsetManaged(boolean value) Sets the value of themanagedproperty.final voidsetMouseTransparent(boolean value) Sets the value of themouseTransparentproperty.final voidsetNodeOrientation(NodeOrientation orientation) Sets the value of thenodeOrientationproperty.final voidsetOnContextMenuRequested(EventHandler<? super ContextMenuEvent> value) Sets the value of theonContextMenuRequestedproperty.final voidsetOnDragDetected(EventHandler<? super MouseEvent> value) Sets the value of theonDragDetectedproperty.final voidsetOnDragDone(EventHandler<? super DragEvent> value) Sets the value of theonDragDoneproperty.final voidsetOnDragDropped(EventHandler<? super DragEvent> value) Sets the value of theonDragDroppedproperty.final voidsetOnDragEntered(EventHandler<? super DragEvent> value) Sets the value of theonDragEnteredproperty.final voidsetOnDragExited(EventHandler<? super DragEvent> value) Sets the value of theonDragExitedproperty.final voidsetOnDragOver(EventHandler<? super DragEvent> value) Sets the value of theonDragOverproperty.final voidsetOnInputMethodTextChanged(EventHandler<? super InputMethodEvent> value) Sets the value of theonInputMethodTextChangedproperty.final voidsetOnKeyPressed(EventHandler<? super KeyEvent> value) Sets the value of theonKeyPressedproperty.final voidsetOnKeyReleased(EventHandler<? super KeyEvent> value) Sets the value of theonKeyReleasedproperty.final voidsetOnKeyTyped(EventHandler<? super KeyEvent> value) Sets the value of theonKeyTypedproperty.final voidsetOnMouseClicked(EventHandler<? super MouseEvent> value) Sets the value of theonMouseClickedproperty.final voidsetOnMouseDragDone(EventHandler<? super MouseDragEvent> value) Sets the value of theonMouseDragDoneproperty.final voidsetOnMouseDragEntered(EventHandler<? super MouseDragEvent> value) Sets the value of theonMouseDragEnteredproperty.final voidsetOnMouseDragExited(EventHandler<? super MouseDragEvent> value) Sets the value of theonMouseDragExitedproperty.final voidsetOnMouseDragged(EventHandler<? super MouseEvent> value) Sets the value of theonMouseDraggedproperty.final voidsetOnMouseDragOver(EventHandler<? super MouseDragEvent> value) Sets the value of theonMouseDragOverproperty.final voidsetOnMouseDragReleased(EventHandler<? super MouseDragEvent> value) Sets the value of theonMouseDragReleasedproperty.final voidsetOnMouseEntered(EventHandler<? super MouseEvent> value) Sets the value of theonMouseEnteredproperty.final voidsetOnMouseExited(EventHandler<? super MouseEvent> value) Sets the value of theonMouseExitedproperty.final voidsetOnMouseMoved(EventHandler<? super MouseEvent> value) Sets the value of theonMouseMovedproperty.final voidsetOnMousePressed(EventHandler<? super MouseEvent> value) Sets the value of theonMousePressedproperty.final voidsetOnMouseReleased(EventHandler<? super MouseEvent> value) Sets the value of theonMouseReleasedproperty.final voidsetOnRotate(EventHandler<? super RotateEvent> value) Sets the value of theonRotateproperty.final voidsetOnRotationFinished(EventHandler<? super RotateEvent> value) Sets the value of theonRotationFinishedproperty.final voidsetOnRotationStarted(EventHandler<? super RotateEvent> value) Sets the value of theonRotationStartedproperty.final voidsetOnScroll(EventHandler<? super ScrollEvent> value) Sets the value of theonScrollproperty.final voidsetOnScrollFinished(EventHandler<? super ScrollEvent> value) Sets the value of theonScrollFinishedproperty.final voidsetOnScrollStarted(EventHandler<? super ScrollEvent> value) Sets the value of theonScrollStartedproperty.final voidsetOnSwipeDown(EventHandler<? super SwipeEvent> value) Sets the value of theonSwipeDownproperty.final voidsetOnSwipeLeft(EventHandler<? super SwipeEvent> value) Sets the value of theonSwipeLeftproperty.final voidsetOnSwipeRight(EventHandler<? super SwipeEvent> value) Sets the value of theonSwipeRightproperty.final voidsetOnSwipeUp(EventHandler<? super SwipeEvent> value) Sets the value of theonSwipeUpproperty.final voidsetOnTouchMoved(EventHandler<? super TouchEvent> value) Sets the value of theonTouchMovedproperty.final voidsetOnTouchPressed(EventHandler<? super TouchEvent> value) Sets the value of theonTouchPressedproperty.final voidsetOnTouchReleased(EventHandler<? super TouchEvent> value) Sets the value of theonTouchReleasedproperty.final voidsetOnTouchStationary(EventHandler<? super TouchEvent> value) Sets the value of theonTouchStationaryproperty.final voidsetOnZoom(EventHandler<? super ZoomEvent> value) Sets the value of theonZoomproperty.final voidsetOnZoomFinished(EventHandler<? super ZoomEvent> value) Sets the value of theonZoomFinishedproperty.final voidsetOnZoomStarted(EventHandler<? super ZoomEvent> value) Sets the value of theonZoomStartedproperty.final voidsetOpacity(double value) Sets the value of theopacityproperty.final voidsetPickOnBounds(boolean value) Sets the value of thepickOnBoundsproperty.protected final voidsetPressed(boolean value) Sets the value of thepressedproperty.final voidsetRotate(double value) Sets the value of therotateproperty.final voidsetRotationAxis(Point3D value) Sets the value of therotationAxisproperty.final voidsetScaleX(double value) Sets the value of thescaleXproperty.final voidsetScaleY(double value) Sets the value of thescaleYproperty.final voidsetScaleZ(double value) Sets the value of thescaleZproperty.final voidA string representation of the CSS style associated with this specificNode.final voidsetTranslateX(double value) Sets the value of thetranslateXproperty.final voidsetTranslateY(double value) Sets the value of thetranslateYproperty.final voidsetTranslateZ(double value) Sets the value of thetranslateZproperty.voidsetUserData(Object value) Convenience method for setting a single Object property that can be retrieved at a later date.final voidsetViewOrder(double value) Sets the value of theviewOrderproperty.final voidsetVisible(boolean value) Sets the value of thevisibleproperty.snapshot(SnapshotParameters params, WritableImage image) Takes a snapshot of this node and returns the rendered image when it is ready.voidsnapshot(Callback<SnapshotResult, Void> callback, SnapshotParameters params, WritableImage image) Takes a snapshot of this node at the next frame and calls the specified callback method when the image is ready.startDragAndDrop(TransferMode... transferModes) Confirms a potential drag and drop gesture that is recognized over thisNode.voidStarts a full press-drag-release gesture with this node as gesture source.final StringPropertyA string representation of the CSS style associated with this specificNode.voidtoBack()Moves thisNodeto the back of its sibling nodes in terms of z-order.voidtoFront()Moves thisNodeto the front of its sibling nodes in terms of z-order.toString()Returns a string representation for the object.final DoublePropertyDefines the x coordinate of the translation that is added to thisNode's transform.final DoublePropertyDefines the y coordinate of the translation that is added to thisNode's transform.final DoublePropertyDefines the Z coordinate of the translation that is added to the transformed coordinates of thisNode.booleanDetermines whether a node should be mirrored when node orientation is right-to-left.final DoublePropertyDefines the rendering and picking order of thisNodewithin its parent.final BooleanPropertySpecifies whether thisNodeand any subnodes should be rendered as part of the scene graph.Methods declared in class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods declared in interface Styleable
getStyleableNodeModifier and TypeMethodDescriptiondefault NodeReturns the Node that represents this Styleable object.
-
Property Details
-
font
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:
-
promptText
The prompt text to display in theTextInputControl. If set to null or an empty string, no prompt text is displayed.- Default value:
- An empty String
- Since:
- JavaFX 2.2
- See Also:
-
textFormatter
The property contains currently attachedTextFormatter. Since the value is part of theFormatter, changing the TextFormatter will update the text based on the new textFormatter.- Default value:
- null
- Since:
- JavaFX 8u40
- See Also:
-
text
-
length
The number of characters in the text input.- See Also:
-
editable
Indicates whether this TextInputControl can be edited by the user.- See Also:
-
selection
-
selectedText
Defines the characters in the TextInputControl which are selected- See Also:
-
anchor
Theanchorof the text selection. TheanchorandcaretPositionmake up the selection range. Selection must always be specified in terms of begin <= end, butanchormay be less than, equal to, or greater than thecaretPosition. Depending on how the user selects text, the anchor might represent the lower or upper bound of the selection.- See Also:
-
caretPosition
The current position of the caret within the text. TheanchorandcaretPositionmake up the selection range. Selection must always be specified in terms of begin <= end, butanchormay be less than, equal to, or greater than thecaretPosition. Depending on how the user selects text, the caretPosition might represent the lower or upper bound of the selection.- See Also:
-
undoable
The property describes if it's currently possible to undo the latest change of the content that was done.- Default value:
- false
- Since:
- JavaFX 8u40
- See Also:
-
redoable
The property describes if it's currently possible to redo the latest change of the content that was undone.- Default value:
- false
- Since:
- JavaFX 8u40
- See Also:
-
-
Constructor Details
-
TextInputControl
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 Details
-
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.- Returns:
- the font property
- Since:
- JavaFX 8.0
- See Also:
-
setFont
Sets the value of thefontproperty.- Property description:
- 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.
- Parameters:
value- the value for thefontproperty- Since:
- JavaFX 8.0
- See Also:
-
getFont
Gets the value of thefontproperty.- Property description:
- 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.
- Returns:
- the value of the
fontproperty - Since:
- JavaFX 8.0
- See Also:
-
promptTextProperty
The prompt text to display in theTextInputControl. If set to null or an empty string, no prompt text is displayed.- Default value:
- An empty String
- Returns:
- the
promptTextproperty - Since:
- JavaFX 2.2
- See Also:
-
getPromptText
Gets the value of thepromptTextproperty.- Property description:
- The prompt text to display in the
TextInputControl. If set to null or an empty string, no prompt text is displayed. - Default value:
- An empty String
- Returns:
- the value of the
promptTextproperty - Since:
- JavaFX 2.2
- See Also:
-
setPromptText
Sets the value of thepromptTextproperty.- Property description:
- The prompt text to display in the
TextInputControl. If set to null or an empty string, no prompt text is displayed. - Default value:
- An empty String
- Parameters:
value- the value for thepromptTextproperty- Since:
- JavaFX 2.2
- See Also:
-
textFormatterProperty
The property contains currently attachedTextFormatter. Since the value is part of theFormatter, changing the TextFormatter will update the text based on the new textFormatter.- Default value:
- null
- Returns:
- the
textFormatterproperty - Since:
- JavaFX 8u40
- See Also:
-
getTextFormatter
Gets the value of thetextFormatterproperty.- Property description:
- The property contains currently attached
TextFormatter. Since the value is part of theFormatter, changing the TextFormatter will update the text based on the new textFormatter. - Default value:
- null
- Returns:
- the value of the
textFormatterproperty - Since:
- JavaFX 8u40
- See Also:
-
setTextFormatter
Sets the value of thetextFormatterproperty.- Property description:
- The property contains currently attached
TextFormatter. Since the value is part of theFormatter, changing the TextFormatter will update the text based on the new textFormatter. - Default value:
- null
- Parameters:
value- the value for thetextFormatterproperty- Since:
- JavaFX 8u40
- See Also:
-
getContent
Returns the text input's content model.- Returns:
- the text input's content model
-
getText
Gets the value of thetextproperty.- Property description:
- The textual content of this TextInputControl.
- Returns:
- the value of the
textproperty - See Also:
-
setText
Sets the value of thetextproperty.- Property description:
- The textual content of this TextInputControl.
- Parameters:
value- the value for thetextproperty- See Also:
-
textProperty
The textual content of this TextInputControl.- Returns:
- the
textproperty - See Also:
-
getLength
public final int getLength()Gets the value of thelengthproperty.- Property description:
- The number of characters in the text input.
- Returns:
- the value of the
lengthproperty - See Also:
-
lengthProperty
The number of characters in the text input.- Returns:
- the
lengthproperty - See Also:
-
isEditable
public final boolean isEditable()Gets the value of theeditableproperty.- Property description:
- Indicates whether this TextInputControl can be edited by the user.
- Returns:
- the value of the
editableproperty - See Also:
-
setEditable
public final void setEditable(boolean value) Sets the value of theeditableproperty.- Property description:
- Indicates whether this TextInputControl can be edited by the user.
- Parameters:
value- the value for theeditableproperty- See Also:
-
editableProperty
Indicates whether this TextInputControl can be edited by the user.- Returns:
- the
editableproperty - See Also:
-
getSelection
Gets the value of theselectionproperty.- Property description:
- The current selection.
- Returns:
- the value of the
selectionproperty - See Also:
-
selectionProperty
The current selection.- Returns:
- the
selectionproperty - See Also:
-
getSelectedText
Gets the value of theselectedTextproperty.- Property description:
- Defines the characters in the TextInputControl which are selected
- Returns:
- the value of the
selectedTextproperty - See Also:
-
selectedTextProperty
Defines the characters in the TextInputControl which are selected- Returns:
- the
selectedTextproperty - See Also:
-
getAnchor
public final int getAnchor()Gets the value of theanchorproperty.- Property description:
- The
anchorof the text selection. TheanchorandcaretPositionmake up the selection range. Selection must always be specified in terms of begin <= end, butanchormay be less than, equal to, or greater than thecaretPosition. Depending on how the user selects text, the anchor might represent the lower or upper bound of the selection. - Returns:
- the value of the
anchorproperty - See Also:
-
anchorProperty
Theanchorof the text selection. TheanchorandcaretPositionmake up the selection range. Selection must always be specified in terms of begin <= end, butanchormay be less than, equal to, or greater than thecaretPosition. Depending on how the user selects text, the anchor might represent the lower or upper bound of the selection.- Returns:
- the
anchorproperty - See Also:
-
getCaretPosition
public final int getCaretPosition()Gets the value of thecaretPositionproperty.- Property description:
- The current position of the caret within the text.
The
anchorandcaretPositionmake up the selection range. Selection must always be specified in terms of begin <= end, butanchormay be less than, equal to, or greater than thecaretPosition. Depending on how the user selects text, the caretPosition might represent the lower or upper bound of the selection. - Returns:
- the value of the
caretPositionproperty - See Also:
-
caretPositionProperty
The current position of the caret within the text. TheanchorandcaretPositionmake up the selection range. Selection must always be specified in terms of begin <= end, butanchormay be less than, equal to, or greater than thecaretPosition. Depending on how the user selects text, the caretPosition might represent the lower or upper bound of the selection.- Returns:
- the
caretPositionproperty - See Also:
-
isUndoable
public final boolean isUndoable()Gets the value of theundoableproperty.- Property description:
- The property describes if it's currently possible to undo the latest change of the content that was done.
- Default value:
- false
- Returns:
- the value of the
undoableproperty - Since:
- JavaFX 8u40
- See Also:
-
undoableProperty
The property describes if it's currently possible to undo the latest change of the content that was done.- Default value:
- false
- Returns:
- the
undoableproperty - Since:
- JavaFX 8u40
- See Also:
-
isRedoable
public final boolean isRedoable()Gets the value of theredoableproperty.- Property description:
- The property describes if it's currently possible to redo the latest change of the content that was undone.
- Default value:
- false
- Returns:
- the value of the
redoableproperty - Since:
- JavaFX 8u40
- See Also:
-
redoableProperty
The property describes if it's currently possible to redo the latest change of the content that was undone.- Default value:
- false
- Returns:
- the
redoableproperty - Since:
- JavaFX 8u40
- See Also:
-
getText
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
Appends a sequence of characters to the content.- Parameters:
text- a non null String
-
insertText
Inserts a sequence of characters into the content.- Parameters:
index- The location to insert the text.text- The text to insert.
-
deleteText
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
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
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
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.
-
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.- 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 bypos. This function will also clear the selection.- Parameters:
pos- the position
-
selectPositionCaret
public void selectPositionCaret(int pos) Positions the caret to the position indicated byposand 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 anchorcaretPosition- the 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
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. IfisUndoable()returns false, then calling this method has no effect.- Since:
- JavaFX 8u40
-
redo
public final void redo()If possible, redoes the last undone modification. IfisRedoable()returns false, then calling this method has no effect.- Since:
- JavaFX 8u40
-
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 committed value.- Since:
- JavaFX 8u40
-
getClassCssMetaData
Gets theCssMetaDataassociated with this class, which may include theCssMetaDataof its superclasses.- Returns:
- the
CssMetaData - Since:
- JavaFX 8.0
-
getControlCssMetaData
Gets the unmodifiable list of the control's CSS-styleable properties.- Overrides:
getControlCssMetaDatain classControl- Returns:
- the unmodifiable list of the control's CSS-styleable properties
- Since:
- JavaFX 8.0
-
snapPositionX()andsnapPositionY()