javafx.scene.text

Class TextFlow

java.lang.Object

Pane

javafx.scene.text.TextFlow

public class TextFlow
extends Pane

TextFlow is special layout designed to lay out rich text. It can be used to layout several Text nodes in a single text flow. The TextFlow uses the text and the font of each Text node inside of it plus it 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 Text node can differ from the logical location due to bidi reordering.

Any other Node, rather than Text, will be treated as 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 of a TextFlow some 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 is set to false when it is laid out by the TextFlow. This happens because the content of a single Text node can divided and placed in the different locations on 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 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 childrens' bounds may extend outside its own bounds if a child's pref size is larger than the space textflow has to allocate for it.

Since:

JavaFX 8.0

Property Summary

Type	Property and Description
DoubleProperty	lineSpacing Defines the vertical space in pixel between lines.
<any>	textAlignment Defines horizontal text alignment.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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 <any>	textAlignment Defines horizontal text alignment.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
(package private) static double	boundedSize(double min, double pref, double max)
PathElement[]	caretShape(int charIndex, boolean leading) Returns shape of caret in local coordinates.
private void	checkOrientation()
(package private) double	computeChildPrefAreaHeight(Node child, Insets margin)
(package private) double	computeChildPrefAreaHeight(Node child, Insets margin, double width)
(package private) double	computeChildPrefAreaWidth(Node child, Insets margin)
(package private) double	computeChildPrefAreaWidth(Node child, Insets margin, double height)
protected double	computeMinHeight(double width)
protected double	computePrefHeight(double width)
protected double	computePrefWidth(double height)
double	getBaselineOffset()
static java.util.List<<any>>	getClassCssMetaData()
Orientation	getContentBias()
java.util.List<<any>>	getCssMetaData()
double	getLineSpacing() Gets the value of the property lineSpacing.
private PathElement[]	getRange(int start, int end, int type)
TextAlignment	getTextAlignment() Gets the value of the property textAlignment.
(package private) TextLayout	getTextLayout()
HitInfo	hitTest(javafx.geometry.Point2D point) Maps local point to index in the content.
protected void	layoutChildren()
DoubleProperty	lineSpacingProperty() Defines the vertical space in pixel between lines.
java.lang.Object	queryAccessibleAttribute(AccessibleAttribute attribute, java.lang.Object... parameters)
PathElement[]	rangeShape(int start, int end) Returns shape for the range of the text in local coordinates.
void	requestLayout()
void	setLineSpacing(double spacing) Sets the value of the property lineSpacing.
void	setTextAlignment(TextAlignment value) Sets the value of the property textAlignment.
protected void	setWidth(double value)
private static double	snapSpace(double value, boolean snapToPixel)
<any>	textAlignmentProperty() Defines horizontal text alignment.
boolean	usesMirroring()

Methods inherited from class java.lang.Object

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

Property Detail

textAlignment

public final <any> textAlignmentProperty

Defines horizontal text alignment.

See Also:

getTextAlignment(), setTextAlignment(TextAlignment)

lineSpacing

public final DoubleProperty lineSpacingProperty

Defines the vertical space in pixel between lines.

Since:

JavaFX 8.0

See Also:

getLineSpacing(), setLineSpacing(double)

Field Detail

layout

private TextLayout layout

needsContent

private boolean needsContent

inLayout

private boolean inLayout

textAlignment

private <any> textAlignment

Defines horizontal text alignment.

lineSpacing

private DoubleProperty lineSpacing

Defines the vertical space in pixel between lines.

Since:

JavaFX 8.0

Constructor Detail

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 Detail

checkOrientation

private void checkOrientation()

hitTest

public final HitInfo hitTest(javafx.geometry.Point2D point)

Maps local point to index in the content.

Parameters:

point - the specified point to be tested

Returns:

a HitInfo representing the character index found

Since:

9

caretShape

public PathElement[] caretShape(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:

9

rangeShape

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

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

Returns:

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

Since:

9

usesMirroring

public boolean usesMirroring()

setWidth

protected void setWidth(double value)

computePrefWidth

protected double computePrefWidth(double height)

computePrefHeight

protected double computePrefHeight(double width)

computeMinHeight

protected double computeMinHeight(double width)

requestLayout

public void requestLayout()

getContentBias

public Orientation getContentBias()

layoutChildren

protected void layoutChildren()

getRange

private PathElement[] getRange(int start,
                               int end,
                               int type)

getTextLayout

TextLayout getTextLayout()

setTextAlignment

public final void setTextAlignment(TextAlignment value)

Sets the value of the property textAlignment.

getTextAlignment

public final TextAlignment getTextAlignment()

Gets the value of the property textAlignment.

textAlignmentProperty

public final <any> textAlignmentProperty()

Defines horizontal text alignment.

See Also:

getTextAlignment(), setTextAlignment(TextAlignment)

setLineSpacing

public final void setLineSpacing(double spacing)

Sets the value of the property lineSpacing.

Since:

JavaFX 8.0

getLineSpacing

public final double getLineSpacing()

Gets the value of the property lineSpacing.

Since:

JavaFX 8.0

lineSpacingProperty

public final DoubleProperty lineSpacingProperty()

Defines the vertical space in pixel between lines.

Since:

JavaFX 8.0

See Also:

getLineSpacing(), setLineSpacing(double)

getBaselineOffset

public final double getBaselineOffset()

getClassCssMetaData

public static java.util.List<<any>> getClassCssMetaData()

Returns:

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

getCssMetaData

public java.util.List<<any>> getCssMetaData()

snapSpace

private static double snapSpace(double value,
                                boolean snapToPixel)

boundedSize

static double boundedSize(double min,
                          double pref,
                          double max)

computeChildPrefAreaWidth

double computeChildPrefAreaWidth(Node child,
                                 Insets margin)

computeChildPrefAreaWidth

double computeChildPrefAreaWidth(Node child,
                                 Insets margin,
                                 double height)

computeChildPrefAreaHeight

double computeChildPrefAreaHeight(Node child,
                                  Insets margin)

computeChildPrefAreaHeight

double computeChildPrefAreaHeight(Node child,
                                  Insets margin,
                                  double width)

queryAccessibleAttribute

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