JavaFX 24 · 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 TextLine[]	lines
private BaseBounds	logicalBounds
private static final int	MAX_CACHE_SIZE
private static final int	MAX_STRING_SIZE
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 int	tabSize
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()

Method Summary

Modifier and Type	Method and Description
public void	addTextRun(TextRun run)
private void	buildRuns(char[] chars)
private void	computeSideBearings(TextLine 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 boolean	copyCache()
private TextLine	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 PathElement[]	getCaretShape(int offset, boolean isLeading, float x, float y) Implements com.sun.javafx.scene.text.TextLayout.getCaretShape.
private int	getCharCount()
public int	getDirection()
public PGFont	getFont()
public TextLayout.Hit	getHitInfo(float x coordinate value. x, float y coordinate value. 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 PathElement[]	getRange(int start, int end, int type, float x, float y) Implements com.sun.javafx.scene.text.TextLayout.getRange.
public GlyphList[]	getRuns() Implements com.sun.javafx.scene.text.TextLayout.getRuns. Returns the GlyphList of text layout.
public Shape	getShape(int the type of the shapes to include 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	getTabAdvance()
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
private void	initCache()
private boolean	isMirrored()
private boolean	isSimpleLayout()
private void	layout()
private void	relayout()
private void	reorderLine(TextLine 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	setTabSize(int the number of spaces represented by a tab. Default is 8. Minimum is 1, lower values will be clamped to 1. spaces) Implements com.sun.javafx.scene.text.TextLayout.setTabSize. Sets the tab size 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 TextLine[] lines

logicalBounds	back to summary
private BaseBounds logicalBounds

MAX_CACHE_SIZE	back to summary
private static final int MAX_CACHE_SIZE

MAX_STRING_SIZE	back to summary
private static final int MAX_STRING_SIZE

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

tabSize	back to summary
private int tabSize

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()

Method Detail

addTextRun	back to summary
public void addTextRun(TextRun run)

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

computeSideBearings	back to summary
private void computeSideBearings(TextLine 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

copyCache	back to summary
private boolean copyCache()

createLine	back to summary
private TextLine 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! Returns:BaseBounds the layout bounds 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!

Returns:BaseBounds

the layout bounds

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

getCaretShape	back to summary
public PathElement[] getCaretShape(int offset, boolean isLeading, float x, float y) Implements com.sun.javafx.scene.text.TextLayout.getCaretShape. Annotations @Override

getCaretShape

back to summary

public PathElement[] getCaretShape(int offset, boolean isLeading, float x, float y)

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

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. Parameters x:float x coordinate value. y:float y coordinate value. Returns:TextLayout.Hit returns a `Hit` object containing character index, insertion index and position of cursor on the character. 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.

Parameters

x:float: x coordinate value.
y:float: y coordinate value.

Returns:TextLayout.Hit

returns a Hit object containing character index, insertion index and position of cursor on the character.

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. Returns:TextLine[] the text lines 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.

Returns:TextLine[]

the text lines

Annotations

@Override

getMirroringWidth	back to summary
private float getMirroringWidth()

getRange

back to summary

public PathElement[] getRange(int start, int end, int type, float x, float y)

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

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.

Returns:GlyphList[]

the runs

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.

Parameters

type:int: the type of the shapes to include

Returns:Shape

the shape

Annotations

@Override

getTabAdvance	back to summary
private float getTabAdvance()

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

Returns:BaseBounds

the visual bounds

Annotations

@Override

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()

relayout	back to summary
private void relayout()

reorderLine	back to summary
private void reorderLine(TextLine line)

reset	back to summary
private void reset()

reuseRuns	back to summary
private void reuseRuns()

setAlignment

back to summary

public boolean setAlignment(int alignment)

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

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

Sets the alignment for the TextLayout.

Returns:boolean

returns true is the call modifies the layout internal state.

Annotations

@Override

setBoundsType

back to summary

public boolean setBoundsType(int type)

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

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

Sets the bounds type for the TextLayout.

Returns:boolean

returns true is the call modifies the layout internal state.

Annotations

@Override

setContent

back to summary

public boolean setContent(TextSpan[] spans)

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

* TextLayout API * *

Returns:boolean

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

returns true is the call modifies the layout internal state.

Annotations

@Override

setContent

back to summary

public boolean setContent(String text, Object font)

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

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

Sets the content for the TextLayout. Shorthand for single span text (no rich text).

Returns:boolean

returns true is the call modifies the layout internal state.

Annotations

@Override

setDirection

back to summary

public boolean setDirection(int direction)

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

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

Sets the direction (bidi algorithm's) for the TextLayout.

Returns:boolean

returns true is the call modifies the layout internal state.

Annotations

@Override

setLineSpacing

back to summary

public boolean setLineSpacing(float spacing)

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

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

Sets the line spacing for the TextLayout.

Returns:boolean

returns true is the call modifies the layout internal state.

Annotations

@Override

setTabSize

back to summary

public boolean setTabSize(int spaces)

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

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

Sets the tab size for the TextLayout.

Parameters

spaces:int: the number of spaces represented by a tab. Default is 8. Minimum is 1, lower values will be clamped to 1.

Returns:boolean

returns true if the call modifies the layout internal state.

Annotations

@Override

setWrapWidth

back to summary

public boolean setWrapWidth(float newWidth)

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

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

Sets the wrap width for the TextLayout.

Returns:boolean

returns true is the call modifies the layout internal state.

Annotations

@Override

shape	back to summary
private void shape(TextRun run, char[] chars, GlyphLayout layout)

public Class PrismTextLayout

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail