JavaFX 24 · com.sun.jfx.incubator.scene.control.richtext.VFlow

Modifier and Type	Field and Description
private CellArrangement	arrangement
private final Timeline	caretAnimation
private final Path	caretLineHighlight
private final Path	caretPath
private final SimpleBooleanProperty	caretVisible
private final FastCache<TextCell>	cellCache
private final Pane	content
private double	contentPaddingBottom
private double	contentPaddingLeft
private double	contentPaddingRight
private double	contentPaddingTop
private static final VFlowCellContext	context
private final RichTextArea	control
private boolean	dirty
private boolean	handleScrollEvents
private final ScrollBar	hscroll
private boolean	inReflow
private FastCache<Node>	leftCache
private final ClippedPane	leftGutter
private double	leftSide
private static final Text	measurer
private final SimpleDoubleProperty	offsetX
private final ReadOnlyObjectWrapper<Origin>	origin
private FastCache<Node>	rightCache
private final ClippedPane	rightGutter
private double	rightSide
private final Path	selectionHighlight
private final RichTextAreaSkin	skin
private final SimpleBooleanProperty	suppressBlink
private double	unwrappedContentWidth
private double	viewPortHeight
private double	viewPortWidth
private final ClippedPane	vport
private boolean	vsbPressed
private final ScrollBar	vscroll

Access	Constructor and Description
public	VFlow(RichTextAreaSkin skin, ScrollBar vsb, ScrollBar hsb)

Method Summary

Modifier and Type	Method and Description
protected CellArrangement	arrangement() returns a non-null layout, laying out cells if necessary
protected void	checkForExcessiveWhitespaceAtTheEnd()
private Origin	computeNewOrigin(ContentChange ch)
protected double	computePrefHeight(double the width that should be used if preferred height depends on it 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 the height that should be used if preferred width depends on it height) Overrides javafx.scene.layout.Region.computePrefWidth. Computes the preferred width of this region for the given height.
private double	computeSideWidth(SideDecorator d)
public final Insets	Returns: the content padding contentPadding() Returns control's content padding, always non-null.
private double	contentWidth() returns the content width, including padding and horizontal guard, snapped
protected void	createCaretPath(FxPathBuilder b, TextPos p)
protected void	createCurrentLineHighlight(FxPathBuilder b, TextPos caret)
protected void	createSelectionHighlight(FxPathBuilder b, TextPos start, TextPos end)
private TextCell	createTextCell(int index, RichParagraph par)
private Text	createTextNode(String text, StyleAttributeMap attrs)
public void	dispose()
private static double	fromScrollBarValue(double val, double visible, double max) inverse of `toScrollBarValue`, returns the scroll bar value that takes into account visible amount
protected CaretInfo	getCaretInfo(TextPos p) in vflow.content coordinates
public CaretInfo	getCaretInfo() returns caret sizing info using vflow.content coordinates, or null
public TextCell	getCell(int modelIndex)
public Pane	getContentPane()
private double	getLineSpacing(Region r)
public final double	getOffsetX()
public final Origin	getOrigin()
public final int	getParagraphCount()
protected PathElement[]	getRangeBottom()
public PathElement[]	getRangeShape(int line, int startOffset, int endOffset) returns the shape if both ends are at the same line, in VFlow coordinates
protected PathElement[]	getRangeTop()
public TextPos	getTextPosLocal(double localX, double localY) uses vflow.content cooridinates
public double	getViewPortHeight()
public void	handleContentPadding()
public void	handleDecoratorChange()
pack-priv void	handleHeightChange() reacts to height changes
public void	handleHorizontalScroll() handles user moving the horizontal scroll bar
public void	handleModelChange()
private void	handleOriginChange()
public void	handleSelectionChange()
public void	handleUseContentHeight()
public void	handleUseContentWidth()
public void	handleVerticalScroll() handles user moving the vertical scroll bar
private void	handleVScrollMouseEvent(MouseEvent ev)
pack-priv void	handleWidthChange() reacts to width changes
public void	handleWrapText()
public void	invalidateLayout()
public boolean	isCaretVisible()
protected void	layoutCells() Recomputes sliding window and lays out scrollbars, left/right sides, and viewport.
protected void	layoutChildren() Overrides javafx.scene.Parent.layoutChildren. Invoked during the layout pass to layout the children in this `Parent`.
public double	leftPadding()
private static Text	makeMeasurer()
public TextPos	moveHorizontally(boolean start, int caretIndex, int caretOffset)
public TextPos	Returns: the new text position, or null if no movement should occur moveVertically(int the current caret index caretIndex, double the target x coordinate x, double the target y coordinate y, boolean direction of the movement relative to the caret down) Computes the new TextPos for the target coordinates.
public void	onContentChange(ContentChange the change ch) Implements jfx.incubator.scene.control.richtext.model.StyledTextModel.Listener.onContentChange. Informs the listener that the model content has changed.
public final ReadOnlyProperty<Origin>	originProperty() Location of the top left corner.
public void	pageDown()
public void	pageUp()
private TextCell	prepareCell(int modelIndex, double maxWidth)
protected void	removeCaretAndSelection()
public void	requestControlLayout(boolean if true, clears the cell cache clearCache) Requests full layout with optional clearing of the cached cells.
public void	requestLayout() Overrides javafx.scene.Parent.requestLayout. Requests a layout pass to be performed before the next scene is rendered.
public StyleAttributeMap	resolveStyles(StyleAttributeMap the style attributes attrs) Implements jfx.incubator.scene.control.richtext.StyleResolver.resolveStyles. Resolves CSS styles (when present) to the individual attributes declared in `StyleAttributeMap`.
public void	scrollCaretToVisible()
public void	scrollHorizontalFraction(double delta)
public void	scrollHorizontalPixels(double delta)
private void	scrollHorizontalToVisible(double x) x in vflow.content coordinate
public void	scrollToVisible(double x, double y) scrolls to visible area, using vflow.content coordinates
public void	scrollVerticalFraction(double fractionOfHeight)
public void	scrollVerticalPixels(double delta) scroll by a number of pixels, delta must not exceed the view height in absolute terms
public void	setCaretVisible(boolean on)
private final void	setOffsetX(double x)
private void	setOrigin(Origin or)
public final void	setSuppressBlink(boolean on)
private void	setUnwrappedContentWidth(double w)
public WritableImage	snapshot(Node the `Node` to make a snapshot of n) Implements jfx.incubator.scene.control.richtext.StyleResolver.snapshot. Creates a snapshot of the specified Node to be exported or copied as an image.
public int	topCellIndex()
private static double	toScrollBarValue(double val, double visible, double max) javafx ScrollBar is weird in that the value has a range between [min,max] regardless of visible amount.
public void	updateCaretAndSelection()
protected void	updateHorizontalScrollBar() updates HSB in response to change in width, layout, or offsetX
private void	updatePrefWidth()
public final void	updateRateRestartBlink()
private FastCache<Node>	updateSideCache(SideDecorator decorator, FastCache<Node> cache)
protected void	updateVerticalScrollBar() updates VSB in response to change in height, layout, or offsetY

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

arrangement	back to summary
private CellArrangement arrangement

caretAnimation	back to summary
private final Timeline caretAnimation

caretLineHighlight	back to summary
private final Path caretLineHighlight

caretPath	back to summary
private final Path caretPath

caretVisible	back to summary
private final SimpleBooleanProperty caretVisible

cellCache	back to summary
private final FastCache<TextCell> cellCache

content	back to summary
private final Pane content

contentPaddingBottom	back to summary
private double contentPaddingBottom

contentPaddingLeft	back to summary
private double contentPaddingLeft

contentPaddingRight	back to summary
private double contentPaddingRight

contentPaddingTop	back to summary
private double contentPaddingTop

context	back to summary
private static final VFlowCellContext context

control	back to summary
private final RichTextArea control

dirty	back to summary
private boolean dirty

handleScrollEvents	back to summary
private boolean handleScrollEvents

hscroll	back to summary
private final ScrollBar hscroll

inReflow	back to summary
private boolean inReflow

leftCache	back to summary
private FastCache<Node> leftCache

leftGutter	back to summary
private final ClippedPane leftGutter

leftSide	back to summary
private double leftSide

measurer	back to summary
private static final Text measurer

offsetX	back to summary
private final SimpleDoubleProperty offsetX

origin	back to summary
private final ReadOnlyObjectWrapper<Origin> origin

rightCache	back to summary
private FastCache<Node> rightCache

rightGutter	back to summary
private final ClippedPane rightGutter

rightSide	back to summary
private double rightSide

selectionHighlight	back to summary
private final Path selectionHighlight

skin	back to summary
private final RichTextAreaSkin skin

suppressBlink	back to summary
private final SimpleBooleanProperty suppressBlink

unwrappedContentWidth	back to summary
private double unwrappedContentWidth

viewPortHeight	back to summary
private double viewPortHeight

viewPortWidth	back to summary
private double viewPortWidth

vport	back to summary
private final ClippedPane vport

vsbPressed	back to summary
private boolean vsbPressed

vscroll	back to summary
private final ScrollBar vscroll

VFlow	back to summary
public VFlow(RichTextAreaSkin skin, ScrollBar vsb, ScrollBar hsb)

Method Detail

arrangement	back to summary
protected CellArrangement arrangement() returns a non-null layout, laying out cells if necessary

checkForExcessiveWhitespaceAtTheEnd	back to summary
protected void checkForExcessiveWhitespaceAtTheEnd()

computeNewOrigin	back to summary
private Origin computeNewOrigin(ContentChange ch)

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. Parameters width:double Doc from javafx.scene.Parent.computePrefHeight. the width that should be used if preferred height depends on it Returns:double the computed preferred height for this region 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.

Parameters

width:double

Doc from javafx.scene.Parent.computePrefHeight.

the width that should be used if preferred height depends on it

Returns:double

the computed preferred height for this region

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. Parameters height:double Doc from javafx.scene.Parent.computePrefWidth. the height that should be used if preferred width depends on it Returns:double the computed preferred width for this region 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.

Parameters

height:double

Doc from javafx.scene.Parent.computePrefWidth.

the height that should be used if preferred width depends on it

Returns:double

the computed preferred width for this region

Annotations

@Override

computeSideWidth	back to summary
private double computeSideWidth(SideDecorator d)

contentPadding	back to summary
public final Insets contentPadding() Returns control's content padding, always non-null. Returns:Insets the content padding

contentPadding

back to summary

public final Insets contentPadding()

Returns control's content padding, always non-null.

Returns:Insets: the content padding

contentWidth	back to summary
private double contentWidth() returns the content width, including padding and horizontal guard, snapped

createCaretPath	back to summary
protected void createCaretPath(FxPathBuilder b, TextPos p)

createCurrentLineHighlight	back to summary
protected void createCurrentLineHighlight(FxPathBuilder b, TextPos caret)

createSelectionHighlight	back to summary
protected void createSelectionHighlight(FxPathBuilder b, TextPos start, TextPos end)

createTextCell	back to summary
private TextCell createTextCell(int index, RichParagraph par)

createTextNode	back to summary
private Text createTextNode(String text, StyleAttributeMap attrs)

dispose	back to summary
public void dispose()

fromScrollBarValue	back to summary
private static double fromScrollBarValue(double val, double visible, double max) inverse of `toScrollBarValue`, returns the scroll bar value that takes into account visible amount

getCaretInfo	back to summary
protected CaretInfo getCaretInfo(TextPos p) in vflow.content coordinates

getCaretInfo	back to summary
public CaretInfo getCaretInfo() returns caret sizing info using vflow.content coordinates, or null

getCell	back to summary
public TextCell getCell(int modelIndex)

getContentPane	back to summary
public Pane getContentPane()

getLineSpacing	back to summary
private double getLineSpacing(Region r)

getOffsetX	back to summary
public final double getOffsetX()

getOrigin	back to summary
public final Origin getOrigin()

getParagraphCount	back to summary
public final int getParagraphCount()

getRangeBottom	back to summary
protected PathElement[] getRangeBottom()

getRangeShape	back to summary
public PathElement[] getRangeShape(int line, int startOffset, int endOffset) returns the shape if both ends are at the same line, in VFlow coordinates

getRangeTop	back to summary
protected PathElement[] getRangeTop()

getTextPosLocal	back to summary
public TextPos getTextPosLocal(double localX, double localY) uses vflow.content cooridinates

getViewPortHeight	back to summary
public double getViewPortHeight()

handleContentPadding	back to summary
public void handleContentPadding()

handleDecoratorChange	back to summary
public void handleDecoratorChange()

handleHeightChange	back to summary
pack-priv void handleHeightChange() reacts to height changes

handleHorizontalScroll	back to summary
public void handleHorizontalScroll() handles user moving the horizontal scroll bar

handleModelChange	back to summary
public void handleModelChange()

handleOriginChange	back to summary
private void handleOriginChange()

handleSelectionChange	back to summary
public void handleSelectionChange()

handleUseContentHeight	back to summary
public void handleUseContentHeight()

handleUseContentWidth	back to summary
public void handleUseContentWidth()

handleVerticalScroll	back to summary
public void handleVerticalScroll() handles user moving the vertical scroll bar

handleVScrollMouseEvent	back to summary
private void handleVScrollMouseEvent(MouseEvent ev)

handleWidthChange	back to summary
pack-priv void handleWidthChange() reacts to width changes

handleWrapText	back to summary
public void handleWrapText()

invalidateLayout	back to summary
public void invalidateLayout()

isCaretVisible	back to summary
public boolean isCaretVisible()

layoutCells	back to summary
protected void layoutCells() Recomputes sliding window and lays out scrollbars, left/right sides, and viewport. This process might be repeated if one of the scroll bars changes its visibility as a result. (up to 4 times worst case)

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

leftPadding	back to summary
public double leftPadding()

makeMeasurer	back to summary
private static Text makeMeasurer()

moveHorizontally	back to summary
public TextPos moveHorizontally(boolean start, int caretIndex, int caretOffset)

moveVertically

back to summary

public TextPos moveVertically(int caretIndex, double x, double y, boolean down)

Computes the new TextPos for the target coordinates. This method takes into account the geometry of text as determined by the layout, thus taking into account line spacing and paragraph padding and borders.

Parameters

caretIndex:int: the current caret index
x:double: the target x coordinate
y:double: the target y coordinate
down:boolean: direction of the movement relative to the caret

Returns:TextPos

the new text position, or null if no movement should occur

onContentChange

back to summary

public void onContentChange(ContentChange ch)

Implements jfx.incubator.scene.control.richtext.model.StyledTextModel.Listener.onContentChange.

Doc from jfx.incubator.scene.control.richtext.model.StyledTextModel.Listener.onContentChange.

Informs the listener that the model content has changed.

Parameters

ch:ContentChange: the change

Annotations

@Override

originProperty	back to summary
public final ReadOnlyProperty<Origin> originProperty() Location of the top left corner.

pageDown	back to summary
public void pageDown()

pageUp	back to summary
public void pageUp()

prepareCell	back to summary
private TextCell prepareCell(int modelIndex, double maxWidth)

removeCaretAndSelection	back to summary
protected void removeCaretAndSelection()

requestControlLayout

back to summary

public void requestControlLayout(boolean clearCache)

Requests full layout with optional clearing of the cached cells.

Parameters

clearCache:boolean: if true, clears the cell cache

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

resolveStyles back to summary

public StyleAttributeMap resolveStyles(StyleAttributeMap attrs)

Implements jfx.incubator.scene.control.richtext.StyleResolver.resolveStyles.

Doc from jfx.incubator.scene.control.richtext.StyleResolver.resolveStyles.

Resolves CSS styles (when present) to the individual attributes declared in StyleAttributeMap.

Parameters

attrs:StyleAttributeMap: the style attributes

Returns:StyleAttributeMap

the resolved style attributes

Annotations

@Override

scrollCaretToVisible	back to summary
public void scrollCaretToVisible()

scrollHorizontalFraction	back to summary
public void scrollHorizontalFraction(double delta)

scrollHorizontalPixels	back to summary
public void scrollHorizontalPixels(double delta)

scrollHorizontalToVisible	back to summary
private void scrollHorizontalToVisible(double x) x in vflow.content coordinate

scrollToVisible	back to summary
public void scrollToVisible(double x, double y) scrolls to visible area, using vflow.content coordinates

scrollVerticalFraction	back to summary
public void scrollVerticalFraction(double fractionOfHeight)

scrollVerticalPixels	back to summary
public void scrollVerticalPixels(double delta) scroll by a number of pixels, delta must not exceed the view height in absolute terms

setCaretVisible	back to summary
public void setCaretVisible(boolean on)

setOffsetX	back to summary
private final void setOffsetX(double x)

setOrigin	back to summary
private void setOrigin(Origin or)

setSuppressBlink	back to summary
public final void setSuppressBlink(boolean on)

setUnwrappedContentWidth	back to summary
private void setUnwrappedContentWidth(double w)

snapshot back to summary

public WritableImage snapshot(Node n)

Implements jfx.incubator.scene.control.richtext.StyleResolver.snapshot.

Doc from jfx.incubator.scene.control.richtext.StyleResolver.snapshot.

Creates a snapshot of the specified Node to be exported or copied as an image.

Parameters

n:Node: the Node to make a snapshot of

Returns:WritableImage

snapshot the generated WritableImage

Annotations

@Override

topCellIndex	back to summary
public int topCellIndex()

toScrollBarValue	back to summary
private static double toScrollBarValue(double val, double visible, double max) javafx ScrollBar is weird in that the value has a range between [min,max] regardless of visible amount. this method generates the value ScrollBar expects by renormalizing it to a [min,max-visible] range, assuming min == 0.

updateCaretAndSelection	back to summary
public void updateCaretAndSelection()

updateHorizontalScrollBar	back to summary
protected void updateHorizontalScrollBar() updates HSB in response to change in width, layout, or offsetX

updatePrefWidth	back to summary
private void updatePrefWidth()

updateRateRestartBlink	back to summary
public final void updateRateRestartBlink()

updateSideCache	back to summary
private FastCache<Node> updateSideCache(SideDecorator decorator, FastCache<Node> cache)

updateVerticalScrollBar	back to summary
protected void updateVerticalScrollBar() updates VSB in response to change in height, layout, or offsetY

public Class VFlow

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail