JavaFX 25 · javafx.scene.text.TextFlow · APIdia, the JavaDoc alternative

A specialized layout for rich text. It can be used to lay out several Text nodes in a single text flow. TextFlow uses the text and the font of each Text node inside of it, plus its own width and text alignment to determine the location for each child. A single Text node can span over several lines due to wrapping, and the visual location of the Text node can differ from the logical location due to bidi reordering.

Any Node other than Text will be treated as an embedded object in the text layout. It will be inserted in the content using its preferred width, height, and baseline offset.

When a Text node is inside a TextFlow, some of its properties are ignored. For example, the x and y properties of the Text node are ignored since the location of the node is determined by the parent. Likewise, the wrapping width in the Text node is ignored since the width used for wrapping is the TextFlow's width. The value of the pickOnBounds property of a Text node is set to false when it is laid out by the TextFlow. This happens because the content of a single Text node can be split and placed in different locations in the TextFlow (usually due to line breaking and bidi reordering).

The wrapping width of the layout is determined by the region's current width. It can be specified by the application by setting the TextFlow's preferred width. If no wrapping is desired, the application can either set the preferred with to Double.MAX_VALUE or Region.USE_COMPUTED_SIZE.

Paragraphs are separated by '\n' present in any Text child.

Example of a TextFlow:

Text text1 = new Text("Big italic red text");
    text1.setFill(Color.RED);
    text1.setFont(Font.font("Helvetica", FontPosture.ITALIC, 40));
    Text text2 = new Text(" little bold blue text");
    text2.setFill(Color.BLUE);
    text2.setFont(Font.font("Helvetica", FontWeight.BOLD, 10));
    TextFlow textFlow = new TextFlow(text1, text2);

TextFlow lays out each managed child regardless of the child's visible property value; unmanaged children are ignored for all layout calculations.

TextFlow may be styled with backgrounds and borders using CSS. See its Region superclass for details.

Resizable Range

A TextFlow's parent will resize the TextFlow within the TextFlow's range during layout. By default, the TextFlow computes this range based on its content as outlined in the tables below.

TextFlow Resize Table
	width	height
minimum	left/right insets	top/bottom insets plus the height of the text content
preferred	left/right insets plus the width of the text content	top/bottom insets plus the height of the text content
maximum	`Double.MAX_VALUE`	`Double.MAX_VALUE`

A TextFlow's unbounded maximum width and height are an indication to the parent that it may be resized beyond its preferred size to fill whatever space is assigned to it.

TextFlow provides properties for setting the size range directly. These properties default to the sentinel value Region.USE_COMPUTED_SIZE, however the application may set them to other values as needed:


    textflow.setMaxWidth(500);

Applications may restore the computed values by setting these properties back to Region.USE_COMPUTED_SIZE.

TextFlow does not clip its content by default, so it is possible that children's bounds may extend outside of its own bounds if a child's preferred size is larger than the space the TextFlow has to allocate for it.

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	TextFlow.EmbeddedSpan
private static class	TextFlow.StyleableProperties

Field Summary

Modifier and Type	Field and Description
private boolean	inLayout
private TextLayout	layout
private DoubleProperty	lineSpacing Defines the vertical space in pixel between lines.
private boolean	needsContent
private IntegerProperty	tabSize The size of a tab stop in spaces.
private SimpleObjectProperty<TabStopPolicy>	tabStopPolicy Determines the tab stop positions within this `TextFlow`.
private ObjectProperty<TextAlignment>	textAlignment Defines horizontal text alignment.

Constructor Summary

Access	Constructor and Description
public	TextFlow() Creates an empty TextFlow layout.
public	TextFlow(Node... children. children) Creates a TextFlow layout with the given children.

Method Summary

Modifier and Type	Method and Description
pack-priv static double	boundedSize(double min, double pref, double max) Hides javafx.scene.layout.Region.boundedSize. Computes the value based on the given min and max values.
public PathElement[]	Returns: an array of `PathElement` which can be used to create a `Shape` caretShape(int the character index for the caret charIndex, boolean whether the caret is biased on the leading edge of the character leading) Deprecated since 25. replaced by `getCaretShape(int, boolean)` Returns shape of caret in local coordinates.
private void	checkOrientation()
pack-priv double	computeChildPrefAreaHeight(Node child, Insets margin) Hides javafx.scene.layout.Region.computeChildPrefAreaHeight.
pack-priv double	computeChildPrefAreaHeight(Node child, Insets margin, double width)
pack-priv double	computeChildPrefAreaWidth(Node child, Insets margin) Hides javafx.scene.layout.Region.computeChildPrefAreaWidth.
pack-priv double	computeChildPrefAreaWidth(Node child, Insets margin, double height)
protected double	computeMinHeight(double width) Overrides javafx.scene.layout.Region.computeMinHeight. Computes the minimum height of this region.
protected double	computePrefHeight(double width) Overrides javafx.scene.layout.Region.computePrefHeight. Computes the preferred height of this region for the given width; Region subclasses should override this method to return an appropriate value based on their content and layout strategy.
protected double	computePrefWidth(double height) Overrides javafx.scene.layout.Region.computePrefWidth. Computes the preferred width of this region for the given height.
public final double	getBaselineOffset() Overrides javafx.scene.Parent.getBaselineOffset. Calculates the baseline offset based on the first managed child.
public PathElement[]	Returns: an array of `PathElement` which can be used to create a `Shape` getCaretShape(int the character index for the caret charIndex, boolean whether the caret is biased on the leading edge of the character leading) Returns shape of caret in local coordinates.
public static List<CssMetaData<? extends Styleable, ?>>	Returns: the `CssMetaData` getClassCssMetaData() Hides javafx.scene.layout.Region.getClassCssMetaData. Gets the `CssMetaData` associated with this class, which may include the `CssMetaData` of its superclasses.
public Orientation	getContentBias() Overrides javafx.scene.Node.getContentBias. Returns the orientation of a node's resizing bias for layout purposes.
public List<CssMetaData<? extends Styleable, ?>>	getCssMetaData() Overrides javafx.scene.layout.Region.getCssMetaData. Implements javafx.css.Styleable.getCssMetaData. This method should delegate to `Node#getClassCssMetaData()` so that a Node's CssMetaData can be accessed without the need for reflection.
public final HitInfo	Returns: a `HitInfo` representing the character index found getHitInfo(Point2D the specified point to be tested point) Maps local point to `HitInfo` in the content.
public final LayoutInfo	Returns: a copy of the layout information getLayoutInfo() Returns a copy of the of the text layout geometry for this node.
public final double	getLineSpacing()
private PathElement[]	getRange(int start, int end, int type, boolean accountForInsets, double lineSpacing)
public final PathElement[]	Returns: an array of `PathElement` which can be used to create a `Shape` getRangeShape(int the beginning character index for the range start, int the end character index (non-inclusive) for the range end, boolean determines whether the result includes the line spacing includeLineSpacing) Returns shape for the range of the text in local coordinates.
public final PathElement[]	Returns: an array of `PathElement` which can be used to create a `Shape` getStrikeThroughShape(int the beginning character index for the range start, int the end character index (non-inclusive) for the range end) Returns the shape for the strike-through in local coordinates.
private TabAdvancePolicy	getTabAdvancePolicy()
public final int	getTabSize()
public final TabStopPolicy	getTabStopPolicy()
public final TextAlignment	getTextAlignment()
pack-priv TextLayout	getTextLayout()
public final PathElement[]	Returns: an array of `PathElement` which can be used to create a `Shape` getUnderlineShape(int the beginning character index for the range start, int the end character index (non-inclusive) for the range end) Returns the shape for the underline in local coordinates.
public final HitInfo	Returns: a `HitInfo` representing the character index found hitTest(Point2D the specified point to be tested point) Deprecated since 25. replaced by `getHitInfo(javafx.geometry.Point2D)` Maps local point to `HitInfo` in the content.
private static void	initAccessor()
protected void	layoutChildren() Overrides javafx.scene.Parent.layoutChildren. Invoked during the layout pass to layout the children in this `Parent`.
public final DoubleProperty	lineSpacingProperty()
public Object	queryAccessibleAttribute(AccessibleAttribute attribute, Object... parameters) Overrides javafx.scene.Parent.queryAccessibleAttribute. This method is called by the assistive technology to request the value for an attribute.
public final PathElement[]	Returns: an array of `PathElement` which can be used to create a `Shape` rangeShape(int the beginning character index for the range start, int the end character index (non-inclusive) for the range end) Deprecated since 25. replaced by `getRangeShape(int, int, boolean)` Returns shape for the range of the text in local coordinates.
public void	requestLayout() Overrides javafx.scene.Parent.requestLayout. Requests a layout pass to be performed before the next scene is rendered.
public final void	setLineSpacing(double spacing)
public final void	setTabSize(int spaces)
public final void	setTabStopPolicy(TabStopPolicy policy)
public final void	setTextAlignment(TextAlignment value)
protected void	setWidth(double value) Overrides javafx.scene.layout.Region.setWidth.
public final IntegerProperty	tabSizeProperty()
public final ObjectProperty<TabStopPolicy>	tabStopPolicyProperty()
public final ObjectProperty<TextAlignment>	textAlignmentProperty()
public final PathElement[]	Returns: an array of `PathElement` which can be used to create a `Shape` underlineShape(int the beginning character index for the range start, int the end character index (non-inclusive) for the range end) Deprecated since 25. replaced by `getUnderlineShape(int, int)` Returns the shape for the underline in local coordinates.
public boolean	usesMirroring() Overrides javafx.scene.Node.usesMirroring. Determines whether a node should be mirrored when node orientation is right-to-left.

