JavaFX 25 · jfx.incubator.scene.control.richtext.SideDecorator

Provides a way to add side decorations to each paragraph in a RichTextArea.

The side decorations Nodes are added to either left or right side of each paragraph. Each side node will be resized to the height of the corresponding paragraph. The width of all the side nodes, in order to avoid complicated layout process, would be determined by the following process:

if getPrefWidth method returns a value greater than 0, that will be the width of all the side nodes.
otherwise, the getMeasurementNode(int) method is called. The preferred width of the Node returned will be used to size all other nodes for that side.

Method Summary

Modifier and Type	Method and Description
public Node	Returns: the measurement `Node` getMeasurementNode(int the paragraph index at the top of the viewable area index) Returns the special measurement node to use for sizing the pane that holds the side decorations.
public Node	Returns: new instance `Node` getNode(int the paragraph index index) Creates a Node to be added to the layout to the right or to the left of the given paragraph.
public double	Returns: the preferred width getPrefWidth(double width of the view viewWidth) Returns the width to size the pane which hosts the side decoration `Node`s.

Method Detail

getMeasurementNode back to summary

getMeasurementNode	back to summary
public Node getMeasurementNode(int index) Returns the special measurement node to use for sizing the pane that holds the side decorations. This method will only be called if `getPrefWidth(double)` returns 0 or negative value. The measurement node will not be displayed and will be discarded. Parameters index:int the paragraph index at the top of the viewable area Returns:Node the measurement `Node`

public Node getMeasurementNode(int index)

Returns the special measurement node to use for sizing the pane that holds the side decorations. This method will only be called if getPrefWidth(double) returns 0 or negative value. The measurement node will not be displayed and will be discarded.

Parameters

index:int: the paragraph index at the top of the viewable area

Returns:Node

the measurement Node

getNode back to summary

getNode	back to summary
public Node getNode(int index) Creates a Node to be added to the layout to the right or to the left of the given paragraph. This method may return `null`. Parameters index:int the paragraph index Returns:Node new instance `Node`

public Node getNode(int index)

Creates a Node to be added to the layout to the right or to the left of the given paragraph. This method may return null.

Parameters

index:int: the paragraph index

Returns:Node

new instance Node

getPrefWidth back to summary

getPrefWidth	back to summary
public double getPrefWidth(double viewWidth) Returns the width to size the pane which hosts the side decoration `Node`s. When return value is 0 or negative, an alternative method to size the side pane hosting the decoration will be used: a special measurement `Node` will be obtained via `getMeasurementNode(int)`, whose preferred width will be used instead. Parameters viewWidth:double width of the view Returns:double the preferred width

public double getPrefWidth(double viewWidth)

Returns the width to size the pane which hosts the side decoration Nodes.

When return value is 0 or negative, an alternative method to size the side pane hosting the decoration will be used: a special measurement Node will be obtained via getMeasurementNode(int), whose preferred width will be used instead.

Parameters

viewWidth:double: width of the view

Returns:double

the preferred width

public Interface SideDecorator

Method Summary

Method Detail