Class Text

java.lang.Object

javafx.scene.Node

javafx.scene.shape.Shape

javafx.scene.text.Text

All Implemented Interfaces:

Styleable, EventTarget

@DefaultProperty("text")
public non-sealed class Text
extends Shape

The Text class defines a node that displays a text. Paragraphs are separated by '\n' and the text is wrapped on paragraph boundaries.

import javafx.scene.text.*;

Text t = new Text(10, 50, "This is a test");
t.setFont(new Font(20));

import javafx.scene.text.*;

Text t = new Text();
text.setFont(new Font(20));
text.setText("First row\nSecond row");

import javafx.scene.text.*;

Text t = new Text();
text.setFont(new Font(20));
text.setWrappingWidth(200);
text.setTextAlignment(TextAlignment.JUSTIFY)
text.setText("The quick brown fox jumps over the lazy dog");

Since:

JavaFX 2.0

Property Summary

Properties

Type	Property	Description
final ReadOnlyDoubleProperty	baselineOffset	The 'alphabetic' (or roman) baseline offset from the Text node's layoutBounds.minY location.
final ObjectProperty<TextBoundsType>	boundsType	Determines how the bounds of the text node are calculated.
final BooleanProperty	caretBias	The type of caret bias in the content.
final IntegerProperty	caretPosition	The caret index in the content.
final ReadOnlyObjectProperty<PathElement[]>	caretShape	The shape of caret, in local coordinates.
final ObjectProperty<Font>	font	Defines the font of text.
final ObjectProperty<FontSmoothingType>	fontSmoothingType	Specifies a requested font smoothing type: gray or LCD.
final DoubleProperty	lineSpacing	Defines the vertical space in pixel between lines.
final IntegerProperty	selectionEnd	The end index of the selection in the content.
final ObjectProperty<Paint>	selectionFill	The fill color of selected text.
final ReadOnlyObjectProperty<PathElement[]>	selectionShape	The shape of the selection in local coordinates.
final IntegerProperty	selectionStart	The start index of the selection in the content.
final BooleanProperty	strikethrough	Defines if each line of text should have a line through it.
final IntegerProperty	tabSize	The size of a tab stop in spaces.
final ObjectProperty<TextAlignment>	textAlignment	Defines horizontal text alignment in the bounding box.
final ObjectProperty<VPos>	textOrigin	Defines the origin of text coordinate system in local coordinates.
final StringProperty	text	Defines text string that is to be displayed.
final BooleanProperty	underline	Defines if each line of text should have a line below it.
final DoubleProperty	wrappingWidth	Defines a width constraint for the text in user space coordinates.
final DoubleProperty	x	Defines the X coordinate of text origin.
final DoubleProperty	y	Defines the Y coordinate of text origin.

Properties declared in class Shape

fill, smooth, strokeDashOffset, strokeLineCap, strokeLineJoin, strokeMiterLimit, stroke, strokeType, strokeWidth

Type	Property	Description
final ObjectProperty<Paint>	fill	Defines parameters to fill the interior of an Shape using the settings of the Paint context.
final BooleanProperty	smooth	Defines whether antialiasing hints are used or not for this Shape.
final DoubleProperty	strokeDashOffset	Defines a distance specified in user coordinates that represents an offset into the dashing pattern.
final ObjectProperty<StrokeLineCap>	strokeLineCap	The end cap style of this Shape as one of the following values that define possible end cap styles: StrokeLineCap.BUTT, StrokeLineCap.ROUND, and StrokeLineCap.SQUARE.
final ObjectProperty<StrokeLineJoin>	strokeLineJoin	Defines the decoration applied where path segments meet.
final DoubleProperty	strokeMiterLimit	Defines the limit for the StrokeLineJoin.MITER line join style.
final ObjectProperty<Paint>	stroke	Defines parameters of a stroke that is drawn around the outline of a Shape using the settings of the specified Paint.
final ObjectProperty<StrokeType>	strokeType	Defines the direction (inside, centered, or outside) that the strokeWidth is applied to the boundary of the shape.
final DoubleProperty	strokeWidth	Defines a square pen line width.

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, visible

Type	Property	Description
final ObjectProperty<String>	accessibleHelp	The accessible help text for this Node.
final ObjectProperty<String>	accessibleRoleDescription	The role description of this Node.
final ObjectProperty<AccessibleRole>	accessibleRole	The accessible role for this Node.
final ObjectProperty<String>	accessibleText	The accessible text for this Node.
final ObjectProperty<BlendMode>	blendMode	The BlendMode used to blend this individual node into the scene behind it.
final ReadOnlyObjectProperty<Bounds>	boundsInLocal	The rectangular bounds of this Node in the node's untransformed local coordinate space.
final ReadOnlyObjectProperty<Bounds>	boundsInParent	The rectangular bounds of this Node in the parent coordinate system.
final ObjectProperty<CacheHint>	cacheHint	Additional hint for controlling bitmap caching.
final BooleanProperty	cache	A performance hint to the system to indicate that this Node should be cached as a bitmap.
final ObjectProperty<Node>	clip	Specifies a Node to use to define the clipping shape for this Node.
final ObjectProperty<Cursor>	cursor	Defines the mouse cursor for this Node and subnodes.
final ObjectProperty<DepthTest>	depthTest	Indicates whether depth testing is used when rendering this node.
final ReadOnlyBooleanProperty	disabled	Indicates whether or not this Node is disabled.
final BooleanProperty	disable	Defines the individual disabled state of this Node.
final ReadOnlyObjectProperty<NodeOrientation>	effectiveNodeOrientation	The effective orientation of a node resolves the inheritance of node orientation, returning either left-to-right or right-to-left.
final ObjectProperty<Effect>	effect	Specifies an effect to apply to this Node.
final ObjectProperty<EventDispatcher>	eventDispatcher	Specifies the event dispatcher for this node.
final ReadOnlyBooleanProperty	focused	Indicates whether this Node currently has the input focus.
final BooleanProperty	focusTraversable	Specifies whether this Node should be a part of focus traversal cycle.
final ReadOnlyBooleanProperty	focusVisible	Indicates whether this Node should visibly indicate focus.
final ReadOnlyBooleanProperty	focusWithin	Indicates whether this Node or any of its descendants currently has the input focus.
final ReadOnlyBooleanProperty	hover	Whether or not this Node is being hovered over.
final StringProperty	id	The id of this Node.
final ObjectProperty<InputMethodRequests>	inputMethodRequests	Property holding InputMethodRequests.
final ReadOnlyObjectProperty<Bounds>	layoutBounds	The rectangular bounds that should be used for layout calculations for this node.
final DoubleProperty	layoutX	Defines the x coordinate of the translation that is added to this Node's transform for the purpose of layout.
final DoubleProperty	layoutY	Defines the y coordinate of the translation that is added to this Node's transform for the purpose of layout.
final ReadOnlyObjectProperty<Transform>	localToParentTransform	An affine transform that holds the computed local-to-parent transform.
final ReadOnlyObjectProperty<Transform>	localToSceneTransform	An affine transform that holds the computed local-to-scene transform.
final BooleanProperty	managed	Defines whether or not this node's layout will be managed by its parent.
final BooleanProperty	mouseTransparent	If true, this node (together with all its children) is completely transparent to mouse events.
final ObjectProperty<NodeOrientation>	nodeOrientation	Node orientation describes the flow of visual data within a node.
final ObjectProperty<EventHandler<? super ContextMenuEvent>>	onContextMenuRequested	Defines a function to be called when a context menu has been requested on this Node.
final ObjectProperty<EventHandler<? super MouseEvent>>	onDragDetected	Defines a function to be called when drag gesture has been detected.
final ObjectProperty<EventHandler<? super DragEvent>>	onDragDone	Defines a function to be called when this Node is a drag and drop gesture source after its data has been dropped on a drop target.
final ObjectProperty<EventHandler<? super DragEvent>>	onDragDropped	Defines a function to be called when the mouse button is released on this Node during drag and drop gesture.
final ObjectProperty<EventHandler<? super DragEvent>>	onDragEntered	Defines a function to be called when drag gesture enters this Node.
final ObjectProperty<EventHandler<? super DragEvent>>	onDragExited	Defines a function to be called when drag gesture exits this Node.
final ObjectProperty<EventHandler<? super DragEvent>>	onDragOver	Defines a function to be called when drag gesture progresses within this Node.
final ObjectProperty<EventHandler<? super InputMethodEvent>>	onInputMethodTextChanged	Defines a function to be called when this Node has input focus and the input method text has changed.
final ObjectProperty<EventHandler<? super KeyEvent>>	onKeyPressed	Defines a function to be called when this Node or its child Node has input focus and a key has been pressed.
final ObjectProperty<EventHandler<? super KeyEvent>>	onKeyReleased	Defines a function to be called when this Node or its child Node has input focus and a key has been released.
final ObjectProperty<EventHandler<? super KeyEvent>>	onKeyTyped	Defines a function to be called when this Node or its child Node has input focus and a key has been typed.
final ObjectProperty<EventHandler<? super MouseEvent>>	onMouseClicked	Defines a function to be called when a mouse button has been clicked (pressed and released) on this Node.
final ObjectProperty<EventHandler<? super MouseDragEvent>>	onMouseDragDone	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>>	onMouseDragEntered	Defines a function to be called when a full press-drag-release gesture enters this Node.
final ObjectProperty<EventHandler<? super MouseDragEvent>>	onMouseDragExited	Defines a function to be called when a full press-drag-release gesture leaves this Node.
final ObjectProperty<EventHandler<? super MouseEvent>>	onMouseDragged	Defines a function to be called when a mouse button is pressed on this Node and then dragged.
final ObjectProperty<EventHandler<? super MouseDragEvent>>	onMouseDragOver	Defines a function to be called when a full press-drag-release gesture progresses within this Node.
final ObjectProperty<EventHandler<? super MouseDragEvent>>	onMouseDragReleased	Defines a function to be called when a full press-drag-release gesture ends (by releasing mouse button) within this Node.
final ObjectProperty<EventHandler<? super MouseEvent>>	onMouseEntered	Defines a function to be called when the mouse enters this Node.
final ObjectProperty<EventHandler<? super MouseEvent>>	onMouseExited	Defines a function to be called when the mouse exits this Node.
final ObjectProperty<EventHandler<? super MouseEvent>>	onMouseMoved	Defines a function to be called when mouse cursor moves within this Node but no buttons have been pushed.
final ObjectProperty<EventHandler<? super MouseEvent>>	onMousePressed	Defines a function to be called when a mouse button has been pressed on this Node.
final ObjectProperty<EventHandler<? super MouseEvent>>	onMouseReleased	Defines a function to be called when a mouse button has been released on this Node.
final ObjectProperty<EventHandler<? super RotateEvent>>	onRotate	Defines a function to be called when user performs a rotation action.
final ObjectProperty<EventHandler<? super RotateEvent>>	onRotationFinished	Defines a function to be called when a rotation gesture ends.
final ObjectProperty<EventHandler<? super RotateEvent>>	onRotationStarted	Defines a function to be called when a rotation gesture is detected.
final ObjectProperty<EventHandler<? super ScrollEvent>>	onScrollFinished	Defines a function to be called when a scrolling gesture ends.
final ObjectProperty<EventHandler<? super ScrollEvent>>	onScroll	Defines a function to be called when user performs a scrolling action.
final ObjectProperty<EventHandler<? super ScrollEvent>>	onScrollStarted	Defines a function to be called when a scrolling gesture is detected.
final ObjectProperty<EventHandler<? super SwipeEvent>>	onSwipeDown	Defines a function to be called when a downward swipe gesture centered over this node happens.
final ObjectProperty<EventHandler<? super SwipeEvent>>	onSwipeLeft	Defines a function to be called when a leftward swipe gesture centered over this node happens.
final ObjectProperty<EventHandler<? super SwipeEvent>>	onSwipeRight	Defines a function to be called when an rightward swipe gesture centered over this node happens.
final ObjectProperty<EventHandler<? super SwipeEvent>>	onSwipeUp	Defines a function to be called when an upward swipe gesture centered over this node happens.
final ObjectProperty<EventHandler<? super TouchEvent>>	onTouchMoved	Defines a function to be called when a touch point is moved.
final ObjectProperty<EventHandler<? super TouchEvent>>	onTouchPressed	Defines a function to be called when a new touch point is pressed.
final ObjectProperty<EventHandler<? super TouchEvent>>	onTouchReleased	Defines a function to be called when a touch point is released.
final ObjectProperty<EventHandler<? super TouchEvent>>	onTouchStationary	Defines a function to be called when a touch point stays pressed and still.
final ObjectProperty<EventHandler<? super ZoomEvent>>	onZoomFinished	Defines a function to be called when a zooming gesture ends.
final ObjectProperty<EventHandler<? super ZoomEvent>>	onZoom	Defines a function to be called when user performs a zooming action.
final ObjectProperty<EventHandler<? super ZoomEvent>>	onZoomStarted	Defines a function to be called when a zooming gesture is detected.
final DoubleProperty	opacity	Specifies how opaque (that is, solid) the Node appears.
final ReadOnlyObjectProperty<Parent>	parent	The parent of this Node.
final BooleanProperty	pickOnBounds	Defines how the picking computation is done for this node when triggered by a MouseEvent or a contains function call.
final ReadOnlyBooleanProperty	pressed	Whether or not the Node is pressed.
final DoubleProperty	rotate	Defines the angle of rotation about the Node's center, measured in degrees.
final ObjectProperty<Point3D>	rotationAxis	Defines the axis of rotation of this Node.
final DoubleProperty	scaleX	Defines the factor by which coordinates are scaled about the center of the object along the X axis of this Node.
final DoubleProperty	scaleY	Defines the factor by which coordinates are scaled about the center of the object along the Y axis of this Node.
final DoubleProperty	scaleZ	Defines the factor by which coordinates are scaled about the center of the object along the Z axis of this Node.
final ReadOnlyObjectProperty<Scene>	scene	The Scene that this Node is part of.
final StringProperty	style	A string representation of the CSS style associated with this specific Node.
final DoubleProperty	translateX	Defines the x coordinate of the translation that is added to this Node's transform.
final DoubleProperty	translateY	Defines the y coordinate of the translation that is added to this Node's transform.
final DoubleProperty	translateZ	Defines the Z coordinate of the translation that is added to the transformed coordinates of this Node.
final DoubleProperty	viewOrder	Defines the rendering and picking order of this Node within its parent.
final BooleanProperty	visible	Specifies whether this Node and any subnodes should be rendered as part of the scene graph.

Field Summary

Fields declared in class Node

BASELINE_OFFSET_SAME_AS_HEIGHT

Modifier and Type	Field	Description
static final double	BASELINE_OFFSET_SAME_AS_HEIGHT	This is a special value that might be returned by Node.getBaselineOffset().

Constructor Summary

Constructors

Constructor	Description
Text()	Creates an empty instance of Text.
Text(double x, double y, String text)	Creates an instance of Text on the given coordinates containing the given string.
Text(String text)	Creates an instance of Text containing the given string.

Method Summary

Modifier and Type	Method	Description
final ReadOnlyDoubleProperty	baselineOffsetProperty()	The 'alphabetic' (or roman) baseline offset from the Text node's layoutBounds.minY location.
final ObjectProperty<TextBoundsType>	boundsTypeProperty()	Determines how the bounds of the text node are calculated.
final BooleanProperty	caretBiasProperty()	The type of caret bias in the content.
final IntegerProperty	caretPositionProperty()	The caret index in the content.
final PathElement[]	caretShape(int charIndex, boolean caretBias)	Returns the shape for the caret at the given index and bias.
final ReadOnlyObjectProperty<PathElement[]>	caretShapeProperty()	The shape of caret, in local coordinates.
final ObjectProperty<Font>	fontProperty()	Defines the font of text.
final ObjectProperty<FontSmoothingType>	fontSmoothingTypeProperty()	Specifies a requested font smoothing type: gray or LCD.
final double	getBaselineOffset()	Gets the value of the baselineOffset property.
final TextBoundsType	getBoundsType()	Gets the value of the boundsType property.
final int	getCaretPosition()	Gets the value of the caretPosition property.
final PathElement[]	getCaretShape()	Gets the value of the caretShape property.
static List<CssMetaData<? extends Styleable, ?>>	getClassCssMetaData()	Gets the CssMetaData associated with this class, which may include the CssMetaData of its superclasses.
List<CssMetaData<? extends Styleable, ?>>	getCssMetaData()	This method should delegate to Node.getClassCssMetaData() so that a Node's CssMetaData can be accessed without the need for reflection.
final Font	getFont()	Gets the value of the font property.
final FontSmoothingType	getFontSmoothingType()	Gets the value of the fontSmoothingType property.
final LayoutInfo	getLayoutInfo()	Returns a copy of the of the text layout geometry for this node.
final double	getLineSpacing()	Gets the value of the lineSpacing property.
final PathElement[]	getRangeShape(int start, int end, boolean includeLineSpacing)	Returns the shape for the range of the text in local coordinates, with or without line spacing.
final int	getSelectionEnd()	Gets the value of the selectionEnd property.
final Paint	getSelectionFill()	Gets the value of the selectionFill property.
final PathElement[]	getSelectionShape()	Gets the value of the selectionShape property.
final int	getSelectionStart()	Gets the value of the selectionStart property.
final PathElement[]	getStrikeThroughShape(int start, int end)	Returns the shape for the strike-through in local coordinates.
final int	getTabSize()	Gets the value of the tabSize property.
final String	getText()	Gets the value of the text property.
final TextAlignment	getTextAlignment()	Gets the value of the textAlignment property.
final VPos	getTextOrigin()	Gets the value of the textOrigin property.
final double	getWrappingWidth()	Gets the value of the wrappingWidth property.
final double	getX()	Gets the value of the x property.
final double	getY()	Gets the value of the y property.
final HitInfo	hitTest(Point2D point)	Maps local point to HitInfo in the content.
final boolean	isCaretBias()	Gets the value of the caretBias property.
final boolean	isStrikethrough()	Gets the value of the strikethrough property.
final boolean	isUnderline()	Gets the value of the underline property.
final DoubleProperty	lineSpacingProperty()	Defines the vertical space in pixel between lines.
final PathElement[]	rangeShape(int start, int end)	Returns the shape for the range of the text in local coordinates.
final IntegerProperty	selectionEndProperty()	The end index of the selection in the content.
final ObjectProperty<Paint>	selectionFillProperty()	The fill color of selected text.
final ReadOnlyObjectProperty<PathElement[]>	selectionShapeProperty()	The shape of the selection in local coordinates.
final IntegerProperty	selectionStartProperty()	The start index of the selection in the content.
final void	setBoundsType(TextBoundsType value)	Sets the value of the boundsType property.
final void	setCaretBias(boolean value)	Sets the value of the caretBias property.
final void	setCaretPosition(int value)	Sets the value of the caretPosition property.
final void	setFont(Font value)	Sets the value of the font property.
final void	setFontSmoothingType(FontSmoothingType value)	Sets the value of the fontSmoothingType property.
final void	setLineSpacing(double spacing)	Sets the value of the lineSpacing property.
final void	setSelectionEnd(int value)	Sets the value of the selectionEnd property.
final void	setSelectionFill(Paint paint)	Sets the value of the selectionFill property.
final void	setSelectionStart(int value)	Sets the value of the selectionStart property.
final void	setStrikethrough(boolean value)	Sets the value of the strikethrough property.
final void	setTabSize(int spaces)	Sets the value of the tabSize property.
final void	setText(String value)	Sets the value of the text property.
final void	setTextAlignment(TextAlignment value)	Sets the value of the textAlignment property.
final void	setTextOrigin(VPos value)	Sets the value of the textOrigin property.
final void	setUnderline(boolean value)	Sets the value of the underline property.
final void	setWrappingWidth(double value)	Sets the value of the wrappingWidth property.
final void	setX(double value)	Sets the value of the x property.
final void	setY(double value)	Sets the value of the y property.
final BooleanProperty	strikethroughProperty()	Defines if each line of text should have a line through it.
final IntegerProperty	tabSizeProperty()	The size of a tab stop in spaces.
final ObjectProperty<TextAlignment>	textAlignmentProperty()	Defines horizontal text alignment in the bounding box.
final ObjectProperty<VPos>	textOriginProperty()	Defines the origin of text coordinate system in local coordinates.
final StringProperty	textProperty()	Defines text string that is to be displayed.
String	toString()	Returns a string representation of this Text object.
final BooleanProperty	underlineProperty()	Defines if each line of text should have a line below it.
final PathElement[]	underlineShape(int start, int end)	Returns the shape for the underline in local coordinates.
final DoubleProperty	wrappingWidthProperty()	Defines a width constraint for the text in user space coordinates.
final DoubleProperty	xProperty()	Defines the X coordinate of text origin.
final DoubleProperty	yProperty()	Defines the Y coordinate of text origin.

Methods declared in class Shape

fillProperty, getFill, getStroke, getStrokeDashArray, getStrokeDashOffset, getStrokeLineCap, getStrokeLineJoin, getStrokeMiterLimit, getStrokeType, getStrokeWidth, intersect, isSmooth, setFill, setSmooth, setStroke, setStrokeDashOffset, setStrokeLineCap, setStrokeLineJoin, setStrokeMiterLimit, setStrokeType, setStrokeWidth, smoothProperty, strokeDashOffsetProperty, strokeLineCapProperty, strokeLineJoinProperty, strokeMiterLimitProperty, strokeProperty, strokeTypeProperty, strokeWidthProperty, subtract, union

Modifier and Type	Method	Description
final ObjectProperty<Paint>	fillProperty()	Defines parameters to fill the interior of an Shape using the settings of the Paint context.
final Paint	getFill()	Gets the value of the fill property.
final Paint	getStroke()	Gets the value of the stroke property.
final ObservableList<Double>	getStrokeDashArray()	Defines the array representing the lengths of the dash segments.
final double	getStrokeDashOffset()	Gets the value of the strokeDashOffset property.
final StrokeLineCap	getStrokeLineCap()	Gets the value of the strokeLineCap property.
final StrokeLineJoin	getStrokeLineJoin()	Gets the value of the strokeLineJoin property.
final double	getStrokeMiterLimit()	Gets the value of the strokeMiterLimit property.
final StrokeType	getStrokeType()	Gets the value of the strokeType property.
final double	getStrokeWidth()	Gets the value of the strokeWidth property.
static Shape	intersect(Shape shape1, Shape shape2)	Returns a new Shape which is created as an intersection of the specified input shapes.
final boolean	isSmooth()	Gets the value of the smooth property.
final void	setFill(Paint value)	Sets the value of the fill property.
final void	setSmooth(boolean value)	Sets the value of the smooth property.
final void	setStroke(Paint value)	Sets the value of the stroke property.
final void	setStrokeDashOffset(double value)	Sets the value of the strokeDashOffset property.
final void	setStrokeLineCap(StrokeLineCap value)	Sets the value of the strokeLineCap property.
final void	setStrokeLineJoin(StrokeLineJoin value)	Sets the value of the strokeLineJoin property.
final void	setStrokeMiterLimit(double value)	Sets the value of the strokeMiterLimit property.
final void	setStrokeType(StrokeType value)	Sets the value of the strokeType property.
final void	setStrokeWidth(double value)	Sets the value of the strokeWidth property.
final BooleanProperty	smoothProperty()	Defines whether antialiasing hints are used or not for this Shape.
final DoubleProperty	strokeDashOffsetProperty()	Defines a distance specified in user coordinates that represents an offset into the dashing pattern.
final ObjectProperty<StrokeLineCap>	strokeLineCapProperty()	The end cap style of this Shape as one of the following values that define possible end cap styles: StrokeLineCap.BUTT, StrokeLineCap.ROUND, and StrokeLineCap.SQUARE.
final ObjectProperty<StrokeLineJoin>	strokeLineJoinProperty()	Defines the decoration applied where path segments meet.
final DoubleProperty	strokeMiterLimitProperty()	Defines the limit for the StrokeLineJoin.MITER line join style.
final ObjectProperty<Paint>	strokeProperty()	Defines parameters of a stroke that is drawn around the outline of a Shape using the settings of the specified Paint.
final ObjectProperty<StrokeType>	strokeTypeProperty()	Defines the direction (inside, centered, or outside) that the strokeWidth is applied to the boundary of the shape.
final DoubleProperty	strokeWidthProperty()	Defines a square pen line width.
static Shape	subtract(Shape shape1, Shape shape2)	Returns a new Shape which is created by subtracting the specified second shape from the first shape.
static Shape	union(Shape shape1, Shape shape2)	Returns a new Shape which is created as a union of the specified input shapes.

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, getInitialFocusTraversable, 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, isResizable, 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, maxHeight, maxWidth, minHeight, minWidth, 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, prefHeight, prefWidth, pressedProperty, pseudoClassStateChanged, queryAccessibleAttribute, relocate, removeEventFilter, removeEventHandler, requestFocus, requestFocusTraversal, resize, 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, translateXProperty, translateYProperty, translateZProperty, usesMirroring, viewOrderProperty, visibleProperty

Modifier and Type	Method	Description
final ObjectProperty<String>	accessibleHelpProperty()	The accessible help text for this Node.
final ObjectProperty<String>	accessibleRoleDescriptionProperty()	The role description of this Node.
final ObjectProperty<AccessibleRole>	accessibleRoleProperty()	The accessible role for this Node.
final ObjectProperty<String>	accessibleTextProperty()	The accessible text for this Node.
final <T extends Event> void	addEventFilter(EventType<T> eventType, EventHandler<? super T> eventFilter)	Registers an event filter for this target.
final <T extends Event> void	addEventHandler(EventType<T> eventType, EventHandler<? super T> eventHandler)	Registers an event handler for this target.
final void	applyCss()	If required, apply styles to this Node and its children, if any.
final void	autosize()	If the node is resizable, will set its layout bounds to its current preferred width and height.
final ObjectProperty<BlendMode>	blendModeProperty()	The BlendMode used to blend this individual node into the scene behind it.
final ReadOnlyObjectProperty<Bounds>	boundsInLocalProperty()	The rectangular bounds of this Node in the node's untransformed local coordinate space.
final ReadOnlyObjectProperty<Bounds>	boundsInParentProperty()	The rectangular bounds of this Node in the parent coordinate system.
EventDispatchChain	buildEventDispatchChain(EventDispatchChain tail)	Construct an event dispatch chain for this target.
final ObjectProperty<CacheHint>	cacheHintProperty()	Additional hint for controlling bitmap caching.
final BooleanProperty	cacheProperty()	A performance hint to the system to indicate that this Node should be cached as a bitmap.
final ObjectProperty<Node>	clipProperty()	Specifies a Node to use to define the clipping shape for this Node.
double	computeAreaInScreen()	Returns the area of this Node projected onto the physical screen in pixel units.
boolean	contains(double localX, double localY)	Returns true if the given point (specified in the local coordinate space of this Node) is contained within the shape of this Node.
boolean	contains(Point2D localPoint)	Returns true if the given point (specified in the local coordinate space of this Node) is contained within the shape of this Node.
final ObjectProperty<Cursor>	cursorProperty()	Defines the mouse cursor for this Node and subnodes.
final ObjectProperty<DepthTest>	depthTestProperty()	Indicates whether depth testing is used when rendering this node.
final ReadOnlyBooleanProperty	disabledProperty()	Indicates whether or not this Node is disabled.
final BooleanProperty	disableProperty()	Defines the individual disabled state of this Node.
final ReadOnlyObjectProperty<NodeOrientation>	effectiveNodeOrientationProperty()	The effective orientation of a node resolves the inheritance of node orientation, returning either left-to-right or right-to-left.
final ObjectProperty<Effect>	effectProperty()	Specifies an effect to apply to this Node.
final ObjectProperty<EventDispatcher>	eventDispatcherProperty()	Specifies the event dispatcher for this node.
void	executeAccessibleAction(AccessibleAction action, Object... parameters)	This method is called by the assistive technology to request the action indicated by the argument should be executed.
final void	fireEvent(Event event)	Fires the specified event.
final ReadOnlyBooleanProperty	focusedProperty()	Indicates whether this Node currently has the input focus.
final BooleanProperty	focusTraversableProperty()	Specifies whether this Node should be a part of focus traversal cycle.
final ReadOnlyBooleanProperty	focusVisibleProperty()	Indicates whether this Node should visibly indicate focus.
final ReadOnlyBooleanProperty	focusWithinProperty()	Indicates whether this Node or any of its descendants currently has the input focus.
final String	getAccessibleHelp()	Gets the value of the accessibleHelp property.
final AccessibleRole	getAccessibleRole()	Gets the value of the accessibleRole property.
final String	getAccessibleRoleDescription()	Gets the value of the accessibleRoleDescription property.
final String	getAccessibleText()	Gets the value of the accessibleText property.
final BlendMode	getBlendMode()	Gets the value of the blendMode property.
final Bounds	getBoundsInLocal()	Gets the value of the boundsInLocal property.
final Bounds	getBoundsInParent()	Gets the value of the boundsInParent property.
final CacheHint	getCacheHint()	Gets the value of the cacheHint property.
final Node	getClip()	Gets the value of the clip property.
Orientation	getContentBias()	Returns the orientation of a node's resizing bias for layout purposes.
final Cursor	getCursor()	Gets the value of the cursor property.
final DepthTest	getDepthTest()	Gets the value of the depthTest property.
final Effect	getEffect()	Gets the value of the effect property.
final NodeOrientation	getEffectiveNodeOrientation()	Gets the value of the effectiveNodeOrientation property.
final EventDispatcher	getEventDispatcher()	Gets the value of the eventDispatcher property.
final String	getId()	The id of this Node.
protected Cursor	getInitialCursor()	Returns the initial cursor state of this node, for use by the JavaFX CSS engine to correctly set its initial value.
protected Boolean	getInitialFocusTraversable()	Returns the initial focus traversable state of this node, for use by the JavaFX CSS engine to correctly set its initial value.
final InputMethodRequests	getInputMethodRequests()	Gets the value of the inputMethodRequests property.
final Bounds	getLayoutBounds()	Gets the value of the layoutBounds property.
final double	getLayoutX()	Gets the value of the layoutX property.
final double	getLayoutY()	Gets the value of the layoutY property.
final Transform	getLocalToParentTransform()	Gets the value of the localToParentTransform property.
final Transform	getLocalToSceneTransform()	Gets the value of the localToSceneTransform property.
final NodeOrientation	getNodeOrientation()	Gets the value of the nodeOrientation property.
final EventHandler<? super ContextMenuEvent>	getOnContextMenuRequested()	Gets the value of the onContextMenuRequested property.
final EventHandler<? super MouseEvent>	getOnDragDetected()	Gets the value of the onDragDetected property.
final EventHandler<? super DragEvent>	getOnDragDone()	Gets the value of the onDragDone property.
final EventHandler<? super DragEvent>	getOnDragDropped()	Gets the value of the onDragDropped property.
final EventHandler<? super DragEvent>	getOnDragEntered()	Gets the value of the onDragEntered property.
final EventHandler<? super DragEvent>	getOnDragExited()	Gets the value of the onDragExited property.
final EventHandler<? super DragEvent>	getOnDragOver()	Gets the value of the onDragOver property.
final EventHandler<? super InputMethodEvent>	getOnInputMethodTextChanged()	Gets the value of the onInputMethodTextChanged property.
final EventHandler<? super KeyEvent>	getOnKeyPressed()	Gets the value of the onKeyPressed property.
final EventHandler<? super KeyEvent>	getOnKeyReleased()	Gets the value of the onKeyReleased property.
final EventHandler<? super KeyEvent>	getOnKeyTyped()	Gets the value of the onKeyTyped property.
final EventHandler<? super MouseEvent>	getOnMouseClicked()	Gets the value of the onMouseClicked property.
final EventHandler<? super MouseDragEvent>	getOnMouseDragDone()	Gets the value of the onMouseDragDone property.
final EventHandler<? super MouseDragEvent>	getOnMouseDragEntered()	Gets the value of the onMouseDragEntered property.
final EventHandler<? super MouseDragEvent>	getOnMouseDragExited()	Gets the value of the onMouseDragExited property.
final EventHandler<? super MouseEvent>	getOnMouseDragged()	Gets the value of the onMouseDragged property.
final EventHandler<? super MouseDragEvent>	getOnMouseDragOver()	Gets the value of the onMouseDragOver property.
final EventHandler<? super MouseDragEvent>	getOnMouseDragReleased()	Gets the value of the onMouseDragReleased property.
final EventHandler<? super MouseEvent>	getOnMouseEntered()	Gets the value of the onMouseEntered property.
final EventHandler<? super MouseEvent>	getOnMouseExited()	Gets the value of the onMouseExited property.
final EventHandler<? super MouseEvent>	getOnMouseMoved()	Gets the value of the onMouseMoved property.
final EventHandler<? super MouseEvent>	getOnMousePressed()	Gets the value of the onMousePressed property.
final EventHandler<? super MouseEvent>	getOnMouseReleased()	Gets the value of the onMouseReleased property.
final EventHandler<? super RotateEvent>	getOnRotate()	Gets the value of the onRotate property.
final EventHandler<? super RotateEvent>	getOnRotationFinished()	Gets the value of the onRotationFinished property.
final EventHandler<? super RotateEvent>	getOnRotationStarted()	Gets the value of the onRotationStarted property.
final EventHandler<? super ScrollEvent>	getOnScroll()	Gets the value of the onScroll property.
final EventHandler<? super ScrollEvent>	getOnScrollFinished()	Gets the value of the onScrollFinished property.
final EventHandler<? super ScrollEvent>	getOnScrollStarted()	Gets the value of the onScrollStarted property.
final EventHandler<? super SwipeEvent>	getOnSwipeDown()	Gets the value of the onSwipeDown property.
final EventHandler<? super SwipeEvent>	getOnSwipeLeft()	Gets the value of the onSwipeLeft property.
final EventHandler<? super SwipeEvent>	getOnSwipeRight()	Gets the value of the onSwipeRight property.
final EventHandler<? super SwipeEvent>	getOnSwipeUp()	Gets the value of the onSwipeUp property.
final EventHandler<? super TouchEvent>	getOnTouchMoved()	Gets the value of the onTouchMoved property.
final EventHandler<? super TouchEvent>	getOnTouchPressed()	Gets the value of the onTouchPressed property.
final EventHandler<? super TouchEvent>	getOnTouchReleased()	Gets the value of the onTouchReleased property.
final EventHandler<? super TouchEvent>	getOnTouchStationary()	Gets the value of the onTouchStationary property.
final EventHandler<? super ZoomEvent>	getOnZoom()	Gets the value of the onZoom property.
final EventHandler<? super ZoomEvent>	getOnZoomFinished()	Gets the value of the onZoomFinished property.
final EventHandler<? super ZoomEvent>	getOnZoomStarted()	Gets the value of the onZoomStarted property.
final double	getOpacity()	Gets the value of the opacity property.
final Parent	getParent()	Gets the value of the parent property.
final ObservableMap<Object,Object>	getProperties()	Returns an observable map of properties on this node for use primarily by application developers.
final ObservableSet<PseudoClass>	getPseudoClassStates()	Return the pseudo-class state of this Styleable.
final double	getRotate()	Gets the value of the rotate property.
final Point3D	getRotationAxis()	Gets the value of the rotationAxis property.
final double	getScaleX()	Gets the value of the scaleX property.
final double	getScaleY()	Gets the value of the scaleY property.
final double	getScaleZ()	Gets the value of the scaleZ property.
final Scene	getScene()	Gets the value of the scene property.
final String	getStyle()	A string representation of the CSS style associated with this specific Node.
Styleable	getStyleableParent()	Return the parent of this Styleable, or null if there is no parent.
final ObservableList<String>	getStyleClass()	A list of String identifiers which can be used to logically group Nodes, specifically for an external style engine.
final ObservableList<Transform>	getTransforms()	The ObservableList of custom Transforms to be applied to this Node.
final double	getTranslateX()	Gets the value of the translateX property.
final double	getTranslateY()	Gets the value of the translateY property.
final double	getTranslateZ()	Gets the value of the translateZ property.
String	getTypeSelector()	The type of this Styleable that is to be used in selector matching.
Object	getUserData()	Returns a previously set Object property, or null if no such property has been set using the Node.setUserData(java.lang.Object) method.
final double	getViewOrder()	Gets the value of the viewOrder property.
boolean	hasProperties()	Tests if Node has properties.
final ReadOnlyBooleanProperty	hoverProperty()	Whether or not this Node is being hovered over.
final StringProperty	idProperty()	The id of this Node.
final ObjectProperty<InputMethodRequests>	inputMethodRequestsProperty()	Property holding InputMethodRequests.
boolean	intersects(double localX, double localY, double localWidth, double localHeight)	Returns true if the given rectangle (specified in the local coordinate space of this Node) intersects the shape of this Node.
boolean	intersects(Bounds localBounds)	Returns true if the given bounds (specified in the local coordinate space of this Node) intersects the shape of this Node.
final boolean	isCache()	Gets the value of the cache property.
final boolean	isDisable()	Gets the value of the disable property.
final boolean	isDisabled()	Gets the value of the disabled property.
final boolean	isFocused()	Gets the value of the focused property.
final boolean	isFocusTraversable()	Gets the value of the focusTraversable property.
final boolean	isFocusVisible()	Gets the value of the focusVisible property.
final boolean	isFocusWithin()	Gets the value of the focusWithin property.
final boolean	isHover()	Gets the value of the hover property.
final boolean	isManaged()	Gets the value of the managed property.
final boolean	isMouseTransparent()	Gets the value of the mouseTransparent property.
final boolean	isPickOnBounds()	Gets the value of the pickOnBounds property.
final boolean	isPressed()	Gets the value of the pressed property.
boolean	isResizable()	Indicates whether this node is a type which can be resized by its parent.
final boolean	isVisible()	Gets the value of the visible property.
final ReadOnlyObjectProperty<Bounds>	layoutBoundsProperty()	The rectangular bounds that should be used for layout calculations for this node.
final DoubleProperty	layoutXProperty()	Defines the x coordinate of the translation that is added to this Node's transform for the purpose of layout.
final DoubleProperty	layoutYProperty()	Defines the y coordinate of the translation that is added to this Node's transform for the purpose of layout.
Point2D	localToParent(double localX, double localY)	Transforms a point from the local coordinate space of this Node into the coordinate space of its parent.
Point3D	localToParent(double x, double y, double z)	Transforms a point from the local coordinate space of this Node into the coordinate space of its parent.
Bounds	localToParent(Bounds localBounds)	Transforms a bounds from the local coordinate space of this Node into the coordinate space of its parent.
Point2D	localToParent(Point2D localPoint)	Transforms a point from the local coordinate space of this Node into the coordinate space of its parent.
Point3D	localToParent(Point3D localPoint)	Transforms a point from the local coordinate space of this Node into the coordinate space of its parent.
final ReadOnlyObjectProperty<Transform>	localToParentTransformProperty()	An affine transform that holds the computed local-to-parent transform.
Point2D	localToScene(double localX, double localY)	Transforms a point from the local coordinate space of this Node into the coordinate space of its scene.
Point2D	localToScene(double x, double y, boolean rootScene)	Transforms a point from the local coordinate space of this Node into the coordinate space of its scene.
Point3D	localToScene(double x, double y, double z)	Transforms a point from the local coordinate space of this Node into the coordinate space of its scene.
Point3D	localToScene(double x, double y, double z, boolean rootScene)	Transforms a point from the local coordinate space of this Node into the coordinate space of its scene.
Bounds	localToScene(Bounds localBounds)	Transforms a bounds from the local coordinate space of this Node into the coordinate space of its scene.
Bounds	localToScene(Bounds localBounds, boolean rootScene)	Transforms a bounds from the local coordinate space of this Node into the coordinate space of its scene.
Point2D	localToScene(Point2D localPoint)	Transforms a point from the local coordinate space of this Node into the coordinate space of its scene.
Point2D	localToScene(Point2D localPoint, boolean rootScene)	Transforms a point from the local coordinate space of this Node into the coordinate space of its scene.
Point3D	localToScene(Point3D localPoint)	Transforms a point from the local coordinate space of this Node into the coordinate space of its scene.
Point3D	localToScene(Point3D localPoint, boolean rootScene)	Transforms a point from the local coordinate space of this Node into the coordinate space of its scene.
final ReadOnlyObjectProperty<Transform>	localToSceneTransformProperty()	An affine transform that holds the computed local-to-scene transform.
Point2D	localToScreen(double localX, double localY)	Transforms a point from the local coordinate space of this Node into the coordinate space of its Screen.
Point2D	localToScreen(double localX, double localY, double localZ)	Transforms a point from the local coordinate space of this Node into the coordinate space of its Screen.
Bounds	localToScreen(Bounds localBounds)	Transforms a bounds from the local coordinate space of this Node into the coordinate space of its Screen.
Point2D	localToScreen(Point2D localPoint)	Transforms a point from the local coordinate space of this Node into the coordinate space of its Screen.
Point2D	localToScreen(Point3D localPoint)	Transforms a point from the local coordinate space of this Node into the coordinate space of its Screen.
Node	lookup(String selector)	Finds this Node, or the first sub-node, based on the given CSS selector.
Set<Node>	lookupAll(String selector)	Finds all Nodes, including this one and any children, which match the given CSS selector.
final BooleanProperty	managedProperty()	Defines whether or not this node's layout will be managed by its parent.
double	maxHeight(double width)	Returns the node's maximum height for use in layout calculations.
double	maxWidth(double height)	Returns the node's maximum width for use in layout calculations.
double	minHeight(double width)	Returns the node's minimum height for use in layout calculations.
double	minWidth(double height)	Returns the node's minimum width for use in layout calculations.
final BooleanProperty	mouseTransparentProperty()	If true, this node (together with all its children) is completely transparent to mouse events.
final ObjectProperty<NodeOrientation>	nodeOrientationProperty()	Node orientation describes the flow of visual data within a node.
final void	notifyAccessibleAttributeChanged(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>>	onContextMenuRequestedProperty()	Defines a function to be called when a context menu has been requested on this Node.
final ObjectProperty<EventHandler<? super MouseEvent>>	onDragDetectedProperty()	Defines a function to be called when drag gesture has been detected.
final ObjectProperty<EventHandler<? super DragEvent>>	onDragDoneProperty()	Defines a function to be called when this Node is a drag and drop gesture source after its data has been dropped on a drop target.
final ObjectProperty<EventHandler<? super DragEvent>>	onDragDroppedProperty()	Defines a function to be called when the mouse button is released on this Node during drag and drop gesture.
final ObjectProperty<EventHandler<? super DragEvent>>	onDragEnteredProperty()	Defines a function to be called when drag gesture enters this Node.
final ObjectProperty<EventHandler<? super DragEvent>>	onDragExitedProperty()	Defines a function to be called when drag gesture exits this Node.
final ObjectProperty<EventHandler<? super DragEvent>>	onDragOverProperty()	Defines a function to be called when drag gesture progresses within this Node.
final ObjectProperty<EventHandler<? super InputMethodEvent>>	onInputMethodTextChangedProperty()	Defines a function to be called when this Node has input focus and the input method text has changed.
final ObjectProperty<EventHandler<? super KeyEvent>>	onKeyPressedProperty()	Defines a function to be called when this Node or its child Node has input focus and a key has been pressed.
final ObjectProperty<EventHandler<? super KeyEvent>>	onKeyReleasedProperty()	Defines a function to be called when this Node or its child Node has input focus and a key has been released.
final ObjectProperty<EventHandler<? super KeyEvent>>	onKeyTypedProperty()	Defines a function to be called when this Node or its child Node has input focus and a key has been typed.
final ObjectProperty<EventHandler<? super MouseEvent>>	onMouseClickedProperty()	Defines a function to be called when a mouse button has been clicked (pressed and released) on this Node.
final ObjectProperty<EventHandler<? super MouseDragEvent>>	onMouseDragDoneProperty()	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>>	onMouseDragEnteredProperty()	Defines a function to be called when a full press-drag-release gesture enters this Node.
final ObjectProperty<EventHandler<? super MouseDragEvent>>	onMouseDragExitedProperty()	Defines a function to be called when a full press-drag-release gesture leaves this Node.
final ObjectProperty<EventHandler<? super MouseEvent>>	onMouseDraggedProperty()	Defines a function to be called when a mouse button is pressed on this Node and then dragged.
final ObjectProperty<EventHandler<? super MouseDragEvent>>	onMouseDragOverProperty()	Defines a function to be called when a full press-drag-release gesture progresses within this Node.
final ObjectProperty<EventHandler<? super MouseDragEvent>>	onMouseDragReleasedProperty()	Defines a function to be called when a full press-drag-release gesture ends (by releasing mouse button) within this Node.
final ObjectProperty<EventHandler<? super MouseEvent>>	onMouseEnteredProperty()	Defines a function to be called when the mouse enters this Node.
final ObjectProperty<EventHandler<? super MouseEvent>>	onMouseExitedProperty()	Defines a function to be called when the mouse exits this Node.
final ObjectProperty<EventHandler<? super MouseEvent>>	onMouseMovedProperty()	Defines a function to be called when mouse cursor moves within this Node but no buttons have been pushed.
final ObjectProperty<EventHandler<? super MouseEvent>>	onMousePressedProperty()	Defines a function to be called when a mouse button has been pressed on this Node.
final ObjectProperty<EventHandler<? super MouseEvent>>	onMouseReleasedProperty()	Defines a function to be called when a mouse button has been released on this Node.
final ObjectProperty<EventHandler<? super RotateEvent>>	onRotateProperty()	Defines a function to be called when user performs a rotation action.
final ObjectProperty<EventHandler<? super RotateEvent>>	onRotationFinishedProperty()	Defines a function to be called when a rotation gesture ends.
final ObjectProperty<EventHandler<? super RotateEvent>>	onRotationStartedProperty()	Defines a function to be called when a rotation gesture is detected.
final ObjectProperty<EventHandler<? super ScrollEvent>>	onScrollFinishedProperty()	Defines a function to be called when a scrolling gesture ends.
final ObjectProperty<EventHandler<? super ScrollEvent>>	onScrollProperty()	Defines a function to be called when user performs a scrolling action.
final ObjectProperty<EventHandler<? super ScrollEvent>>	onScrollStartedProperty()	Defines a function to be called when a scrolling gesture is detected.
final ObjectProperty<EventHandler<? super SwipeEvent>>	onSwipeDownProperty()	Defines a function to be called when a downward swipe gesture centered over this node happens.
final ObjectProperty<EventHandler<? super SwipeEvent>>	onSwipeLeftProperty()	Defines a function to be called when a leftward swipe gesture centered over this node happens.
final ObjectProperty<EventHandler<? super SwipeEvent>>	onSwipeRightProperty()	Defines a function to be called when an rightward swipe gesture centered over this node happens.
final ObjectProperty<EventHandler<? super SwipeEvent>>	onSwipeUpProperty()	Defines a function to be called when an upward swipe gesture centered over this node happens.
final ObjectProperty<EventHandler<? super TouchEvent>>	onTouchMovedProperty()	Defines a function to be called when a touch point is moved.
final ObjectProperty<EventHandler<? super TouchEvent>>	onTouchPressedProperty()	Defines a function to be called when a new touch point is pressed.
final ObjectProperty<EventHandler<? super TouchEvent>>	onTouchReleasedProperty()	Defines a function to be called when a touch point is released.
final ObjectProperty<EventHandler<? super TouchEvent>>	onTouchStationaryProperty()	Defines a function to be called when a touch point stays pressed and still.
final ObjectProperty<EventHandler<? super ZoomEvent>>	onZoomFinishedProperty()	Defines a function to be called when a zooming gesture ends.
final ObjectProperty<EventHandler<? super ZoomEvent>>	onZoomProperty()	Defines a function to be called when user performs a zooming action.
final ObjectProperty<EventHandler<? super ZoomEvent>>	onZoomStartedProperty()	Defines a function to be called when a zooming gesture is detected.
final DoubleProperty	opacityProperty()	Specifies how opaque (that is, solid) the Node appears.
final ReadOnlyObjectProperty<Parent>	parentProperty()	The parent of this Node.
Point2D	parentToLocal(double parentX, double parentY)	Transforms a point from the coordinate space of the parent into the local coordinate space of this Node.
Point3D	parentToLocal(double parentX, double parentY, double parentZ)	Transforms a point from the coordinate space of the parent into the local coordinate space of this Node.
Bounds	parentToLocal(Bounds parentBounds)	Transforms a rectangle from the coordinate space of the parent into the local coordinate space of this Node.
Point2D	parentToLocal(Point2D parentPoint)	Transforms a point from the coordinate space of the parent into the local coordinate space of this Node.
Point3D	parentToLocal(Point3D parentPoint)	Transforms a point from the coordinate space of the parent into the local coordinate space of this Node.
final BooleanProperty	pickOnBoundsProperty()	Defines how the picking computation is done for this node when triggered by a MouseEvent or a contains function call.
double	prefHeight(double width)	Returns the node's preferred height for use in layout calculations.
double	prefWidth(double height)	Returns the node's preferred width for use in layout calculations.
final ReadOnlyBooleanProperty	pressedProperty()	Whether or not the Node is pressed.
final void	pseudoClassStateChanged(PseudoClass pseudoClass, boolean active)	Used to specify that a pseudo-class of this Node has changed.
Object	queryAccessibleAttribute(AccessibleAttribute attribute, Object... parameters)	This method is called by the assistive technology to request the value for an attribute.
void	relocate(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> void	removeEventFilter(EventType<T> eventType, EventHandler<? super T> eventFilter)	Unregisters a previously registered event filter from this target.
final <T extends Event> void	removeEventHandler(EventType<T> eventType, EventHandler<? super T> eventHandler)	Unregisters a previously registered event handler from this target.
void	requestFocus()	Requests that this Node get the input focus, and that this Node's top-level ancestor become the focused window.
final boolean	requestFocusTraversal(TraversalDirection direction)	Requests to move the focus from this Node in the specified direction.
void	resize(double width, double height)	If the node is resizable, will set its layout bounds to the specified width and height.
void	resizeRelocate(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 DoubleProperty	rotateProperty()	Defines the angle of rotation about the Node's center, measured in degrees.
final ObjectProperty<Point3D>	rotationAxisProperty()	Defines the axis of rotation of this Node.
final DoubleProperty	scaleXProperty()	Defines the factor by which coordinates are scaled about the center of the object along the X axis of this Node.
final DoubleProperty	scaleYProperty()	Defines the factor by which coordinates are scaled about the center of the object along the Y axis of this Node.
final DoubleProperty	scaleZProperty()	Defines the factor by which coordinates are scaled about the center of the object along the Z axis of this Node.
final ReadOnlyObjectProperty<Scene>	sceneProperty()	The Scene that this Node is part of.
Point2D	sceneToLocal(double sceneX, double sceneY)	Transforms a point from the coordinate space of the scene into the local coordinate space of this Node.
Point2D	sceneToLocal(double x, double y, boolean rootScene)	Transforms a point from the coordinate space of the scene into the local coordinate space of this Node.
Point3D	sceneToLocal(double sceneX, double sceneY, double sceneZ)	Transforms a point from the coordinate space of the scene into the local coordinate space of this Node.
Bounds	sceneToLocal(Bounds sceneBounds)	Transforms a rectangle from the coordinate space of the scene into the local coordinate space of this Node.
Bounds	sceneToLocal(Bounds bounds, boolean rootScene)	Transforms a bounds from the coordinate space of the scene into the local coordinate space of this Node.
Point2D	sceneToLocal(Point2D scenePoint)	Transforms a point from the coordinate space of the scene into the local coordinate space of this Node.
Point2D	sceneToLocal(Point2D point, boolean rootScene)	Transforms a point from the coordinate space of the scene into the local coordinate space of this Node.
Point3D	sceneToLocal(Point3D scenePoint)	Transforms a point from the coordinate space of the scene into the local coordinate space of this Node.
Point2D	screenToLocal(double screenX, double screenY)	Transforms a point from the coordinate space of the Screen into the local coordinate space of this Node.
Bounds	screenToLocal(Bounds screenBounds)	Transforms a rectangle from the coordinate space of the Screen into the local coordinate space of this Node.
Point2D	screenToLocal(Point2D screenPoint)	Transforms a point from the coordinate space of the Screen into the local coordinate space of this Node.
final void	setAccessibleHelp(String value)	Sets the value of the accessibleHelp property.
final void	setAccessibleRole(AccessibleRole value)	Sets the value of the accessibleRole property.
final void	setAccessibleRoleDescription(String value)	Sets the value of the accessibleRoleDescription property.
final void	setAccessibleText(String value)	Sets the value of the accessibleText property.
final void	setBlendMode(BlendMode value)	Sets the value of the blendMode property.
final void	setCache(boolean value)	Sets the value of the cache property.
final void	setCacheHint(CacheHint value)	Sets the value of the cacheHint property.
final void	setClip(Node value)	Sets the value of the clip property.
final void	setCursor(Cursor value)	Sets the value of the cursor property.
final void	setDepthTest(DepthTest value)	Sets the value of the depthTest property.
final void	setDisable(boolean value)	Sets the value of the disable property.
protected final void	setDisabled(boolean value)	Sets the value of the disabled property.
final void	setEffect(Effect value)	Sets the value of the effect property.
final void	setEventDispatcher(EventDispatcher value)	Sets the value of the eventDispatcher property.
protected final <T extends Event> void	setEventHandler(EventType<T> eventType, EventHandler<? super T> eventHandler)	Sets the handler to use for this event type.
protected final void	setFocused(boolean value)	Sets the value of the focused property.
final void	setFocusTraversable(boolean value)	Sets the value of the focusTraversable property.
protected final void	setHover(boolean value)	Sets the value of the hover property.
final void	setId(String value)	Sets the value of the id property.
final void	setInputMethodRequests(InputMethodRequests value)	Sets the value of the inputMethodRequests property.
final void	setLayoutX(double value)	Sets the value of the layoutX property.
final void	setLayoutY(double value)	Sets the value of the layoutY property.
final void	setManaged(boolean value)	Sets the value of the managed property.
final void	setMouseTransparent(boolean value)	Sets the value of the mouseTransparent property.
final void	setNodeOrientation(NodeOrientation orientation)	Sets the value of the nodeOrientation property.
final void	setOnContextMenuRequested(EventHandler<? super ContextMenuEvent> value)	Sets the value of the onContextMenuRequested property.
final void	setOnDragDetected(EventHandler<? super MouseEvent> value)	Sets the value of the onDragDetected property.
final void	setOnDragDone(EventHandler<? super DragEvent> value)	Sets the value of the onDragDone property.
final void	setOnDragDropped(EventHandler<? super DragEvent> value)	Sets the value of the onDragDropped property.
final void	setOnDragEntered(EventHandler<? super DragEvent> value)	Sets the value of the onDragEntered property.
final void	setOnDragExited(EventHandler<? super DragEvent> value)	Sets the value of the onDragExited property.
final void	setOnDragOver(EventHandler<? super DragEvent> value)	Sets the value of the onDragOver property.
final void	setOnInputMethodTextChanged(EventHandler<? super InputMethodEvent> value)	Sets the value of the onInputMethodTextChanged property.
final void	setOnKeyPressed(EventHandler<? super KeyEvent> value)	Sets the value of the onKeyPressed property.
final void	setOnKeyReleased(EventHandler<? super KeyEvent> value)	Sets the value of the onKeyReleased property.
final void	setOnKeyTyped(EventHandler<? super KeyEvent> value)	Sets the value of the onKeyTyped property.
final void	setOnMouseClicked(EventHandler<? super MouseEvent> value)	Sets the value of the onMouseClicked property.
final void	setOnMouseDragDone(EventHandler<? super MouseDragEvent> value)	Sets the value of the onMouseDragDone property.
final void	setOnMouseDragEntered(EventHandler<? super MouseDragEvent> value)	Sets the value of the onMouseDragEntered property.
final void	setOnMouseDragExited(EventHandler<? super MouseDragEvent> value)	Sets the value of the onMouseDragExited property.
final void	setOnMouseDragged(EventHandler<? super MouseEvent> value)	Sets the value of the onMouseDragged property.
final void	setOnMouseDragOver(EventHandler<? super MouseDragEvent> value)	Sets the value of the onMouseDragOver property.
final void	setOnMouseDragReleased(EventHandler<? super MouseDragEvent> value)	Sets the value of the onMouseDragReleased property.
final void	setOnMouseEntered(EventHandler<? super MouseEvent> value)	Sets the value of the onMouseEntered property.
final void	setOnMouseExited(EventHandler<? super MouseEvent> value)	Sets the value of the onMouseExited property.
final void	setOnMouseMoved(EventHandler<? super MouseEvent> value)	Sets the value of the onMouseMoved property.
final void	setOnMousePressed(EventHandler<? super MouseEvent> value)	Sets the value of the onMousePressed property.
final void	setOnMouseReleased(EventHandler<? super MouseEvent> value)	Sets the value of the onMouseReleased property.
final void	setOnRotate(EventHandler<? super RotateEvent> value)	Sets the value of the onRotate property.
final void	setOnRotationFinished(EventHandler<? super RotateEvent> value)	Sets the value of the onRotationFinished property.
final void	setOnRotationStarted(EventHandler<? super RotateEvent> value)	Sets the value of the onRotationStarted property.
final void	setOnScroll(EventHandler<? super ScrollEvent> value)	Sets the value of the onScroll property.
final void	setOnScrollFinished(EventHandler<? super ScrollEvent> value)	Sets the value of the onScrollFinished property.
final void	setOnScrollStarted(EventHandler<? super ScrollEvent> value)	Sets the value of the onScrollStarted property.
final void	setOnSwipeDown(EventHandler<? super SwipeEvent> value)	Sets the value of the onSwipeDown property.
final void	setOnSwipeLeft(EventHandler<? super SwipeEvent> value)	Sets the value of the onSwipeLeft property.
final void	setOnSwipeRight(EventHandler<? super SwipeEvent> value)	Sets the value of the onSwipeRight property.
final void	setOnSwipeUp(EventHandler<? super SwipeEvent> value)	Sets the value of the onSwipeUp property.
final void	setOnTouchMoved(EventHandler<? super TouchEvent> value)	Sets the value of the onTouchMoved property.
final void	setOnTouchPressed(EventHandler<? super TouchEvent> value)	Sets the value of the onTouchPressed property.
final void	setOnTouchReleased(EventHandler<? super TouchEvent> value)	Sets the value of the onTouchReleased property.
final void	setOnTouchStationary(EventHandler<? super TouchEvent> value)	Sets the value of the onTouchStationary property.
final void	setOnZoom(EventHandler<? super ZoomEvent> value)	Sets the value of the onZoom property.
final void	setOnZoomFinished(EventHandler<? super ZoomEvent> value)	Sets the value of the onZoomFinished property.
final void	setOnZoomStarted(EventHandler<? super ZoomEvent> value)	Sets the value of the onZoomStarted property.
final void	setOpacity(double value)	Sets the value of the opacity property.
final void	setPickOnBounds(boolean value)	Sets the value of the pickOnBounds property.
protected final void	setPressed(boolean value)	Sets the value of the pressed property.
final void	setRotate(double value)	Sets the value of the rotate property.
final void	setRotationAxis(Point3D value)	Sets the value of the rotationAxis property.
final void	setScaleX(double value)	Sets the value of the scaleX property.
final void	setScaleY(double value)	Sets the value of the scaleY property.
final void	setScaleZ(double value)	Sets the value of the scaleZ property.
final void	setStyle(String value)	A string representation of the CSS style associated with this specific Node.
final void	setTranslateX(double value)	Sets the value of the translateX property.
final void	setTranslateY(double value)	Sets the value of the translateY property.
final void	setTranslateZ(double value)	Sets the value of the translateZ property.
void	setUserData(Object value)	Convenience method for setting a single Object property that can be retrieved at a later date.
final void	setViewOrder(double value)	Sets the value of the viewOrder property.
final void	setVisible(boolean value)	Sets the value of the visible property.
WritableImage	snapshot(SnapshotParameters params, WritableImage image)	Takes a snapshot of this node and returns the rendered image when it is ready.
void	snapshot(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.
Dragboard	startDragAndDrop(TransferMode... transferModes)	Confirms a potential drag and drop gesture that is recognized over this Node.
void	startFullDrag()	Starts a full press-drag-release gesture with this node as gesture source.
final StringProperty	styleProperty()	A string representation of the CSS style associated with this specific Node.
void	toBack()	Moves this Node to the back of its sibling nodes in terms of z-order.
void	toFront()	Moves this Node to the front of its sibling nodes in terms of z-order.
final DoubleProperty	translateXProperty()	Defines the x coordinate of the translation that is added to this Node's transform.
final DoubleProperty	translateYProperty()	Defines the y coordinate of the translation that is added to this Node's transform.
final DoubleProperty	translateZProperty()	Defines the Z coordinate of the translation that is added to the transformed coordinates of this Node.
boolean	usesMirroring()	Determines whether a node should be mirrored when node orientation is right-to-left.
final DoubleProperty	viewOrderProperty()	Defines the rendering and picking order of this Node within its parent.
final BooleanProperty	visibleProperty()	Specifies whether this Node and 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, wait

Methods declared in interface Styleable

getStyleableNode

Modifier and Type	Method	Description
default Node	getStyleableNode()	Returns the Node that represents this Styleable object.

Property Details

text

public final StringProperty textProperty

Defines text string that is to be displayed.

Default value:

empty string

See Also:

• getText()
• setText(String)
• textProperty()

x

public final DoubleProperty xProperty

Defines the X coordinate of text origin.

Default value:

0

See Also:

• getX()
• setX(double)
• xProperty()

y

public final DoubleProperty yProperty

Defines the Y coordinate of text origin.

Default value:

0

See Also:

• getY()
• setY(double)
• yProperty()

font

public final ObjectProperty<Font> fontProperty

Defines the font of text.

Default value:

Font{}

See Also:

• getFont()
• setFont(Font)
• fontProperty()

textOrigin

public final ObjectProperty<VPos> textOriginProperty

Defines the origin of text coordinate system in local coordinates. Note: in case multiple rows are rendered VPos.BASELINE and VPos.TOP define the origin of the top row while VPos.BOTTOM defines the origin of the bottom row.

Default value:

VPos.BASELINE

See Also:

• getTextOrigin()
• setTextOrigin(VPos)
• textOriginProperty()

boundsType

public final ObjectProperty<TextBoundsType> boundsTypeProperty

Determines how the bounds of the text node are calculated. Logical bounds is a more appropriate default for text than the visual bounds. See TextBoundsType for more information.

Default value:

TextBoundsType.LOGICAL

See Also:

• getBoundsType()
• setBoundsType(TextBoundsType)
• boundsTypeProperty()

wrappingWidth

public final DoubleProperty wrappingWidthProperty

Defines a width constraint for the text in user space coordinates. The width is measured in pixels (and not glyph or character count). If the value is > 0 text will be line wrapped as needed to satisfy this constraint.

Default value:

0

See Also:

• getWrappingWidth()
• setWrappingWidth(double)
• wrappingWidthProperty()

underline

public final BooleanProperty underlineProperty

Defines if each line of text should have a line below it.

Default value:

false

See Also:

• isUnderline()
• setUnderline(boolean)
• underlineProperty()

strikethrough

public final BooleanProperty strikethroughProperty

Defines if each line of text should have a line through it.

Default value:

false

See Also:

• isStrikethrough()
• setStrikethrough(boolean)
• strikethroughProperty()

textAlignment

public final ObjectProperty<TextAlignment> textAlignmentProperty

Defines horizontal text alignment in the bounding box. The width of the bounding box is defined by the widest row. Note: In the case of a single line of text, where the width of the node is determined by the width of the text, the alignment setting has no effect.

Default value:

TextAlignment.LEFT

See Also:

• getTextAlignment()
• setTextAlignment(TextAlignment)
• textAlignmentProperty()

lineSpacing

public final DoubleProperty lineSpacingProperty

Defines the vertical space in pixel between lines.

Default value:

0

Since:

JavaFX 8.0

See Also:

• getLineSpacing()
• setLineSpacing(double)
• lineSpacingProperty()

baselineOffset

public final ReadOnlyDoubleProperty baselineOffsetProperty

The 'alphabetic' (or roman) baseline offset from the Text node's layoutBounds.minY location. The value typically corresponds to the max ascent of the font.

See Also:

• getBaselineOffset()
• baselineOffsetProperty()

fontSmoothingType

public final ObjectProperty<FontSmoothingType> fontSmoothingTypeProperty

Specifies a requested font smoothing type: gray or LCD.

Note: LCD mode doesn't apply in numerous cases, such as various compositing modes, where effects are applied and very large glyphs.

Default value:

FontSmoothingType.GRAY

Since:

JavaFX 2.1

See Also:

• getFontSmoothingType()
• setFontSmoothingType(FontSmoothingType)
• fontSmoothingTypeProperty()

selectionShape

public final ReadOnlyObjectProperty<PathElement[]> selectionShapeProperty

The shape of the selection in local coordinates.

Since:

9

See Also:

• getSelectionShape()
• selectionShapeProperty()

selectionStart

public final IntegerProperty selectionStartProperty

The start index of the selection in the content. If the value is -1, the selection is unset.

Default value:

-1

Since:

9

See Also:

• getSelectionStart()
• setSelectionStart(int)
• selectionStartProperty()

selectionEnd

public final IntegerProperty selectionEndProperty

The end index of the selection in the content. If the value is -1, the selection is unset.

Default value:

-1

Since:

9

See Also:

• getSelectionEnd()
• setSelectionEnd(int)
• selectionEndProperty()

selectionFill

public final ObjectProperty<Paint> selectionFillProperty

The fill color of selected text.

Since:

9

See Also:

• getSelectionFill()
• setSelectionFill(Paint)
• selectionFillProperty()

caretShape

public final ReadOnlyObjectProperty<PathElement[]> caretShapeProperty

The shape of caret, in local coordinates.

Since:

9

See Also:

• getCaretShape()
• caretShapeProperty()

caretPosition

public final IntegerProperty caretPositionProperty

The caret index in the content. If the value is -1, the caret is unset.

Default value:

-1

Since:

9

See Also:

• getCaretPosition()
• setCaretPosition(int)
• caretPositionProperty()

caretBias

public final BooleanProperty caretBiasProperty

The type of caret bias in the content. If true, the bias is towards the leading character edge, otherwise, the bias is towards the trailing character edge.

Default value:

true

Since:

9

See Also:

• isCaretBias()
• setCaretBias(boolean)
• caretBiasProperty()

tabSize

public final IntegerProperty tabSizeProperty

The size of a tab stop in spaces. Values less than 1 are treated as 1.

Default value:

8

Since:

14

See Also:

• getTabSize()
• setTabSize(int)
• tabSizeProperty()

Constructor Details

Text

public Text()

Creates an empty instance of Text.

Text

public Text(String text)

Creates an instance of Text containing the given string.

Parameters:

text - text to be contained in the instance

Text

public Text(double x,
 double y,
 String text)

Creates an instance of Text on the given coordinates containing the given string.

Parameters:

x - the horizontal position of the text

y - the vertical position of the text

text - text to be contained in the instance

Method Details

setText

public final void setText(String value)

Sets the value of the text property.

Property description:

Defines text string that is to be displayed.

Default value:

empty string

Parameters:

value - the value for the text property

See Also:

• getText()
• textProperty()

getText

public final String getText()

Gets the value of the text property.

Property description:

Defines text string that is to be displayed.

Default value:

empty string

Returns:

the value of the text property

See Also:

• setText(String)
• textProperty()

textProperty

public final StringProperty textProperty()

Defines text string that is to be displayed.

Default value:

empty string

Returns:

the text property

See Also:

• getText()
• setText(String)

setX

public final void setX(double value)

Sets the value of the x property.

Property description:

Defines the X coordinate of text origin.

Default value:

0

Parameters:

value - the value for the x property

See Also:

• getX()
• xProperty()

getX

public final double getX()

Gets the value of the x property.

Property description:

Defines the X coordinate of text origin.

Default value:

0

Returns:

the value of the x property

See Also:

• setX(double)
• xProperty()

xProperty

public final DoubleProperty xProperty()

Defines the X coordinate of text origin.

Default value:

0

Returns:

the x property

See Also:

• getX()
• setX(double)

setY

public final void setY(double value)

Sets the value of the y property.

Property description:

Defines the Y coordinate of text origin.

Default value:

0

Parameters:

value - the value for the y property

See Also:

• getY()
• yProperty()

getY

public final double getY()

Gets the value of the y property.

Property description:

Defines the Y coordinate of text origin.

Default value:

0

Returns:

the value of the y property

See Also:

• setY(double)
• yProperty()

yProperty

public final DoubleProperty yProperty()

Defines the Y coordinate of text origin.

Default value:

0

Returns:

the y property

See Also:

• getY()
• setY(double)

setFont

public final void setFont(Font value)

Sets the value of the font property.

Property description:

Defines the font of text.

Default value:

Font{}

Parameters:

value - the value for the font property

See Also:

• getFont()
• fontProperty()

getFont

public final Font getFont()

Gets the value of the font property.

Property description:

Defines the font of text.

Default value:

Font{}

Returns:

the value of the font property

See Also:

• setFont(Font)
• fontProperty()

fontProperty

public final ObjectProperty<Font> fontProperty()

Defines the font of text.

Default value:

Font{}

Returns:

the font property

See Also:

• getFont()
• setFont(Font)

setTextOrigin

public final void setTextOrigin(VPos value)

Sets the value of the textOrigin property.

Property description:

Defines the origin of text coordinate system in local coordinates. Note: in case multiple rows are rendered VPos.BASELINE and VPos.TOP define the origin of the top row while VPos.BOTTOM defines the origin of the bottom row.

Default value:

VPos.BASELINE

Parameters:

value - the value for the textOrigin property

See Also:

• getTextOrigin()
• textOriginProperty()

getTextOrigin

public final VPos getTextOrigin()

Gets the value of the textOrigin property.

Property description:

Defines the origin of text coordinate system in local coordinates. Note: in case multiple rows are rendered VPos.BASELINE and VPos.TOP define the origin of the top row while VPos.BOTTOM defines the origin of the bottom row.

Default value:

VPos.BASELINE

Returns:

the value of the textOrigin property

See Also:

• setTextOrigin(VPos)
• textOriginProperty()

textOriginProperty

public final ObjectProperty<VPos> textOriginProperty()

Defines the origin of text coordinate system in local coordinates. Note: in case multiple rows are rendered VPos.BASELINE and VPos.TOP define the origin of the top row while VPos.BOTTOM defines the origin of the bottom row.

Default value:

VPos.BASELINE

Returns:

the origin of text coordinate system in local coordinates

See Also:

• getTextOrigin()
• setTextOrigin(VPos)

setBoundsType

public final void setBoundsType(TextBoundsType value)

Sets the value of the boundsType property.

Property description:

Determines how the bounds of the text node are calculated. Logical bounds is a more appropriate default for text than the visual bounds. See TextBoundsType for more information.

Default value:

TextBoundsType.LOGICAL

Parameters:

value - the value for the boundsType property

See Also:

• getBoundsType()
• boundsTypeProperty()

getBoundsType

public final TextBoundsType getBoundsType()

Gets the value of the boundsType property.

Property description:

Determines how the bounds of the text node are calculated. Logical bounds is a more appropriate default for text than the visual bounds. See TextBoundsType for more information.

Default value:

TextBoundsType.LOGICAL

Returns:

the value of the boundsType property

See Also:

• setBoundsType(TextBoundsType)
• boundsTypeProperty()

boundsTypeProperty

public final ObjectProperty<TextBoundsType> boundsTypeProperty()

Determines how the bounds of the text node are calculated. Logical bounds is a more appropriate default for text than the visual bounds. See TextBoundsType for more information.

Default value:

TextBoundsType.LOGICAL

Returns:

the boundsType property

See Also:

• getBoundsType()
• setBoundsType(TextBoundsType)

setWrappingWidth

public final void setWrappingWidth(double value)

Sets the value of the wrappingWidth property.

Property description:

Defines a width constraint for the text in user space coordinates. The width is measured in pixels (and not glyph or character count). If the value is > 0 text will be line wrapped as needed to satisfy this constraint.

Default value:

0

Parameters:

value - the value for the wrappingWidth property

See Also:

• getWrappingWidth()
• wrappingWidthProperty()

getWrappingWidth

public final double getWrappingWidth()

Gets the value of the wrappingWidth property.

Property description:

Defines a width constraint for the text in user space coordinates. The width is measured in pixels (and not glyph or character count). If the value is > 0 text will be line wrapped as needed to satisfy this constraint.

Default value:

0

Returns:

the value of the wrappingWidth property

See Also:

• setWrappingWidth(double)
• wrappingWidthProperty()

wrappingWidthProperty

public final DoubleProperty wrappingWidthProperty()

Defines a width constraint for the text in user space coordinates. The width is measured in pixels (and not glyph or character count). If the value is > 0 text will be line wrapped as needed to satisfy this constraint.

Default value:

0

Returns:

the wrappingWidth property

See Also:

• getWrappingWidth()
• setWrappingWidth(double)

setUnderline

public final void setUnderline(boolean value)

Sets the value of the underline property.

Property description:

Defines if each line of text should have a line below it.

Default value:

false

Parameters:

value - the value for the underline property

See Also:

• isUnderline()
• underlineProperty()

isUnderline

public final boolean isUnderline()

Gets the value of the underline property.

Property description:

Defines if each line of text should have a line below it.

Default value:

false

Returns:

the value of the underline property

See Also:

• setUnderline(boolean)
• underlineProperty()

underlineProperty

public final BooleanProperty underlineProperty()

Defines if each line of text should have a line below it.

Default value:

false

Returns:

if each line of text should have a line below it

See Also:

• isUnderline()
• setUnderline(boolean)

setStrikethrough

public final void setStrikethrough(boolean value)

Sets the value of the strikethrough property.

Property description:

Defines if each line of text should have a line through it.

Default value:

false

Parameters:

value - the value for the strikethrough property

See Also:

• isStrikethrough()
• strikethroughProperty()

isStrikethrough

public final boolean isStrikethrough()

Gets the value of the strikethrough property.

Property description:

Defines if each line of text should have a line through it.

Default value:

false

Returns:

the value of the strikethrough property

See Also:

• setStrikethrough(boolean)
• strikethroughProperty()

strikethroughProperty

public final BooleanProperty strikethroughProperty()

Defines if each line of text should have a line through it.

Default value:

false

Returns:

if each line of text should have a line through it

See Also:

• isStrikethrough()
• setStrikethrough(boolean)

setTextAlignment

public final void setTextAlignment(TextAlignment value)

Sets the value of the textAlignment property.

Property description:

Defines horizontal text alignment in the bounding box. The width of the bounding box is defined by the widest row. Note: In the case of a single line of text, where the width of the node is determined by the width of the text, the alignment setting has no effect.

Default value:

TextAlignment.LEFT

Parameters:

value - the value for the textAlignment property

See Also:

• getTextAlignment()
• textAlignmentProperty()

getTextAlignment

public final TextAlignment getTextAlignment()

Gets the value of the textAlignment property.

Property description:

Defines horizontal text alignment in the bounding box. The width of the bounding box is defined by the widest row. Note: In the case of a single line of text, where the width of the node is determined by the width of the text, the alignment setting has no effect.

Default value:

TextAlignment.LEFT

Returns:

the value of the textAlignment property

See Also:

• setTextAlignment(TextAlignment)
• textAlignmentProperty()

textAlignmentProperty

public final ObjectProperty<TextAlignment> textAlignmentProperty()

Defines horizontal text alignment in the bounding box. The width of the bounding box is defined by the widest row. Note: In the case of a single line of text, where the width of the node is determined by the width of the text, the alignment setting has no effect.

Default value:

TextAlignment.LEFT

Returns:

the horizontal text alignment in the bounding box

See Also:

• getTextAlignment()
• setTextAlignment(TextAlignment)

setLineSpacing

public final void setLineSpacing(double spacing)

Sets the value of the lineSpacing property.

Property description:

Defines the vertical space in pixel between lines.

Default value:

0

Parameters:

spacing - the value for the lineSpacing property

Since:

JavaFX 8.0

See Also:

• getLineSpacing()
• lineSpacingProperty()

getLineSpacing

public final double getLineSpacing()

Gets the value of the lineSpacing property.

Property description:

Defines the vertical space in pixel between lines.

Default value:

0

Returns:

the value of the lineSpacing property

Since:

JavaFX 8.0

See Also:

• setLineSpacing(double)
• lineSpacingProperty()

lineSpacingProperty

public final DoubleProperty lineSpacingProperty()

Defines the vertical space in pixel between lines.

Default value:

0

Returns:

the vertical space in pixel between lines

Since:

JavaFX 8.0

See Also:

• getLineSpacing()
• setLineSpacing(double)

getBaselineOffset

public final double getBaselineOffset()

Gets the value of the baselineOffset property.

Overrides:

getBaselineOffset in class Node

Property description:

The 'alphabetic' (or roman) baseline offset from the Text node's layoutBounds.minY location. The value typically corresponds to the max ascent of the font.

Returns:

the value of the baselineOffset property

See Also:

• baselineOffsetProperty()

baselineOffsetProperty

public final ReadOnlyDoubleProperty baselineOffsetProperty()

The 'alphabetic' (or roman) baseline offset from the Text node's layoutBounds.minY location. The value typically corresponds to the max ascent of the font.

Returns:

the baseline offset from this text node

See Also:

• getBaselineOffset()

setFontSmoothingType

public final void setFontSmoothingType(FontSmoothingType value)

Sets the value of the fontSmoothingType property.

Property description:

Specifies a requested font smoothing type: gray or LCD.

Note: LCD mode doesn't apply in numerous cases, such as various compositing modes, where effects are applied and very large glyphs.

Default value:

FontSmoothingType.GRAY

Parameters:

value - the value for the fontSmoothingType property

Since:

JavaFX 2.1

See Also:

• getFontSmoothingType()
• fontSmoothingTypeProperty()

getFontSmoothingType

public final FontSmoothingType getFontSmoothingType()

Gets the value of the fontSmoothingType property.

Property description:

Specifies a requested font smoothing type: gray or LCD.

Note: LCD mode doesn't apply in numerous cases, such as various compositing modes, where effects are applied and very large glyphs.

Default value:

FontSmoothingType.GRAY

Returns:

the value of the fontSmoothingType property

Since:

JavaFX 2.1

See Also:

• setFontSmoothingType(FontSmoothingType)
• fontSmoothingTypeProperty()

fontSmoothingTypeProperty

public final ObjectProperty<FontSmoothingType> fontSmoothingTypeProperty()

Specifies a requested font smoothing type: gray or LCD.

Note: LCD mode doesn't apply in numerous cases, such as various compositing modes, where effects are applied and very large glyphs.

Default value:

FontSmoothingType.GRAY

Returns:

the fontSmoothingType property

Since:

JavaFX 2.1

See Also:

• getFontSmoothingType()
• setFontSmoothingType(FontSmoothingType)

getSelectionShape

public final PathElement[] getSelectionShape()

Gets the value of the selectionShape property.

Property description:

The shape of the selection in local coordinates.

Returns:

the value of the selectionShape property

Since:

9

See Also:

• selectionShapeProperty()

selectionShapeProperty

public final ReadOnlyObjectProperty<PathElement[]> selectionShapeProperty()

The shape of the selection in local coordinates.

Returns:

the selectionShape property

Since:

9

See Also:

• getSelectionShape()

setSelectionStart

public final void setSelectionStart(int value)

Sets the value of the selectionStart property.

Property description:

The start index of the selection in the content. If the value is -1, the selection is unset.

Default value:

-1

Parameters:

value - the value for the selectionStart property

Since:

9

See Also:

• getSelectionStart()
• selectionStartProperty()

getSelectionStart

public final int getSelectionStart()

Gets the value of the selectionStart property.

Property description:

The start index of the selection in the content. If the value is -1, the selection is unset.

Default value:

-1

Returns:

the value of the selectionStart property

Since:

9

See Also:

• setSelectionStart(int)
• selectionStartProperty()

selectionStartProperty

public final IntegerProperty selectionStartProperty()

The start index of the selection in the content. If the value is -1, the selection is unset.

Default value:

-1

Returns:

the selectionStart property

Since:

9

See Also:

• getSelectionStart()
• setSelectionStart(int)

setSelectionEnd

public final void setSelectionEnd(int value)

Sets the value of the selectionEnd property.

Property description:

The end index of the selection in the content. If the value is -1, the selection is unset.

Default value:

-1

Parameters:

value - the value for the selectionEnd property

Since:

9

See Also:

• getSelectionEnd()
• selectionEndProperty()

getSelectionEnd

public final int getSelectionEnd()

Gets the value of the selectionEnd property.

Property description:

The end index of the selection in the content. If the value is -1, the selection is unset.

Default value:

-1

Returns:

the value of the selectionEnd property

Since:

9

See Also:

• setSelectionEnd(int)
• selectionEndProperty()

selectionEndProperty

public final IntegerProperty selectionEndProperty()

The end index of the selection in the content. If the value is -1, the selection is unset.

Default value:

-1

Returns:

the selectionEnd property

Since:

9

See Also:

• getSelectionEnd()
• setSelectionEnd(int)

selectionFillProperty

public final ObjectProperty<Paint> selectionFillProperty()

The fill color of selected text.

Returns:

the fill color of selected text

Since:

9

See Also:

• getSelectionFill()
• setSelectionFill(Paint)

setSelectionFill

public final void setSelectionFill(Paint paint)

Sets the value of the selectionFill property.

Property description:

The fill color of selected text.

Parameters:

paint - the value for the selectionFill property

Since:

9

See Also:

• getSelectionFill()
• selectionFillProperty()

getSelectionFill

public final Paint getSelectionFill()

Gets the value of the selectionFill property.

Property description:

The fill color of selected text.

Returns:

the value of the selectionFill property

Since:

9

See Also:

• setSelectionFill(Paint)
• selectionFillProperty()

getCaretShape

public final PathElement[] getCaretShape()

Gets the value of the caretShape property.

Property description:

The shape of caret, in local coordinates.

Returns:

the value of the caretShape property

Since:

9

See Also:

• caretShapeProperty()

caretShapeProperty

public final ReadOnlyObjectProperty<PathElement[]> caretShapeProperty()

The shape of caret, in local coordinates.

Returns:

the caretShape property

Since:

9

See Also:

• getCaretShape()

setCaretPosition

public final void setCaretPosition(int value)

Sets the value of the caretPosition property.

Property description:

The caret index in the content. If the value is -1, the caret is unset.

Default value:

-1

Parameters:

value - the value for the caretPosition property

Since:

9

See Also:

• getCaretPosition()
• caretPositionProperty()

getCaretPosition

public final int getCaretPosition()

Gets the value of the caretPosition property.

Property description:

The caret index in the content. If the value is -1, the caret is unset.

Default value:

-1

Returns:

the value of the caretPosition property

Since:

9

See Also:

• setCaretPosition(int)
• caretPositionProperty()

caretPositionProperty

public final IntegerProperty caretPositionProperty()

The caret index in the content. If the value is -1, the caret is unset.

Default value:

-1

Returns:

the caretPosition property

Since:

9

See Also:

• getCaretPosition()
• setCaretPosition(int)

setCaretBias

public final void setCaretBias(boolean value)

Sets the value of the caretBias property.

Property description:

The type of caret bias in the content. If true, the bias is towards the leading character edge, otherwise, the bias is towards the trailing character edge.

Default value:

true

Parameters:

value - the value for the caretBias property

Since:

9

See Also:

• isCaretBias()
• caretBiasProperty()

isCaretBias

public final boolean isCaretBias()

Gets the value of the caretBias property.

Property description:

The type of caret bias in the content. If true, the bias is towards the leading character edge, otherwise, the bias is towards the trailing character edge.

Default value:

true

Returns:

the value of the caretBias property

Since:

9

See Also:

• setCaretBias(boolean)
• caretBiasProperty()

caretBiasProperty

public final BooleanProperty caretBiasProperty()

The type of caret bias in the content. If true, the bias is towards the leading character edge, otherwise, the bias is towards the trailing character edge.

Default value:

true

Returns:

the caretBias property

Since:

9

See Also:

• isCaretBias()
• setCaretBias(boolean)

hitTest

public final HitInfo hitTest(Point2D point)

Maps local point to HitInfo in the content.

Parameters:

point - the specified point to be tested

Returns:

a HitInfo representing the character index found

Since:

9

caretShape

public final PathElement[] caretShape(int charIndex,
 boolean caretBias)

Returns the shape for the caret at the given index and bias.

Parameters:

charIndex - the character index for the caret

caretBias - whether the caret is biased on the leading edge of the character

Returns:

an array of PathElement which can be used to create a Shape

Since:

9

rangeShape

public final PathElement[] rangeShape(int start,
 int end)

Returns the shape for the range of the text in local coordinates. The returned value does not include line spacing.

Parameters:

start - the beginning character index for the range

end - the end character index (non-inclusive) for the range

Returns:

an array of PathElement which can be used to create a Shape

Since:

9

See Also:

• getRangeShape(int, int, boolean)

getRangeShape

public final PathElement[] getRangeShape(int start,
 int end,
 boolean includeLineSpacing)

Returns the shape for the range of the text in local coordinates, with or without line spacing.

Parameters:

start - the beginning character index for the range

end - the end character index (non-inclusive) for the range

includeLineSpacing - whether the shapes include line spacing

Returns:

an array of PathElement which can be used to create a Shape

Since:

25

underlineShape

public final PathElement[] underlineShape(int start,
 int end)

Returns the shape for the underline in local coordinates.

Parameters:

start - the beginning character index for the range

end - the end character index (non-inclusive) for the range

Returns:

an array of PathElement which can be used to create a Shape

Since:

9

getStrikeThroughShape

public final PathElement[] getStrikeThroughShape(int start,
 int end)

Returns the shape for the strike-through in local coordinates.

Parameters:

start - the beginning character index for the range

end - the end character index (non-inclusive) for the range

Returns:

an array of PathElement which can be used to create a Shape

Since:

25

tabSizeProperty

public final IntegerProperty tabSizeProperty()

The size of a tab stop in spaces. Values less than 1 are treated as 1.

Default value:

8

Returns:

the tabSize property

Since:

14

See Also:

• getTabSize()
• setTabSize(int)

getTabSize

public final int getTabSize()

Gets the value of the tabSize property.

Property description:

The size of a tab stop in spaces. Values less than 1 are treated as 1.

Default value:

8

Returns:

the value of the tabSize property

Since:

14

See Also:

• setTabSize(int)
• tabSizeProperty()

setTabSize

public final void setTabSize(int spaces)

Sets the value of the tabSize property.

Property description:

The size of a tab stop in spaces. Values less than 1 are treated as 1.

Default value:

8

Parameters:

spaces - the value for the tabSize property

Since:

14

See Also:

• getTabSize()
• tabSizeProperty()

getClassCssMetaData

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

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

Returns:

the CssMetaData

Since:

JavaFX 8.0

getCssMetaData

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

This method should delegate to Node.getClassCssMetaData() so that a Node's CssMetaData can be accessed without the need for reflection.

Specified by:

getCssMetaData in interface Styleable

Overrides:

getCssMetaData in class Shape

Returns:

The CssMetaData associated with this node, which may include the CssMetaData of its superclasses.

Since:

JavaFX 8.0

toString

public String toString()

Returns a string representation of this Text object.

Overrides:

toString in class Node

Returns:

a string representation of this Text object.

getLayoutInfo

public final LayoutInfo getLayoutInfo()

Returns a copy of the of the text layout geometry for this node. This copy is a snapshot of the text layout at the time the method is called.

While there is no general guarantee that successive invocations of this method return the same instance, it is safe to either cache this object or call this method each time, since the information obtained from this lightweight object remains valid until the next layout cycle.

Returns:

a copy of the layout information

Since:

25