JavaFX 27 · com.sun.javafx.text.PrismTextLayout · APIdia, the JavaDoc alternative

Field Summary

Modifier and Type	Field and Description
private static final Object	CACHE_SIZE_LOCK
private Integer	cacheKey
private static int	cacheSize
private int	flags
private PGFont	font
private static final BaseTransform	IDENTITY
private LayoutCache	layoutCache
private float	layoutHeight
private float	layoutWidth
private PrismTextLine[]	lines
private BaseBounds	logicalBounds
private static final int	MAX_STRING_SIZE
private final int	maxCacheSize
private int	runCount
private TextRun[]	runs
private Shape	shape
private float	spacing
private TextSpan[]	spans
private FontStrike	strike
private static final Hashtable<Integer, LayoutCache>	stringCache
private TabAdvancePolicy	tabAdvancePolicy
private char[]	text
private RectBounds	visualBounds
private float	wrapWidth
private static final int	X_MAX_INDEX
private static final int	X_MIN_INDEX
private static final int	Y_MAX_INDEX
private static final int	Y_MIN_INDEX

Constructor Summary

Access	Constructor and Description
public	PrismTextLayout(int maxCacheSize)

Method Summary

Modifier and Type	Method and Description
public void	addTextRun(TextRun run)
private void	buildRuns(char[] chars)
private float	computeLayoutShift(TextSpan span)
private void	computeSideBearings(PrismTextLine line)
private float	Returns: the X size of the white space trailing the run computeTrailingSpaceWidth(TextRun the run to compute trailing space width for, cannot be `null` run) Computes the size of the white space trailing a given run.
private PrismTextLine	createLine(int start, int end, int startOffset, float collapsedSpaceWidth)
private void	ensureLayout()
public BaseBounds	getBounds() Implements com.sun.javafx.scene.text.TextLayout.getBounds. Returns the (logical) bounds of the layout minX is always zero minY is the ascent of the first line (negative) width the width of the widest line height the sum of all lines height Note that this width is different the wrapping width!
public BaseBounds	getBounds(TextSpan filter, BaseBounds bounds) Implements com.sun.javafx.scene.text.TextLayout.getBounds.
public TextLayout.CaretGeometry	getCaretGeometry(int offset, boolean isLeading) Implements com.sun.javafx.scene.text.TextLayout.getCaretGeometry. Queries the caret geometry and associated information at the specified text position.
private int	getCharCount()
public int	getDirection()
public PGFont	getFont()
public TextLayout.Hit	getHitInfo(float x, float y) Implements com.sun.javafx.scene.text.TextLayout.getHitInfo. Calculates character index and insertion index for the given coordinates and maps to `Hit` class.
private int	getLineCount()
private int	getLineIndex(float y) * Text Layout Implementation * *
public TextLine[]	getLines() Implements com.sun.javafx.scene.text.TextLayout.getLines. Returns the lines of text layout.
private float	getMirroringWidth()
public void	getRange(int start, int end, int type, TextLayout.GeometryCallback client) Implements com.sun.javafx.scene.text.TextLayout.getRange. Queries the range geometry of the range of text within the text layout for one of the three possible types: `TYPE_STRIKETHROUGH` - strike-through shape `TYPE_TEXT` - text selection shape `TYPE_UNDERLINE` - underline shape
public GlyphList[]	getRuns() Implements com.sun.javafx.scene.text.TextLayout.getRuns. Returns the GlyphList of text layout.
public Shape	getShape(int type, TextSpan filter) Implements com.sun.javafx.scene.text.TextLayout.getShape. Returns the shape of the entire text layout relative to the baseline of the first line.
private float	getSpaceAdvance()
private char[]	getText()
public TextSpan[]	getTextSpans()
public BaseBounds	getVisualBounds(int type) Implements com.sun.javafx.scene.text.TextLayout.getVisualBounds. Returns the visual bounds of the layout using glyph bounding box
protected GlyphLayout	glyphLayout()
private void	initCache()
private boolean	isMirrored()
private boolean	isSimpleLayout()
private void	layout()
private boolean	Returns: true, if only the runs can be reused onlyReuseRuns() Decides whether the text layout is worth caching and/or if we can reuse it completely or only the runs.
private void	relayout()
private void	reorderLine(PrismTextLine line)
private void	reset()
private void	reuseRuns()
public boolean	setAlignment(int alignment) Implements com.sun.javafx.scene.text.TextLayout.setAlignment. Sets the alignment for the TextLayout.
public boolean	setBoundsType(int type) Implements com.sun.javafx.scene.text.TextLayout.setBoundsType. Sets the bounds type for the TextLayout.
public boolean	setContent(TextSpan[] spans) Implements com.sun.javafx.scene.text.TextLayout.setContent. * TextLayout API * *
public boolean	setContent(String text, Object font) Implements com.sun.javafx.scene.text.TextLayout.setContent. Sets the content for the TextLayout.
public boolean	setDirection(int direction) Implements com.sun.javafx.scene.text.TextLayout.setDirection. Sets the direction (bidi algorithm's) for the TextLayout.
public boolean	setLineSpacing(float spacing) Implements com.sun.javafx.scene.text.TextLayout.setLineSpacing. Sets the line spacing for the TextLayout.
public boolean	setTabAdvancePolicy(int tabSize, TabAdvancePolicy policy) Implements com.sun.javafx.scene.text.TextLayout.setTabAdvancePolicy. Sets the tab size and the tab advance policy for the TextLayout.
public boolean	setWrapWidth(float newWidth) Implements com.sun.javafx.scene.text.TextLayout.setWrapWidth. Sets the wrap width for the TextLayout.
private void	shape(TextRun run, char[] chars, GlyphLayout layout)

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

Field Detail

CACHE_SIZE_LOCK	back to summary
private static final Object CACHE_SIZE_LOCK

cacheKey	back to summary
private Integer cacheKey

cacheSize	back to summary
private static int cacheSize

flags	back to summary
private int flags

font	back to summary
private PGFont font

IDENTITY	back to summary
private static final BaseTransform IDENTITY

layoutCache	back to summary
private LayoutCache layoutCache

layoutHeight	back to summary
private float layoutHeight

layoutWidth	back to summary
private float layoutWidth

lines	back to summary
private PrismTextLine[] lines

logicalBounds	back to summary
private BaseBounds logicalBounds

MAX_STRING_SIZE	back to summary
private static final int MAX_STRING_SIZE

maxCacheSize	back to summary
private final int maxCacheSize

runCount	back to summary
private int runCount

runs	back to summary
private TextRun[] runs

shape	back to summary
private Shape shape

spacing	back to summary
private float spacing

spans	back to summary
private TextSpan[] spans

strike	back to summary
private FontStrike strike

stringCache	back to summary
private static final Hashtable<Integer, LayoutCache> stringCache

tabAdvancePolicy	back to summary
private TabAdvancePolicy tabAdvancePolicy

text	back to summary
private char[] text

visualBounds	back to summary
private RectBounds visualBounds

wrapWidth	back to summary
private float wrapWidth

X_MAX_INDEX	back to summary
private static final int X_MAX_INDEX

X_MIN_INDEX	back to summary
private static final int X_MIN_INDEX

Y_MAX_INDEX	back to summary
private static final int Y_MAX_INDEX

Y_MIN_INDEX	back to summary
private static final int Y_MIN_INDEX

Constructor Detail

PrismTextLayout	back to summary
public PrismTextLayout(int maxCacheSize)

Method Detail

addTextRun	back to summary
public void addTextRun(TextRun run)

buildRuns	back to summary
private void buildRuns(char[] chars)

computeLayoutShift	back to summary
private float computeLayoutShift(TextSpan span)

computeSideBearings	back to summary
private void computeSideBearings(PrismTextLine line)

computeTrailingSpaceWidth back to summary

computeTrailingSpaceWidth	back to summary
private float computeTrailingSpaceWidth(TextRun run) Computes the size of the white space trailing a given run. Parameters run:TextRun the run to compute trailing space width for, cannot be `null` Returns:float the X size of the white space trailing the run

private float computeTrailingSpaceWidth(TextRun run)

Computes the size of the white space trailing a given run.

Parameters

run:TextRun: the run to compute trailing space width for, cannot be null

Returns:float

the X size of the white space trailing the run

createLine	back to summary
private PrismTextLine createLine(int start, int end, int startOffset, float collapsedSpaceWidth)

ensureLayout	back to summary
private void ensureLayout()

getBounds	back to summary
public BaseBounds getBounds() Implements com.sun.javafx.scene.text.TextLayout.getBounds. Doc from com.sun.javafx.scene.text.TextLayout.getBounds. Returns the (logical) bounds of the layout minX is always zero minY is the ascent of the first line (negative) width the width of the widest line height the sum of all lines height Note that this width is different the wrapping width! Annotations @Override

getBounds

back to summary

public BaseBounds getBounds()

Implements com.sun.javafx.scene.text.TextLayout.getBounds.

Doc from com.sun.javafx.scene.text.TextLayout.getBounds.

Returns the (logical) bounds of the layout minX is always zero minY is the ascent of the first line (negative) width the width of the widest line height the sum of all lines height Note that this width is different the wrapping width!

Annotations

@Override

getBounds	back to summary
public BaseBounds getBounds(TextSpan filter, BaseBounds bounds) Implements com.sun.javafx.scene.text.TextLayout.getBounds. Annotations @Override

getBounds

back to summary

public BaseBounds getBounds(TextSpan filter, BaseBounds bounds)

Implements com.sun.javafx.scene.text.TextLayout.getBounds.

Annotations

@Override

getCaretGeometry	back to summary
public TextLayout.CaretGeometry getCaretGeometry(int offset, boolean isLeading) Implements com.sun.javafx.scene.text.TextLayout.getCaretGeometry. Doc from com.sun.javafx.scene.text.TextLayout.getCaretGeometry. Queries the caret geometry and associated information at the specified text position. Annotations @Override

getCaretGeometry

back to summary

public TextLayout.CaretGeometry getCaretGeometry(int offset, boolean isLeading)

Implements com.sun.javafx.scene.text.TextLayout.getCaretGeometry.

Doc from com.sun.javafx.scene.text.TextLayout.getCaretGeometry.

Queries the caret geometry and associated information at the specified text position.

Annotations

@Override

getCharCount	back to summary
private int getCharCount()

getDirection	back to summary
public int getDirection()

getFont	back to summary
public PGFont getFont()

getHitInfo back to summary

getHitInfo	back to summary
public TextLayout.Hit getHitInfo(float x, float y) Implements com.sun.javafx.scene.text.TextLayout.getHitInfo. Doc from com.sun.javafx.scene.text.TextLayout.getHitInfo. Calculates character index and insertion index for the given coordinates and maps to `Hit` class. Annotations @Override

public TextLayout.Hit getHitInfo(float x, float y)

Implements com.sun.javafx.scene.text.TextLayout.getHitInfo.

Doc from com.sun.javafx.scene.text.TextLayout.getHitInfo.

Calculates character index and insertion index for the given coordinates and maps to Hit class.

Annotations

@Override

getLineCount	back to summary
private int getLineCount()

getLineIndex	back to summary
private int getLineIndex(float y) * Text Layout Implementation * *

getLines	back to summary
public TextLine[] getLines() Implements com.sun.javafx.scene.text.TextLayout.getLines. Doc from com.sun.javafx.scene.text.TextLayout.getLines. Returns the lines of text layout. Annotations @Override

getLines

back to summary

public TextLine[] getLines()

Implements com.sun.javafx.scene.text.TextLayout.getLines.

Doc from com.sun.javafx.scene.text.TextLayout.getLines.

Returns the lines of text layout.

Annotations

@Override

getMirroringWidth	back to summary
private float getMirroringWidth()

getRange back to summary

public void getRange(int start, int end, int type, TextLayout.GeometryCallback client)

Implements com.sun.javafx.scene.text.TextLayout.getRange.

Doc from com.sun.javafx.scene.text.TextLayout.getRange.

Queries the range geometry of the range of text within the text layout for one of the three possible types:

TYPE_STRIKETHROUGH - strike-through shape
TYPE_TEXT - text selection shape
TYPE_UNDERLINE - underline shape

Annotations

@Override

getRuns

back to summary

public GlyphList[] getRuns()

Implements com.sun.javafx.scene.text.TextLayout.getRuns.

Doc from com.sun.javafx.scene.text.TextLayout.getRuns.

Returns the GlyphList of text layout. The runs are returned order visually (rendering order), starting from the first line.

Annotations

@Override

getShape

back to summary

public Shape getShape(int type, TextSpan filter)

Implements com.sun.javafx.scene.text.TextLayout.getShape.

Doc from com.sun.javafx.scene.text.TextLayout.getShape.

Returns the shape of the entire text layout relative to the baseline of the first line.

Annotations

@Override

getSpaceAdvance	back to summary
private float getSpaceAdvance()

getText	back to summary
private char[] getText()

getTextSpans	back to summary
public TextSpan[] getTextSpans()

getVisualBounds

back to summary

public BaseBounds getVisualBounds(int type)

Implements com.sun.javafx.scene.text.TextLayout.getVisualBounds.

Doc from com.sun.javafx.scene.text.TextLayout.getVisualBounds.

Returns the visual bounds of the layout using glyph bounding box

Annotations

@Override

glyphLayout	back to summary
protected GlyphLayout glyphLayout()

initCache	back to summary
private void initCache()

isMirrored	back to summary
private boolean isMirrored()

isSimpleLayout	back to summary
private boolean isSimpleLayout()

layout

back to summary

private void layout()

onlyReuseRuns

back to summary

private boolean onlyReuseRuns()

Decides whether the text layout is worth caching and/or if we can reuse it completely or only the runs. A text layout is worth caching and to be reused completely when the text layout uses the (simple) default settings.
If the text layout was cached, and we now have a text layout with the same text and font but settings that differ from the default, we can reuse the runs as they are structurally the same. However, the metrics need to be (re)calculated, so we cannot use more from the cache.