Class TextFlow

java.lang.Object
javafx.scene.Node
javafx.scene.Parent
javafx.scene.layout.Region
javafx.scene.layout.Pane
javafx.scene.text.TextFlow
All Implemented Interfaces:
Styleable, EventTarget
public class TextFlow extends Pane
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
widthheight
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_VALUEDouble.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.

Since:
JavaFX 8.0

  • Property Details

  • Constructor Details

    • TextFlow

      public TextFlow()
      Creates an empty TextFlow layout.

    • TextFlow

      public TextFlow(Node... children)
      Creates a TextFlow layout with the given children.
      Parameters:
      children - children.

  • Method Details

    • hitTest

      @Deprecated(since="25") public final HitInfo hitTest(Point2D point)
      Deprecated.
      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 - the specified point to be tested
      Returns:
      a HitInfo representing the character index found
      Since:
      9

    • getHitInfo

      public final HitInfo getHitInfo(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:
      25

    • caretShape

      @Deprecated(since="25") public PathElement[] caretShape(int charIndex, boolean leading)
      Deprecated.
      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 - the character index for the caret
      leading - 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

    • getCaretShape

      public PathElement[] getCaretShape(int charIndex, boolean leading)
      Returns shape of caret in local coordinates.
      Parameters:
      charIndex - the character index for the caret
      leading - 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:
      25

    • rangeShape

      @Deprecated(since="25") public final PathElement[] rangeShape(int start, int end)
      Deprecated.
      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 - 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

    • getRangeShape

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

    • underlineShape

      @Deprecated(since="25") public final PathElement[] underlineShape(int start, int end)
      Deprecated.
      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 - 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:
      21

    • getUnderlineShape

      public final PathElement[] getUnderlineShape(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:
      25
      See Also:

    • 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
      See Also:

    • setTextAlignment

      public final void setTextAlignment(TextAlignment value)
      Sets the value of the textAlignment property.
      Property description:
      Defines horizontal text alignment.
      Default value:
      TextAlignment.LEFT
      Parameters:
      value - the value for the textAlignment property
      See Also:

    • getTextAlignment

      public final TextAlignment getTextAlignment()
      Gets the value of the textAlignment property.
      Property description:
      Defines horizontal text alignment.
      Default value:
      TextAlignment.LEFT
      Returns:
      the value of the textAlignment property
      See Also:

    • textAlignmentProperty

      public final ObjectProperty<TextAlignment> textAlignmentProperty()
      Defines horizontal text alignment.
      Default value:
      TextAlignment.LEFT
      Returns:
      the textAlignment property
      See Also:

    • 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

      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:

    • lineSpacingProperty

      public final DoubleProperty lineSpacingProperty()
      Defines the vertical space in pixel between lines.
      Default value:
      0
      Returns:
      the lineSpacing property
      Since:
      JavaFX 8.0
      See Also:

    • tabSizeProperty

      public final IntegerProperty tabSizeProperty()
      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
      Returns:
      the tabSize property
      Since:
      14
      See Also:

    • 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. 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
      Returns:
      the value of the tabSize property
      Since:
      14
      See Also:

    • 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. 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
      Parameters:
      spaces - the value for the tabSize property
      Since:
      14
      See Also:

    • tabStopPolicyProperty

      public final ObjectProperty<TabStopPolicy> tabStopPolicyProperty()
      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
      Returns:
      the tabStopPolicy property
      Since:
      25
      See Also:

    • getTabStopPolicy

      public final TabStopPolicy getTabStopPolicy()
      Gets the value of the tabStopPolicy property.
      Property description:
      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
      Returns:
      the value of the tabStopPolicy property
      Since:
      25
      See Also:

    • setTabStopPolicy

      public final void setTabStopPolicy(TabStopPolicy policy)
      Sets the value of the tabStopPolicy property.
      Property description:
      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
      Parameters:
      policy - the value for the tabStopPolicy property
      Since:
      25
      See Also:

    • getBaselineOffset

      public final double getBaselineOffset()
      Description copied from class: Parent
      Calculates the baseline offset based on the first managed child. If there is no such child, returns Node.getBaselineOffset().
      Overrides:
      getBaselineOffset in class Parent
      Returns:
      baseline offset

    • 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

    • 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