Inherited from javafx.scene.layout.Pane:: getChildren

Field Detail

inLayout	back to summary
private boolean inLayout

layout	back to summary
private TextLayout layout

layout

back to summary

private TextLayout layout

lineSpacing	back to summary
private DoubleProperty lineSpacing Defines the vertical space in pixel between lines. Default Value 0 Since JavaFX 8.0

lineSpacing

back to summary

private DoubleProperty lineSpacing

Defines the vertical space in pixel between lines.

Default Value: 0
Since: JavaFX 8.0

needsContent	back to summary
private boolean needsContent

tabSize back to summary

tabSize	back to summary
private IntegerProperty tabSize The size of a tab stop in spaces. Values less than 1 are treated as 1. This value overrides the `tabSize` of contained `Text` nodes. Note that this method should not be used to control the tab placement when multiple `Text` nodes with different fonts are contained within this `TextFlow`. In this case, `setTabStopPolicy(TabStopPolicy)` should be used instead. Default Value 8 Since 14

private IntegerProperty tabSize

The size of a tab stop in spaces. Values less than 1 are treated as 1. This value overrides the tabSize of contained Text nodes.

Note that this method should not be used to control the tab placement when multiple Text nodes with different fonts are contained within this TextFlow. In this case, setTabStopPolicy(TabStopPolicy) should be used instead.

Default Value: 8
Since: 14

tabStopPolicy back to summary

tabStopPolicy	back to summary
private SimpleObjectProperty<TabStopPolicy> tabStopPolicy Determines the tab stop positions within this `TextFlow`. A non-null `TabStopPolicy` overrides values set by `setTabSize(int)`, as well as any values set by `Text#setTabSize(int)` in individual `Text` instances within this `TextFlow`. Default Value null Since 25

private SimpleObjectProperty<TabStopPolicy> tabStopPolicy

Determines the tab stop positions within this TextFlow.

A non-null TabStopPolicy overrides values set by setTabSize(int), as well as any values set by Text#setTabSize(int) in individual Text instances within this TextFlow.

Default Value: null
Since: 25

textAlignment	back to summary
private ObjectProperty<TextAlignment> textAlignment Defines horizontal text alignment. Default Value TextAlignment.LEFT

textAlignment

back to summary

private ObjectProperty<TextAlignment> textAlignment

Defines horizontal text alignment.

Default Value: TextAlignment.LEFT

Constructor Detail

TextFlow	back to summary
public TextFlow() Creates an empty TextFlow layout.

TextFlow	back to summary
public TextFlow(Node... children) Creates a TextFlow layout with the given children. Parameters children:Node[] children.

TextFlow

back to summary

public TextFlow(Node... children)

Creates a TextFlow layout with the given children.

Parameters

children:Node[]: children.

Method Detail

boundedSize	back to summary
pack-priv static double boundedSize(double min, double pref, double max) Hides javafx.scene.layout.Region.boundedSize. Doc from javafx.scene.layout.Region.boundedSize. Computes the value based on the given min and max values. We encode in this method the logic surrounding various edge cases, such as when the min is specified as greater than the max, or the max less than the min, or a pref value that exceeds either the max or min in their extremes. If the min is greater than the max, then we want to make sure the returned value is the min. In other words, in such a case, the min becomes the only acceptable return value. If the min and max values are well ordered, and the pref is less than the min then the min is returned. Likewise, if the values are well ordered and the pref is greater than the max, then the max is returned. If the pref lies between the min and the max, then the pref is returned.

boundedSize

back to summary

pack-priv static double boundedSize(double min, double pref, double max)

Hides javafx.scene.layout.Region.boundedSize.

Doc from javafx.scene.layout.Region.boundedSize.

Computes the value based on the given min and max values. We encode in this method the logic surrounding various edge cases, such as when the min is specified as greater than the max, or the max less than the min, or a pref value that exceeds either the max or min in their extremes.

If the min is greater than the max, then we want to make sure the returned value is the min. In other words, in such a case, the min becomes the only acceptable return value.

If the min and max values are well ordered, and the pref is less than the min then the min is returned. Likewise, if the values are well ordered and the pref is greater than the max, then the max is returned. If the pref lies between the min and the max, then the pref is returned.

caretShape back to summary

caretShape	back to summary
public PathElement[] caretShape(int charIndex, boolean leading) Deprecated since 25. replaced by `getCaretShape(int, boolean)` Returns shape of caret in local coordinates. Note this method does not take border or padding into account. Parameters charIndex:int the character index for the caret leading:boolean whether the caret is biased on the leading edge of the character Returns:PathElement[] an array of `PathElement` which can be used to create a `Shape` Annotations @Deprecated since:25 Since 9

public PathElement[] caretShape(int charIndex, boolean leading)

Deprecated

since 25.

replaced by getCaretShape(int, boolean)

Returns shape of caret in local coordinates.

Note

this method does not take border or padding into account.

Parameters

charIndex:int: the character index for the caret
leading:boolean: whether the caret is biased on the leading edge of the character

Returns:PathElement[]

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

Annotations

@Deprecated
since:25

Since

checkOrientation	back to summary
private void checkOrientation()

computeChildPrefAreaHeight	back to summary
pack-priv double computeChildPrefAreaHeight(Node child, Insets margin) Hides javafx.scene.layout.Region.computeChildPrefAreaHeight.

computeChildPrefAreaHeight	back to summary
pack-priv double computeChildPrefAreaHeight(Node child, Insets margin, double width)

computeChildPrefAreaWidth	back to summary
pack-priv double computeChildPrefAreaWidth(Node child, Insets margin) Hides javafx.scene.layout.Region.computeChildPrefAreaWidth.

computeChildPrefAreaWidth	back to summary
pack-priv double computeChildPrefAreaWidth(Node child, Insets margin, double height)

computeMinHeight	back to summary
protected double computeMinHeight(double width) Overrides javafx.scene.layout.Region.computeMinHeight. Doc from javafx.scene.layout.Region.computeMinHeight. Computes the minimum height of this region. Returns the sum of the top and bottom insets by default. Region subclasses should override this method to return an appropriate value based on their content and layout strategy. If the subclass doesn't have a HORIZONTAL content bias, then the width parameter can be ignored. Annotations @Override

computeMinHeight

back to summary

protected double computeMinHeight(double width)

Overrides javafx.scene.layout.Region.computeMinHeight.

Doc from javafx.scene.layout.Region.computeMinHeight.

Computes the minimum height of this region. Returns the sum of the top and bottom insets by default. Region subclasses should override this method to return an appropriate value based on their content and layout strategy. If the subclass doesn't have a HORIZONTAL content bias, then the width parameter can be ignored.

Annotations

@Override

computePrefHeight	back to summary
protected double computePrefHeight(double width) Overrides javafx.scene.layout.Region.computePrefHeight. Doc from javafx.scene.layout.Region.computePrefHeight. Computes the preferred height of this region for the given width; Region subclasses should override this method to return an appropriate value based on their content and layout strategy. If the subclass doesn't have a HORIZONTAL content bias, then the width parameter can be ignored. Annotations @Override

computePrefHeight

back to summary

protected double computePrefHeight(double width)

Overrides javafx.scene.layout.Region.computePrefHeight.

Doc from javafx.scene.layout.Region.computePrefHeight.

Computes the preferred height of this region for the given width; Region subclasses should override this method to return an appropriate value based on their content and layout strategy. If the subclass doesn't have a HORIZONTAL content bias, then the width parameter can be ignored.

Annotations

@Override

computePrefWidth	back to summary
protected double computePrefWidth(double height) Overrides javafx.scene.layout.Region.computePrefWidth. Doc from javafx.scene.layout.Region.computePrefWidth. Computes the preferred width of this region for the given height. Region subclasses should override this method to return an appropriate value based on their content and layout strategy. If the subclass doesn't have a VERTICAL content bias, then the height parameter can be ignored. Annotations @Override

computePrefWidth

back to summary

protected double computePrefWidth(double height)

Overrides javafx.scene.layout.Region.computePrefWidth.

Doc from javafx.scene.layout.Region.computePrefWidth.

Computes the preferred width of this region for the given height. Region subclasses should override this method to return an appropriate value based on their content and layout strategy. If the subclass doesn't have a VERTICAL content bias, then the height parameter can be ignored.

Annotations

@Override

getBaselineOffset back to summary

getBaselineOffset	back to summary
public final double getBaselineOffset() Overrides javafx.scene.Parent.getBaselineOffset. Doc from javafx.scene.Parent.getBaselineOffset. Calculates the baseline offset based on the first managed child. If there is no such child, returns `Node#getBaselineOffset()`. Annotations @Override

public final double getBaselineOffset()

Overrides javafx.scene.Parent.getBaselineOffset.

Doc from javafx.scene.Parent.getBaselineOffset.

Calculates the baseline offset based on the first managed child. If there is no such child, returns Node#getBaselineOffset().

Annotations

@Override

getCaretShape back to summary

getCaretShape	back to summary
public PathElement[] getCaretShape(int charIndex, boolean leading) Returns shape of caret in local coordinates. Parameters charIndex:int the character index for the caret leading:boolean whether the caret is biased on the leading edge of the character Returns:PathElement[] an array of `PathElement` which can be used to create a `Shape` Since 25

public PathElement[] getCaretShape(int charIndex, boolean leading)

Returns shape of caret in local coordinates.

Parameters

charIndex:int: the character index for the caret
leading:boolean: whether the caret is biased on the leading edge of the character

Returns:PathElement[]

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

Since

getClassCssMetaData back to summary

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

Hides javafx.scene.layout.Region.getClassCssMetaData.

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

Returns:List<CssMetaData<? extends Styleable, ?>>: the CssMetaData

getContentBias	back to summary
public Orientation getContentBias() Overrides javafx.scene.Node.getContentBias. Doc from javafx.scene.Node.getContentBias. Returns the orientation of a node's resizing bias for layout purposes. If the node type has no bias, returns null. If the node is resizable and it's height depends on its width, returns HORIZONTAL, else if its width depends on its height, returns VERTICAL. Resizable subclasses should override this method to return an appropriate value. Annotations @Override

getContentBias

back to summary

public Orientation getContentBias()

Overrides javafx.scene.Node.getContentBias.

Doc from javafx.scene.Node.getContentBias.

Returns the orientation of a node's resizing bias for layout purposes. If the node type has no bias, returns null. If the node is resizable and it's height depends on its width, returns HORIZONTAL, else if its width depends on its height, returns VERTICAL.

Resizable subclasses should override this method to return an appropriate value.

Annotations

@Override

getCssMetaData back to summary

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

Overrides javafx.scene.layout.Region.getCssMetaData.

Implements javafx.css.Styleable.getCssMetaData.

Doc from javafx.scene.layout.Region.getCssMetaData.

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

Annotations

@Override

getHitInfo back to summary

getHitInfo	back to summary
public final HitInfo getHitInfo(Point2D point) Maps local point to `HitInfo` in the content. Parameters point:Point2D the specified point to be tested Returns:HitInfo a `HitInfo` representing the character index found Since 25

public final HitInfo getHitInfo(Point2D point)

Maps local point to HitInfo in the content.

Parameters

point:Point2D: the specified point to be tested

Returns:HitInfo

a HitInfo representing the character index found

Since

getLayoutInfo	back to summary
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:LayoutInfo a copy of the layout information Since 25

getLayoutInfo

back to summary

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:LayoutInfo: a copy of the layout information
Since: 25

getLineSpacing	back to summary
public final double getLineSpacing()

getRange	back to summary
private PathElement[] getRange(int start, int end, int type, boolean accountForInsets, double lineSpacing)

getRangeShape back to summary

getRangeShape	back to summary
public final PathElement[] getRangeShape(int start, int end, boolean includeLineSpacing) Returns shape for the range of the text in local coordinates. Parameters start:int the beginning character index for the range end:int the end character index (non-inclusive) for the range includeLineSpacing:boolean determines whether the result includes the line spacing Returns:PathElement[] an array of `PathElement` which can be used to create a `Shape` Since 25 See Also `LayoutInfo#getSelectionGeometry(int, int, boolean)`

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

Returns shape for the range of the text in local coordinates.

Parameters

start:int: the beginning character index for the range
end:int: the end character index (non-inclusive) for the range
includeLineSpacing:boolean: determines whether the result includes the line spacing

Returns:PathElement[]

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

Since

getStrikeThroughShape back to summary

getStrikeThroughShape	back to summary
public final PathElement[] getStrikeThroughShape(int start, int end) Returns the shape for the strike-through in local coordinates. Parameters start:int the beginning character index for the range end:int the end character index (non-inclusive) for the range Returns:PathElement[] an array of `PathElement` which can be used to create a `Shape` Since 25 See Also `LayoutInfo#getStrikeThroughGeometry(int, int)`

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

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

Parameters

start:int: the beginning character index for the range
end:int: the end character index (non-inclusive) for the range

Returns:PathElement[]

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

Since

getTabAdvancePolicy	back to summary
private TabAdvancePolicy getTabAdvancePolicy()

getTabSize	back to summary
public final int getTabSize()

getTabStopPolicy	back to summary
public final TabStopPolicy getTabStopPolicy()

getTextAlignment	back to summary
public final TextAlignment getTextAlignment()

getTextLayout	back to summary
pack-priv TextLayout getTextLayout()

getUnderlineShape back to summary

getUnderlineShape	back to summary
public final PathElement[] getUnderlineShape(int start, int end) Returns the shape for the underline in local coordinates. Parameters start:int the beginning character index for the range end:int the end character index (non-inclusive) for the range Returns:PathElement[] an array of `PathElement` which can be used to create a `Shape` Since 25 See Also `LayoutInfo#getUnderlineGeometry(int, int)`

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

Returns the shape for the underline in local coordinates.

Parameters

start:int: the beginning character index for the range
end:int: the end character index (non-inclusive) for the range

Returns:PathElement[]

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

Since

hitTest back to summary

hitTest	back to summary
public final HitInfo hitTest(Point2D point) Deprecated since 25. replaced by `getHitInfo(javafx.geometry.Point2D)` Maps local point to `HitInfo` in the content. Note this method does not take border or padding into account. Parameters point:Point2D the specified point to be tested Returns:HitInfo a `HitInfo` representing the character index found Annotations @Deprecated since:25 Since 9

public final HitInfo hitTest(Point2D point)

Deprecated

since 25.

replaced by getHitInfo(javafx.geometry.Point2D)

Maps local point to HitInfo in the content.

Note

this method does not take border or padding into account.

Parameters

point:Point2D: the specified point to be tested

Returns:HitInfo

a HitInfo representing the character index found

Annotations

@Deprecated
since:25

Since

initAccessor	back to summary
private static void initAccessor()

layoutChildren back to summary

layoutChildren	back to summary
protected void layoutChildren() Overrides javafx.scene.Parent.layoutChildren. Doc from javafx.scene.Parent.layoutChildren. Invoked during the layout pass to layout the children in this `Parent`. By default it will only set the size of managed, resizable content to their preferred sizes and does not do any node positioning. Subclasses should override this function to layout content as needed. Annotations @Override

protected void layoutChildren()

Overrides javafx.scene.Parent.layoutChildren.

Doc from javafx.scene.Parent.layoutChildren.

Invoked during the layout pass to layout the children in this Parent. By default it will only set the size of managed, resizable content to their preferred sizes and does not do any node positioning.

Subclasses should override this function to layout content as needed.

Annotations

@Override

lineSpacingProperty	back to summary
public final DoubleProperty lineSpacingProperty()

queryAccessibleAttribute	back to summary
public Object queryAccessibleAttribute(AccessibleAttribute attribute, Object... parameters) Overrides javafx.scene.Parent.queryAccessibleAttribute. Doc from javafx.scene.Parent.queryAccessibleAttribute. This method is called by the assistive technology to request the value for an attribute. This method is commonly overridden by subclasses to implement attributes that are required for a specific role. If a particular attribute is not handled, the superclass implementation must be called. Annotations @Override

queryAccessibleAttribute

back to summary

public Object queryAccessibleAttribute(AccessibleAttribute attribute, Object... parameters)

Overrides javafx.scene.Parent.queryAccessibleAttribute.

Doc from javafx.scene.Parent.queryAccessibleAttribute.

This method is called by the assistive technology to request the value for an attribute.

This method is commonly overridden by subclasses to implement attributes that are required for a specific role.
If a particular attribute is not handled, the superclass implementation must be called.

Annotations

@Override

rangeShape back to summary

rangeShape	back to summary
public final PathElement[] rangeShape(int start, int end) Deprecated since 25. replaced by `getRangeShape(int, int, boolean)` Returns shape for the range of the text in local coordinates. NOTES: this method does not take border or padding into account the shapes returned do not include line spacing Parameters start:int the beginning character index for the range end:int the end character index (non-inclusive) for the range Returns:PathElement[] an array of `PathElement` which can be used to create a `Shape` Annotations @Deprecated since:25 Since 9

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

Deprecated

since 25.

replaced by getRangeShape(int, int, boolean)

Returns shape for the range of the text in local coordinates.

NOTES:

this method does not take border or padding into account
the shapes returned do not include line spacing

Parameters

start:int: the beginning character index for the range
end:int: the end character index (non-inclusive) for the range

Returns:PathElement[]

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

Annotations

@Deprecated
since:25

Since

requestLayout	back to summary
public void requestLayout() Overrides javafx.scene.Parent.requestLayout. Doc from javafx.scene.Parent.requestLayout. Requests a layout pass to be performed before the next scene is rendered. This is batched up asynchronously to happen once per "pulse", or frame of animation. If this parent is either a layout root or unmanaged, then it will be added directly to the scene's dirty layout list, otherwise requestParentLayout will be invoked. Annotations @Override

requestLayout

back to summary

public void requestLayout()

Overrides javafx.scene.Parent.requestLayout.

Doc from javafx.scene.Parent.requestLayout.

Requests a layout pass to be performed before the next scene is rendered. This is batched up asynchronously to happen once per "pulse", or frame of animation.

If this parent is either a layout root or unmanaged, then it will be added directly to the scene's dirty layout list, otherwise requestParentLayout will be invoked.

Annotations

@Override

setLineSpacing	back to summary
public final void setLineSpacing(double spacing)

setTabSize	back to summary
public final void setTabSize(int spaces)

setTabStopPolicy	back to summary
public final void setTabStopPolicy(TabStopPolicy policy)

setTextAlignment	back to summary
public final void setTextAlignment(TextAlignment value)

setWidth

back to summary

protected void setWidth(double value)

Overrides javafx.scene.layout.Region.setWidth.

Annotations

@Override

tabSizeProperty	back to summary
public final IntegerProperty tabSizeProperty()

tabStopPolicyProperty	back to summary
public final ObjectProperty<TabStopPolicy> tabStopPolicyProperty()

textAlignmentProperty	back to summary
public final ObjectProperty<TextAlignment> textAlignmentProperty()

underlineShape back to summary

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

Deprecated

since 25.

replaced by getUnderlineShape(int, int)

Returns the shape for the underline in local coordinates.

Note

this method does not take border or padding into account.

Parameters

start:int: the beginning character index for the range
end:int: the end character index (non-inclusive) for the range

Returns:PathElement[]

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

Annotations

@Deprecated
since:25

Since

usesMirroring back to summary

public boolean usesMirroring()

Overrides javafx.scene.Node.usesMirroring.

Doc from javafx.scene.Node.usesMirroring.

Determines whether a node should be mirrored when node orientation is right-to-left.

When a node is mirrored, the origin is automatically moved to the top right corner causing the node to layout children and draw from right to left using a mirroring transformation. Some nodes may wish to draw from right to left without using a transformation. These nodes will answer false and implement right-to-left orientation without using the automatic transformation.

Annotations

@Override

Modifier and Type	Method and Description
public RectBounds	getBounds() Implements com.sun.javafx.scene.text.TextSpan.getBounds. The bounds for embedded object, only used when the font returns null.
public Object	getFont() Implements com.sun.javafx.scene.text.TextSpan.getFont. The font for the span, if null the span is handled as embedded object.
public Region	getLayoutRootRegion() Implements com.sun.javafx.scene.text.TextSpan.getLayoutRootRegion. Returns the `Region` which contains the layout for this TextSpan.
public Node	getNode()
public String	getText() Implements com.sun.javafx.scene.text.TextSpan.getText. The text for the span, can be empty but not null.

Modifier and Type	Field and Description
private static final CssMetaData<TextFlow, Number>	LINE_SPACING
private static final List<CssMetaData<? extends Styleable, ?>>	STYLEABLES
private static final CssMetaData<TextFlow, Number>	TAB_SIZE
private static final CssMetaData<TextFlow, TextAlignment>	TEXT_ALIGNMENT

public Class TextFlow

Resizable Range

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class TextFlow.EmbeddedSpan

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class TextFlow.StyleableProperties

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail