Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	ParagraphBox.CaretOffsetX An opaque class representing horizontal caret offset.

Field Summary

Modifier and Type	Field and Description
private final Val<Node>	graphic
private final ObjectProperty<IntFunction<? extends Node>>	graphicFactory
pack-priv final DoubleProperty	graphicOffset
private final Var<Integer>	index
private final Val<Boolean>	isFolded
private final ParagraphText<PS, SEG, S>	text
private final BooleanProperty	wrapText

Inherited from javafx.scene.layout.Region:: USE_COMPUTED_SIZE USE_PREF_SIZE

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
public final ObservableSet<CaretNode>	caretsProperty()
protected double	computeMinWidth(double ignoredHeight) Overrides javafx.scene.layout.Region.computeMinWidth. Computes the minimum width of this region.
protected double	computePrefHeight(double 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 ignoredHeight) Overrides javafx.scene.layout.Region.computePrefWidth. Computes the preferred width of this region for the given height.
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> ParagraphBox.CaretOffsetX	getCaretOffsetX(T caret)
public int	getCurrentLineEndPosition(Caret caret)
public int	getCurrentLineIndex(Caret caret)
public int	getCurrentLineIndex(int position)
public int	getCurrentLineStartPosition(Caret caret)
pack-priv Node	getGraphic()
pack-priv double	getGraphicPrefWidth()
public int	getIndex()
public int	getLineCount()
pack-priv Paragraph<PS, SEG, S>	getParagraph()
public Bounds	getRangeBoundsOnScreen(int from, int to)
public Optional<Bounds>	getSelectionBoundsOnScreen(Selection<PS, SEG, S> selection)
public ObjectProperty<IntFunction<? extends Node>>	graphicFactoryProperty()
public Property<Paint>	highlightTextFillProperty()
public CharacterHit	hit(Point2D pos)
public CharacterHit	hit(double x, double y)
pack-priv CharacterHit	Returns: hit info for the given x and y coordinates hitText(ParagraphBox.CaretOffsetX x, double y) Hits the embedded TextFlow at the given x and y offset.
pack-priv CharacterHit	Returns: hit info for the given line and x coordinate hitTextLine(ParagraphBox.CaretOffsetX x coordinate relative to the embedded TextFlow. x, int index of the line in the embedded TextFlow. line) Hits the embedded TextFlow at the given line and x offset.
public Val<Integer>	indexProperty()
public boolean	isFolded()
protected void	layoutChildren() Overrides javafx.scene.Parent.layoutChildren. Invoked during the layout pass to layout the children in this `Parent`.
public final ObservableMap<Selection<PS, SEG, S>, SelectionPath>	selectionsProperty()
public void	setIndex(int index)
public EventStream<Either<Tuple2<Point2D, Integer>, Object>>	stationaryIndices(Duration delay)
public String	toString() Overrides javafx.scene.Node.toString. Returns a string representation for the object.
public BooleanProperty	wrapTextProperty()

Inherited from javafx.scene.layout.Region:: backgroundProperty borderProperty cacheShapeProperty centerShapeProperty computeMaxHeight computeMaxWidth computeMinHeight getBackground getBorder getClassCssMetaData getCssMetaData getHeight getInsets getMaxHeight getMaxWidth getMinHeight getMinWidth getOpaqueInsets getPadding getPrefHeight getPrefWidth getShape getUserAgentStylesheet getWidth heightProperty insetsProperty isCacheShape isCenterShape isResizable isScaleShape isSnapToPixel layoutInArea layoutInArea layoutInArea layoutInArea maxHeight maxHeightProperty maxWidth maxWidthProperty minHeight minHeightProperty minWidth minWidthProperty opaqueInsetsProperty paddingProperty positionInArea positionInArea prefHeight prefHeightProperty prefWidth prefWidthProperty resize scaleShapeProperty setBackground setBorder setCacheShape setCenterShape setHeight setMaxHeight setMaxSize setMaxWidth setMinHeight setMinSize setMinWidth setOpaqueInsets setPadding setPrefHeight setPrefSize setPrefWidth setScaleShape setShape setSnapToPixel setWidth shapeProperty snappedBottomInset snappedLeftInset snappedRightInset snappedTopInset snapPosition snapPositionX snapPositionY snapSize snapSizeX snapSizeY snapSpace snapSpaceX snapSpaceY snapToPixelProperty widthProperty

Field Detail

graphic	back to summary
private final Val<Node> graphic

graphicFactory	back to summary
private final ObjectProperty<IntFunction<? extends Node>> graphicFactory

graphicOffset	back to summary
pack-priv final DoubleProperty graphicOffset

index	back to summary
private final Var<Integer> index

isFolded	back to summary
private final Val<Boolean> isFolded

text	back to summary
private final ParagraphText<PS, SEG, S> text

wrapText	back to summary
private final BooleanProperty wrapText

Constructor Detail

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

Method Detail

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

computeMinWidth	back to summary
protected double computeMinWidth(double ignoredHeight) Overrides javafx.scene.layout.Region.computeMinWidth. Doc from javafx.scene.layout.Region.computeMinWidth. Computes the minimum width of this region. Returns the sum of the left and right insets by default. 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. Annotations @Override

computeMinWidth

back to summary

protected double computeMinWidth(double ignoredHeight)

Overrides javafx.scene.layout.Region.computeMinWidth.

Doc from javafx.scene.layout.Region.computeMinWidth.

Computes the minimum width of this region. Returns the sum of the left and right insets by default. 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.

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. 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.

Annotations

@Override

computePrefWidth	back to summary
protected double computePrefWidth(double ignoredHeight) 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. Annotations @Override

computePrefWidth

back to summary

protected double computePrefWidth(double ignoredHeight)

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.

Annotations

@Override

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> ParagraphBox.CaretOffsetX getCaretOffsetX(T caret)

getCurrentLineEndPosition	back to summary
public int getCurrentLineEndPosition(Caret caret)

getCurrentLineIndex	back to summary
public int getCurrentLineIndex(Caret caret)

getCurrentLineIndex	back to summary
public int getCurrentLineIndex(int position)

getCurrentLineStartPosition	back to summary
public int getCurrentLineStartPosition(Caret caret)

getGraphic	back to summary
pack-priv Node getGraphic()

getGraphicPrefWidth	back to summary
pack-priv double getGraphicPrefWidth()

getIndex	back to summary
public int getIndex()

getLineCount	back to summary
public int getLineCount()

getParagraph	back to summary
pack-priv Paragraph<PS, SEG, S> getParagraph()

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

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

graphicFactoryProperty	back to summary
public ObjectProperty<IntFunction<? extends Node>> graphicFactoryProperty()

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

hit	back to summary
public CharacterHit hit(Point2D pos)

hit	back to summary
public CharacterHit hit(double x, double y)

hitText	back to summary
pack-priv CharacterHit hitText(ParagraphBox.CaretOffsetX x, double y) Hits the embedded TextFlow at the given x and y offset. Returns:CharacterHit hit info for the given x and y coordinates

hitText

back to summary

pack-priv CharacterHit hitText(ParagraphBox.CaretOffsetX x, double y)

Hits the embedded TextFlow at the given x and y offset.

Returns:CharacterHit: hit info for the given x and y coordinates

hitTextLine	back to summary
pack-priv CharacterHit hitTextLine(ParagraphBox.CaretOffsetX x, int line) Hits the embedded TextFlow at the given line and x offset. Parameters x:ParagraphBox.CaretOffsetX x coordinate relative to the embedded TextFlow. line:int index of the line in the embedded TextFlow. Returns:CharacterHit hit info for the given line and x coordinate

hitTextLine

back to summary

pack-priv CharacterHit hitTextLine(ParagraphBox.CaretOffsetX x, int line)

Hits the embedded TextFlow at the given line and x offset.

Parameters

x:ParagraphBox.CaretOffsetX: x coordinate relative to the embedded TextFlow.
line:int: index of the line in the embedded TextFlow.

Returns:CharacterHit

hit info for the given line and x coordinate

indexProperty	back to summary
public Val<Integer> indexProperty()

isFolded	back to summary
public boolean isFolded()

layoutChildren back to summary

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

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

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

setIndex	back to summary
public void setIndex(int index)

stationaryIndices	back to summary
public EventStream<Either<Tuple2<Point2D, Integer>, Object>> stationaryIndices(Duration delay)

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

wrapTextProperty	back to summary
public BooleanProperty wrapTextProperty()

org.fxmisc.richtext back to summary

public Class ParagraphBox.CaretOffsetX

Class Inheritance

extends Object

java.lang.Object
org.fxmisc.richtext.ParagraphBox.CaretOffsetX

An opaque class representing horizontal caret offset. Although it is just a wrapper around double, its purpose is to increase type safety.

Field Summary

Modifier and Type	Field and Description
private final double	value

Constructor Summary

Access	Constructor and Description
private	CaretOffsetX(double value)

Method Summary

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

Field Detail

value	back to summary
private final double value

Constructor Detail

CaretOffsetX	back to summary
private CaretOffsetX(double value)

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

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class ParagraphBox.CaretOffsetX

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail