Modifier and Type	Class and Description
private static class	ParagraphText.BorderAttributes
private static class	ParagraphText.CustomCssShapeHelper<T>
private static class	ParagraphText.LineAttributesBase
private static class	ParagraphText.UnderlineAttributes

Modifier and Type	Field and Description
private final ParagraphText.CustomCssShapeHelper<Paint>	backgroundShapeHelper
private final ParagraphText.CustomCssShapeHelper<ParagraphText.BorderAttributes>	borderShapeHelper
private final SetChangeListener<? super CaretNode>	caretNodeListener
private final ObservableSet<CaretNode>	carets
private final ObjectProperty<Paint>	highlightTextFill
private Paragraph<PS, SEG, S>	paragraph
private final MapChangeListener<? super Selection<PS, SEG, S>, ? super SelectionPath>	selectionPathListener
private final ObservableMap<Selection<PS, SEG, S>, SelectionPath>	selections
private int	selectionShapeStartIndex
private final ParagraphText.CustomCssShapeHelper<ParagraphText.UnderlineAttributes>	underlineShapeHelper

Access	Constructor and Description
pack-priv	ParagraphText(Paragraph<PS, SEG, S> par, Function<StyledSegment<SEG, S>, Node> nodeFactory)

Method Summary

Modifier and Type	Method and Description
public final ObservableSet<CaretNode>	caretsProperty()
private <T extends Node> void	checkWithinParagraph(T shape)
private PathElement[]	createRectangle(double topLeftX, double topLeftY, double bottomRightX, double bottomRightY)
public int	currentLineIndex(Caret caret)
public int	currentLineIndex(int position)
pack-priv void	dispose()
public <T extends Node & Caret> Bounds	getCaretBounds(T caret)
public <T extends Node & Caret> Bounds	getCaretBoundsOnScreen(T caret)
public <T extends Node & Caret> double	getCaretOffsetX(T caret)
private int	getClampedCaretPosition(Caret caret)
public int	getCurrentLineEndPosition(Caret caret)
public int	getCurrentLineStartPosition(Caret caret)
public Paragraph<PS, SEG, S>	getParagraph()
public Bounds	getRangeBoundsOnScreen(int from, int to)
private PathElement[]	getRangeShapeSafely(IndexRange range)
private PathElement[]	getRangeShapeSafely(int the start position of the range shape start, int the end position of the range shape. If `end == paragraph.length() + 1`, the newline character will be included in the selection by selecting the rest of the line end) Gets the range shape for the given positions within the text, including the newline character, if range defined by the start/end arguments include it.
public Optional<Bounds>	getSelectionBoundsOnScreen(Selection<PS, SEG, S> selection)
public ObjectProperty<Paint>	highlightTextFillProperty()
protected void	layoutChildren() Overrides javafx.scene.text.TextFlow.layoutChildren. Invoked during the layout pass to layout the children in this `Parent`.
public final ObservableMap<Selection<PS, SEG, S>, SelectionPath>	selectionsProperty()
public String	toString() Overrides javafx.scene.Node.toString. Returns a string representation for the object.
private void	updateAllCaretShapes()
private void	updateAllSelectionShapes()
private void	updateBackgroundShapes()
private void	updateSingleCaret(CaretNode caretNode)
private void	updateSingleSelection(SelectionPath path)

Inherited from org.fxmisc.richtext.TextFlowExt:: getCaretShape getLineCount getLineEndPosition getLineOfCharacter getLineStartPosition getRangeShape getRangeShape getUnderlineShape getUnderlineShape getUnderlineShape hit hitLine

Field Detail

backgroundShapeHelper	back to summary
private final ParagraphText.CustomCssShapeHelper<Paint> backgroundShapeHelper

borderShapeHelper	back to summary
private final ParagraphText.CustomCssShapeHelper<ParagraphText.BorderAttributes> borderShapeHelper

caretNodeListener	back to summary
private final SetChangeListener<? super CaretNode> caretNodeListener

carets	back to summary
private final ObservableSet<CaretNode> carets

highlightTextFill	back to summary
private final ObjectProperty<Paint> highlightTextFill

paragraph	back to summary
private Paragraph<PS, SEG, S> paragraph

selectionPathListener	back to summary
private final MapChangeListener<? super Selection<PS, SEG, S>, ? super SelectionPath> selectionPathListener

selections	back to summary
private final ObservableMap<Selection<PS, SEG, S>, SelectionPath> selections

selectionShapeStartIndex	back to summary
private int selectionShapeStartIndex

underlineShapeHelper	back to summary
private final ParagraphText.CustomCssShapeHelper<ParagraphText.UnderlineAttributes> underlineShapeHelper

ParagraphText	back to summary
pack-priv ParagraphText(Paragraph<PS, SEG, S> par, Function<StyledSegment<SEG, S>, Node> nodeFactory)

Method Detail

caretsProperty	back to summary
public final ObservableSet<CaretNode> caretsProperty()

checkWithinParagraph	back to summary
private <T extends Node> void checkWithinParagraph(T shape)

createRectangle	back to summary
private PathElement[] createRectangle(double topLeftX, double topLeftY, double bottomRightX, double bottomRightY)

currentLineIndex	back to summary
public int currentLineIndex(Caret caret)

currentLineIndex	back to summary
public int currentLineIndex(int position)

dispose	back to summary
pack-priv void dispose()

getCaretBounds	back to summary
public <T extends Node & Caret> Bounds getCaretBounds(T caret)

getCaretBoundsOnScreen	back to summary
public <T extends Node & Caret> Bounds getCaretBoundsOnScreen(T caret)

getCaretOffsetX	back to summary
public <T extends Node & Caret> double getCaretOffsetX(T caret)

getClampedCaretPosition	back to summary
private int getClampedCaretPosition(Caret caret)

getCurrentLineEndPosition	back to summary
public int getCurrentLineEndPosition(Caret caret)

getCurrentLineStartPosition	back to summary
public int getCurrentLineStartPosition(Caret caret)

getParagraph	back to summary
public Paragraph<PS, SEG, S> getParagraph()

getRangeBoundsOnScreen	back to summary
public Bounds getRangeBoundsOnScreen(int from, int to)

getRangeShapeSafely	back to summary
private PathElement[] getRangeShapeSafely(IndexRange range)

getRangeShapeSafely back to summary

getRangeShapeSafely	back to summary
private PathElement[] getRangeShapeSafely(int start, int end) Gets the range shape for the given positions within the text, including the newline character, if range defined by the start/end arguments include it. Parameters start:int the start position of the range shape end:int the end position of the range shape. If `end == paragraph.length() + 1`, the newline character will be included in the selection by selecting the rest of the line

private PathElement[] getRangeShapeSafely(int start, int end)

Gets the range shape for the given positions within the text, including the newline character, if range defined by the start/end arguments include it.

Parameters

start:int: the start position of the range shape
end:int: the end position of the range shape. If end == paragraph.length() + 1, the newline character will be included in the selection by selecting the rest of the line

getSelectionBoundsOnScreen	back to summary
public Optional<Bounds> getSelectionBoundsOnScreen(Selection<PS, SEG, S> selection)

highlightTextFillProperty	back to summary
public ObjectProperty<Paint> highlightTextFillProperty()

layoutChildren back to summary

layoutChildren	back to summary
protected void layoutChildren() Overrides javafx.scene.text.TextFlow.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

protected void layoutChildren()

Overrides javafx.scene.text.TextFlow.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

selectionsProperty	back to summary
public final ObservableMap<Selection<PS, SEG, S>, SelectionPath> selectionsProperty()

toString	back to summary
public String toString() Overrides javafx.scene.Node.toString. Doc from javafx.scene.Node.toString. Returns a string representation for the object. Annotations @Override

toString

back to summary

public String toString()

Overrides javafx.scene.Node.toString.

Doc from javafx.scene.Node.toString.

Returns a string representation for the object.

Annotations

@Override

updateAllCaretShapes	back to summary
private void updateAllCaretShapes()

updateAllSelectionShapes	back to summary
private void updateAllSelectionShapes()

updateBackgroundShapes	back to summary
private void updateBackgroundShapes()

updateSingleCaret	back to summary
private void updateSingleCaret(CaretNode caretNode)

updateSingleSelection	back to summary
private void updateSingleSelection(SelectionPath path)

org.fxmisc.richtext back to summary

private Class ParagraphText.BorderAttributes

Class Inheritance

extends LineAttributesBase

java.lang.Object
org.fxmisc.richtext.ParagraphText.LineAttributesBase
org.fxmisc.richtext.ParagraphText.BorderAttributes

Field Summary

Modifier and Type	Field and Description
pack-priv final StrokeType	type

Inherited from org.fxmisc.richtext.ParagraphText.LineAttributesBase:: color dashArray width

Constructor Summary

Access	Constructor and Description
pack-priv	BorderAttributes(TextExt text)

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object obj) Overrides org.fxmisc.richtext.ParagraphText.LineAttributesBase.equals. Indicates whether some other object is "equal to" this one.
public boolean	equalsFaster(ParagraphText.BorderAttributes attr) Same as `equals(Object)` but no need to check the object for its class
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from org.fxmisc.richtext.ParagraphText.LineAttributesBase:: equalsFaster getSubString isNullValue

Field Detail

type	back to summary
pack-priv final StrokeType type

Constructor Detail

BorderAttributes	back to summary
pack-priv BorderAttributes(TextExt text)

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides org.fxmisc.richtext.ParagraphText.LineAttributesBase.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Annotations @Override

public boolean equals(Object obj)

Overrides org.fxmisc.richtext.ParagraphText.LineAttributesBase.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Annotations

@Override

equalsFaster	back to summary
public boolean equalsFaster(ParagraphText.BorderAttributes attr) Same as `equals(Object)` but no need to check the object for its class

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override

org.fxmisc.richtext back to summary

private Class ParagraphText.CustomCssShapeHelper<T>

Class Inheritance

extends Object

java.lang.Object
org.fxmisc.richtext.ParagraphText.CustomCssShapeHelper

Field Summary

Modifier and Type	Field and Description
private final Consumer<Path>	addToChildren
private final Consumer<Collection<Path>>	clearUnusedShapes
private final BiConsumer<Path, Tuple2<T, IndexRange>>	configureShape
private final Supplier<Path>	createShape
private final List<Tuple2<T, IndexRange>>	ranges
private final List<Path>	shapes

Constructor Summary

Access	Constructor and Description
pack-priv	CustomCssShapeHelper(Supplier<Path> createShape, BiConsumer<Path, Tuple2<T, IndexRange>> configureShape, Consumer<Path> addToChildren, Consumer<Collection<Path>> clearUnusedShapes)

Method Summary

Modifier and Type	Method and Description
private void	updateSharedShapeRange(T value, int start, int end, BiFunction<T, T, Boolean> equals) Calculates the range of a value (background color, underline, etc.) that is shared between multiple consecutive `TextExt` nodes
private void	updateSharedShapes() Updates the shapes calculated in `updateSharedShapeRange(Object, int, int, BiFunction)` and configures them via `configureShape`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

addToChildren	back to summary
private final Consumer<Path> addToChildren

clearUnusedShapes	back to summary
private final Consumer<Collection<Path>> clearUnusedShapes

configureShape	back to summary
private final BiConsumer<Path, Tuple2<T, IndexRange>> configureShape

createShape	back to summary
private final Supplier<Path> createShape

ranges	back to summary
private final List<Tuple2<T, IndexRange>> ranges

shapes	back to summary
private final List<Path> shapes

Constructor Detail

CustomCssShapeHelper	back to summary
pack-priv CustomCssShapeHelper(Supplier<Path> createShape, BiConsumer<Path, Tuple2<T, IndexRange>> configureShape, Consumer<Path> addToChildren, Consumer<Collection<Path>> clearUnusedShapes)

Method Detail

updateSharedShapeRange	back to summary
private void updateSharedShapeRange(T value, int start, int end, BiFunction<T, T, Boolean> equals) Calculates the range of a value (background color, underline, etc.) that is shared between multiple consecutive `TextExt` nodes

updateSharedShapes	back to summary
private void updateSharedShapes() Updates the shapes calculated in `updateSharedShapeRange(Object, int, int, BiFunction)` and configures them via `configureShape`.

org.fxmisc.richtext back to summary

private Class ParagraphText.LineAttributesBase

Class Inheritance

extends Object

java.lang.Object
org.fxmisc.richtext.ParagraphText.LineAttributesBase

Known Direct Subclasses

org.fxmisc.richtext.ParagraphText.BorderAttributes, org.fxmisc.richtext.ParagraphText.UnderlineAttributes

Field Summary

Modifier and Type	Field and Description
pack-priv final Paint	color
pack-priv final Double[]	dashArray
pack-priv final double	width

Constructor Summary

Access	Constructor and Description
pack-priv	LineAttributesBase(Paint color, Number width, ObjectProperty<Number[]> dashArrayProp) Java Quirk!

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public boolean	equalsFaster(ParagraphText.LineAttributesBase attr) Same as `equals(Object)` but no need to check the object for its class
protected final String	getSubString()
public final boolean	isNullValue()

Inherited from java.lang.Object:: clone finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

color	back to summary
pack-priv final Paint color

dashArray	back to summary
pack-priv final Double[] dashArray

width	back to summary
pack-priv final double width

Constructor Detail

LineAttributesBase	back to summary
pack-priv LineAttributesBase(Paint color, Number width, ObjectProperty<Number[]> dashArrayProp) Java Quirk! Using `t.get[border/underline]DashArray()` throws a ClassCastException "Double cannot be cast to Number". However, using `t.getDashArrayProperty().get()` works without issue

Method Detail

equals back to summary

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

Annotations

@Override

equalsFaster	back to summary
public boolean equalsFaster(ParagraphText.LineAttributesBase attr) Same as `equals(Object)` but no need to check the object for its class

getSubString	back to summary
protected final String getSubString()

isNullValue	back to summary
public final boolean isNullValue()

org.fxmisc.richtext back to summary

private Class ParagraphText.UnderlineAttributes

Class Inheritance

extends LineAttributesBase

java.lang.Object
org.fxmisc.richtext.ParagraphText.LineAttributesBase
org.fxmisc.richtext.ParagraphText.UnderlineAttributes

Field Summary

Modifier and Type	Field and Description
pack-priv final StrokeLineCap	cap
pack-priv final double	doubleGap
pack-priv final double	offset
pack-priv final double	waveRadius

Inherited from org.fxmisc.richtext.ParagraphText.LineAttributesBase:: color dashArray width

Constructor Summary

Access	Constructor and Description
pack-priv	UnderlineAttributes(TextExt text)

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object obj) Overrides org.fxmisc.richtext.ParagraphText.LineAttributesBase.equals. Indicates whether some other object is "equal to" this one.
public boolean	equalsFaster(ParagraphText.UnderlineAttributes attr) Same as `equals(Object)` but no need to check the object for its class
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from org.fxmisc.richtext.ParagraphText.LineAttributesBase:: equalsFaster getSubString isNullValue

Field Detail

cap	back to summary
pack-priv final StrokeLineCap cap

doubleGap	back to summary
pack-priv final double doubleGap

offset	back to summary
pack-priv final double offset

waveRadius	back to summary
pack-priv final double waveRadius

Constructor Detail

UnderlineAttributes	back to summary
pack-priv UnderlineAttributes(TextExt text)

Method Detail

equals back to summary

public boolean equals(Object obj)

Overrides org.fxmisc.richtext.ParagraphText.LineAttributesBase.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

Annotations

@Override

equalsFaster	back to summary
public boolean equalsFaster(ParagraphText.UnderlineAttributes attr) Same as `equals(Object)` but no need to check the object for its class

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override

pack-priv Class ParagraphText<PS, SEG, S>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class ParagraphText.BorderAttributes

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class ParagraphText.CustomCssShapeHelper<T>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class ParagraphText.LineAttributesBase

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class ParagraphText.UnderlineAttributes

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail