APIdia Launch Partner
Top Description Fields Constructors Methods
com.sun.javafx.text

public abstract non-sealed Class PrismLayoutInfo

extends LayoutInfo
Class Inheritance
Imports
java.util.ArrayList, .Collections, .List, .Objects, javafx.geometry.Rectangle2D, javafx.scene.text.CaretInfo, .LayoutInfo, .TextLineInfo, com.sun.javafx.geom.BaseBounds, com.sun.javafx.scene.text.TextLayout, .TextLine
Layout information as reported by PrismLayout.

Field Summary

Modifier and TypeField and Description
private final TextLayout
layout

Constructor Summary

AccessConstructor and Description
public
PrismLayoutInfo(TextLayout layout)

Method Summary

Modifier and TypeMethod and Description
public CaretInfo
caretInfoAt(int charIndex, boolean leading)

Implements abstract javafx.scene.text.LayoutInfo.caretInfoAt.

Returns the information related to the caret at the specified character index and the character bias.

protected abstract double
dx()

protected abstract double
dy()

private List<Rectangle2D>
getGeometry(int start, int end, int type, double lineSpacing)

public Rectangle2D
getLogicalBounds(boolean includeLineSpacing)

Implements abstract javafx.scene.text.LayoutInfo.getLogicalBounds.

Returns the logical bounds of the layout.

public List<Rectangle2D>
getSelectionGeometry(int start, int end, boolean includeLineSpacing)

Implements abstract javafx.scene.text.LayoutInfo.getSelectionGeometry.

Returns the geometry of the text selection, as an immutable list of Rectangle2D objects, for the given start and end offsets.

public List<Rectangle2D>
getStrikeThroughGeometry(int start, int end)

Implements abstract javafx.scene.text.LayoutInfo.getStrikeThroughGeometry.

Returns the geometry of the strike-through shape, as an immutable list of Rectangle2D objects, for the given start and end offsets.

public TextLineInfo
getTextLine(int index, boolean includeLineSpacing)

Implements abstract javafx.scene.text.LayoutInfo.getTextLine.

Returns the TextLineInfo object which contains information about the text line at index index.

public int
getTextLineCount()

Implements abstract javafx.scene.text.LayoutInfo.getTextLineCount.

Returns the number of text lines in the layout.

public List<TextLineInfo>
getTextLines(boolean includeLineSpacing)

Implements abstract javafx.scene.text.LayoutInfo.getTextLines.

Returns the immutable list of text lines in the layout.

public List<Rectangle2D>
getUnderlineGeometry(int start, int end)

Implements abstract javafx.scene.text.LayoutInfo.getUnderlineGeometry.

Returns the geometry of the underline shape, as an immutable list of Rectangle2D objects, for the given start and end offsets.

protected abstract double
lineSpacing()

Field Detail

layoutback to summary
private final TextLayout layout

Constructor Detail

PrismLayoutInfoback to summary
public PrismLayoutInfo(TextLayout layout)

Method Detail

caretInfoAtback to summary
public CaretInfo caretInfoAt(int charIndex, boolean leading)

Implements abstract javafx.scene.text.LayoutInfo.caretInfoAt.

Doc from javafx.scene.text.LayoutInfo.caretInfoAt.

Returns the information related to the caret at the specified character index and the character bias.

Annotations
@Override
dxback to summary
protected abstract double dx()
dyback to summary
protected abstract double dy()
getGeometryback to summary
private List<Rectangle2D> getGeometry(int start, int end, int type, double lineSpacing)
getLogicalBoundsback to summary
public Rectangle2D getLogicalBounds(boolean includeLineSpacing)

Implements abstract javafx.scene.text.LayoutInfo.getLogicalBounds.

Doc from javafx.scene.text.LayoutInfo.getLogicalBounds.

Returns the logical bounds of the layout. Depending on includeLineSpacing, the return value may include the line spacing after the last line of text.

Annotations
@Override
getSelectionGeometryback to summary
public List<Rectangle2D> getSelectionGeometry(int start, int end, boolean includeLineSpacing)

Implements abstract javafx.scene.text.LayoutInfo.getSelectionGeometry.

Doc from javafx.scene.text.LayoutInfo.getSelectionGeometry.

Returns the geometry of the text selection, as an immutable list of Rectangle2D objects, for the given start and end offsets.

Annotations
@Override
getStrikeThroughGeometryback to summary
public List<Rectangle2D> getStrikeThroughGeometry(int start, int end)

Implements abstract javafx.scene.text.LayoutInfo.getStrikeThroughGeometry.

Doc from javafx.scene.text.LayoutInfo.getStrikeThroughGeometry.

Returns the geometry of the strike-through shape, as an immutable list of Rectangle2D objects, for the given start and end offsets.

Annotations
@Override
getTextLineback to summary
public TextLineInfo getTextLine(int index, boolean includeLineSpacing)

Implements abstract javafx.scene.text.LayoutInfo.getTextLine.

Doc from javafx.scene.text.LayoutInfo.getTextLine.

Returns the TextLineInfo object which contains information about the text line at index index.

Annotations
@Override
getTextLineCountback to summary
public int getTextLineCount()

Implements abstract javafx.scene.text.LayoutInfo.getTextLineCount.

Doc from javafx.scene.text.LayoutInfo.getTextLineCount.

Returns the number of text lines in the layout.

Annotations
@Override
getTextLinesback to summary
public List<TextLineInfo> getTextLines(boolean includeLineSpacing)

Implements abstract javafx.scene.text.LayoutInfo.getTextLines.

Doc from javafx.scene.text.LayoutInfo.getTextLines.

Returns the immutable list of text lines in the layout.

Annotations
@Override
getUnderlineGeometryback to summary
public List<Rectangle2D> getUnderlineGeometry(int start, int end)

Implements abstract javafx.scene.text.LayoutInfo.getUnderlineGeometry.

Doc from javafx.scene.text.LayoutInfo.getUnderlineGeometry.

Returns the geometry of the underline shape, as an immutable list of Rectangle2D objects, for the given start and end offsets.

Annotations
@Override
lineSpacingback to summary
protected abstract double lineSpacing()