class: TextFlow

[96:7] extends: Pane

Wraps JavaFX TextFlow, a layout container that flows rich text (Text nodes and other inline nodes) across multiple lines. Child nodes are arranged horizontally and wrapped to the next line when they exceed the container width. TextFlow extends Pane, which extends Region, so it supports all Region CSS properties.

CSS Properties -- TextFlow

Property	Values	Default	Description
`-fx-line-spacing`	`<size>`	`0`	Additional vertical spacing between lines of text.
`-fx-tab-size`	`<integer>`	`8`	Number of spaces that a tab character expands to.
`-fx-text-alignment`	`left \| center \| right \| justify`	`left`	Horizontal alignment of lines within the flow.

CSS Properties -- Region

Background fills

Property	Values	Default	Description
`-fx-background-color`	`<paint> [, <paint>]*`	`transparent`	One or more paint values for background fill layers, rendered back to front.
`-fx-background-insets`	`<size>` or `<t> <r> <b> <l>` [, ...]*	`0 0 0 0`	Insets from the region edges for each background fill layer.
`-fx-background-radius`	`<size> [/ <size>]* [, ...]*`	`0 0 0 0`	Corner radii for each background fill layer.

Background images

Property	Values	Default	Description
`-fx-background-image`	`<uri> [, <uri>]*`	`null`	One or more image URIs for background image layers.
`-fx-background-position`	`<bg-position> [, ...]*`	`0% 0%`	Position of each background image within the region.
`-fx-background-repeat`	`<repeat-style> [, ...]*`	`repeat repeat`	Tiling behavior for each background image.
`-fx-background-size`	`<bg-size> [, ...]*`	`auto auto`	Dimensions for each background image.

Stroked borders

Property	Values	Default	Description
`-fx-border-color`	`<paint>` or `<t> <r> <b> <l>` [, ...]*	`null`	Paint colors for the border stroke layers.
`-fx-border-insets`	`<size>` or `<t> <r> <b> <l>` [, ...]*	`null`	Insets from region edges for each border layer.
`-fx-border-radius`	`<size> [, ...]*`	`null`	Corner radii for border stroke layers.
`-fx-border-style`	`<border-style> [, ...]*`	`null`	Border line style (solid, dotted, dashed) plus phase and line cap/join options per layer.
`-fx-border-width`	`<size>` or `<t> <r> <b> <l>` [, ...]*	`null`	Thickness of each border stroke layer, per side.

Border images

Property	Values	Default	Description
`-fx-border-image-source`	`<uri> [, <uri>]*`	`null`	Image URIs used to paint the border.
`-fx-border-image-insets`	`<size>` or `<t> <r> <b> <l>` [, ...]*	`0 0 0 0`	Insets for each border image layer.
`-fx-border-image-repeat`	`<repeat-style> [, ...]*`	`repeat repeat`	Tiling behavior for each border image.
`-fx-border-image-slice`	`<size>` or `<t> <r> <b> <l>` [fill] [, ...]*	`100%`	Divides each border image into nine regions. Adding fill preserves the center region.
`-fx-border-image-width`	`<size>` or `<t> <r> <b> <l>` [, ...]*	`1 1 1 1`	Width of each border image slice per side.

Other Region properties

Property	Values	Default	Description
`-fx-padding`	`<size>` or `<t> <r> <b> <l>`	`0 0 0 0`	Interior padding between the region border and its content.
`-fx-shape`	`<string>`	`null`	SVG path string that defines a custom clip shape for the region.
`-fx-scale-shape`	`true \| false`	`true`	When true, the shape is scaled to fit the region.
`-fx-position-shape`	`true \| false`	`true`	When true, the shape is centered within the region.
`-fx-snap-to-pixel`	`true \| false`	`true`	When true, positions and sizes are rounded to whole pixel boundaries.
`-fx-min-width`	`<size>`	`-1`	Minimum width. -1 uses the computed minimum.
`-fx-pref-width`	`<size>`	`-1`	Preferred width. -1 uses the computed preferred.
`-fx-max-width`	`<size>`	`-1`	Maximum width. -1 uses the computed maximum.
`-fx-min-height`	`<size>`	`-1`	Minimum height. -1 uses the computed minimum.
`-fx-pref-height`	`<size>`	`-1`	Preferred height. -1 uses the computed preferred.
`-fx-max-height`	`<size>`	`-1`	Maximum height. -1 uses the computed maximum.

CSS Properties -- Node

Property	Values	Default	Description
`-fx-blend-mode`	`add \| blue \| color-burn \| color-dodge \| darken \| difference \| exclusion \| green \| hard-light \| lighten \| multiply \| overlay \| red \| screen \| soft-light \| src-atop \| src-in \| src-out \| src-over`	`null`	Blend mode used when compositing this node with nodes beneath it.
`-fx-cursor`	`null \| crosshair \| default \| hand \| move \| e-resize \| h-resize \| ne-resize \| nw-resize \| n-resize \| se-resize \| sw-resize \| s-resize \| w-resize \| v-resize \| text \| wait \| <url>`	`null` (inherits)	Mouse cursor shape shown when the pointer is over this node. Inherits from parent by default.
`-fx-effect`	`<effect>`	`null`	A visual effect (e.g. DropShadow, InnerShadow) applied to the rendered node.
`-fx-focus-traversable`	`true \| false`	`false`	Whether this node participates in focus traversal.
`-fx-view-order`	`<number>`	`0`	Adjusts rendering and hit-test order within the parent without changing the scene graph order.
`-fx-opacity`	`<number> [0.0 - 1.0]`	`1`	Opacity of the node. 0 is fully transparent, 1 is fully opaque.
`-fx-rotate`	`<number>`	`0`	Rotation angle in degrees applied around the node's center point.
`-fx-scale-x`	`<number>`	`1`	Scale factor along the X axis about the node's center.
`-fx-scale-y`	`<number>`	`1`	Scale factor along the Y axis about the node's center.
`-fx-scale-z`	`<number>`	`1`	Scale factor along the Z axis about the node's center.
`-fx-translate-x`	`<number>`	`0`	Translation offset along the X axis in pixels.
`-fx-translate-y`	`<number>`	`0`	Translation offset along the Y axis in pixels.
`-fx-translate-z`	`<number>`	`0`	Translation offset along the Z axis in pixels.
`visibility`	`visible \| hidden \| collapse \| inherit`	`visible`	Controls whether the node is rendered and participates in layout.
`-fx-managed`	`true \| false`	`true`	When false, the parent layout does not manage this node's position or size.

Methods

TextFlow ()

Initializes a new TextFlow instance.
- @r this object
setTextAlignment (string Align)

Sets the horizontal alignment of the text lines within the TextFlow.
- @p Align is a javafx.scene.text.TextAlignment constant name: LEFT, CENTER, RIGHT, or JUSTIFY.
- @r this object for chaining
getTextAlignment ()

Returns the current text alignment.
- @r An AJO around the javafx.scene.text.TextAlignment value.
textAlignmentProperty ()

Returns the textAlignment ObjectProperty for binding.
- @r An AJO around the ObjectProperty.
setLineSpacing (double Value)

Sets the vertical space, in pixels, inserted between text lines.
- @p Value is a double with the line spacing in pixels.
- @r this object for chaining
getLineSpacing ()

Returns the vertical space, in pixels, between text lines.
- @r A double with the configured line spacing.
lineSpacingProperty ()

Returns the lineSpacing DoubleProperty for binding.
- @r An AJO around the DoubleProperty.
setTabSize (int Value)

Sets the number of spaces represented by each tab character.
- @p Value is an int with the tab size, in spaces.
- @r this object for chaining
getTabSize ()

Returns the number of spaces represented by each tab character.
- @r An int with the configured tab size.
tabSizeProperty ()

Returns the tabSize IntegerProperty for binding.
- @r An AJO around the IntegerProperty.
pathList (Arr)

Converts a Java PathElement array into an Aussom list of PathElement AussomJavaObjects.
- @p Arr is an AJO wrapping a javafx.scene.shape.PathElement array.
- @r A list of PathElement AJOs.
caretShape (int CharIndex, bool Leading)

Returns the shape of the caret at a character position, as a list of path elements that can be used to draw it.
- @p CharIndex is an int with the character index.
- @p Leading is a bool; true places the caret on the leading edge of the character, false on the trailing edge.
- @r A list of javafx.scene.shape.PathElement AJOs.
hitTest (double X, double Y)

Returns hit information (the character index and insertion index) for a point in the TextFlow's local coordinates.
- @p X is a double with the local X coordinate.
- @p Y is a double with the local Y coordinate.
- @r An AJO wrapping javafx.scene.text.HitInfo.
rangeShape (int Start, int End)

Returns the shape that covers a range of characters, as a list of path elements (useful for drawing a selection highlight).
- @p Start is an int with the start character index (inclusive).
- @p End is an int with the end character index (exclusive).
- @r A list of javafx.scene.shape.PathElement AJOs.
underlineShape (int Start, int End)

Returns the shape of the underline under a range of characters, as a list of path elements.
- @p Start is an int with the start character index (inclusive).
- @p End is an int with the end character index (exclusive).
- @r A list of javafx.scene.shape.PathElement AJOs.