JavaFX 24 · com.sun.javafx.text.TextRun · APIdia, the JavaDoc alternative

Field Summary

Modifier and Type	Field and Description
private float	ascent
pack-priv int	cacheIndex
pack-priv float	cacheWidth
pack-priv int[]	charIndices
private float	descent
pack-priv int	flags
pack-priv static final int	FLAGS_CANONICAL
pack-priv static final int	FLAGS_COMPACT
pack-priv static final int	FLAGS_COMPLEX
pack-priv static final int	FLAGS_EMBEDDED
pack-priv static final int	FLAGS_LEFT_BEARING
pack-priv static final int	FLAGS_LINEBREAK
pack-priv static final int	FLAGS_NO_LINK_AFTER
pack-priv static final int	FLAGS_NO_LINK_BEFORE
pack-priv static final int	FLAGS_RIGHT_BEARING
pack-priv static final int	FLAGS_SOFTBREAK
pack-priv static final int	FLAGS_SPLIT
pack-priv static final int	FLAGS_SPLIT_LAST
pack-priv static final int	FLAGS_TAB
pack-priv int[]	gids
pack-priv int	glyphCount
private float	leading
pack-priv int	length
pack-priv byte	level
pack-priv TextLine	line
pack-priv Point2D	location
pack-priv float[]	positions
pack-priv int	script
pack-priv int	slot
pack-priv TextSpan	span
pack-priv int	start
pack-priv float	width

Constructor Summary

Access	Constructor and Description
public	TextRun(int start, int length, byte level, boolean complex, int script, TextSpan span, int slot, boolean canonical)

Method Summary

Modifier and Type	Method and Description
public float	getAdvance(int glyphIndex)
public float	getAscent()
public int	getCharOffset(int glyphIndex) Implements com.sun.javafx.scene.text.GlyphList.getCharOffset. Maps the given glyph index to the char offset.
public float	getDescent()
public int	getEnd()
public int	getGlyphAtX(float x, int[] trailing)
public int	getGlyphCode(int glyphIndex) Implements com.sun.javafx.scene.text.GlyphList.getGlyphCode. Returns the glyph code for the given glyphIndex.
public int	getGlyphCount() Implements com.sun.javafx.scene.text.GlyphList.getGlyphCount. Returns the number of glyphs in GlyphList.
public int	getGlyphIndex(int charOffset)
public float	getHeight() Implements com.sun.javafx.scene.text.GlyphList.getHeight. Returns the height of the GlyphList
public float	getLeading()
public int	getLength()
public byte	getLevel()
public RectBounds	getLineBounds() Implements com.sun.javafx.scene.text.GlyphList.getLineBounds. See TextLine#getBounds() (used outside text layout in rendering and span bounds)
public Point2D	getLocation() Implements com.sun.javafx.scene.text.GlyphList.getLocation. The top-left location of the GlyphList relative to the origin of the Text Layout.
public int	getOffsetAtX(float x, int[] trailing)
public float	getPosX(int glyphIndex) Implements com.sun.javafx.scene.text.GlyphList.getPosX. The x position for the given glyphIndex relative the GlyphList.
public float	getPosY(int glyphIndex) Implements com.sun.javafx.scene.text.GlyphList.getPosY. The y position for the given glyphIndex relative the GlyphList.
public int	getScript()
public int	getSlot()
public int	getStart()
public TextSpan	getTextSpan() Implements com.sun.javafx.scene.text.GlyphList.getTextSpan. Used during layout children (for rich text) can be null (for non-rich text) but never null for rich text.
public float	getWidth() Implements com.sun.javafx.scene.text.GlyphList.getWidth. Returns the width of the GlyphList
public int	getWrapIndex(float width)
public float	getXAtOffset(int offset, boolean leading)
public boolean	isBreak()
public boolean	isCanonical()
public boolean	isComplex() Implements com.sun.javafx.scene.text.GlyphList.isComplex. Means that this GlyphList was shaped using complex processing (ICU), either because it is complex script or because font features were requested.
public boolean	isEmbedded()
public boolean	isLeftBearing()
public boolean	isLeftToRight()
public boolean	isLinebreak()
public boolean	isNoLinkAfter()
public boolean	isNoLinkBefore()
public boolean	isRightBearing()
public boolean	isSoftbreak()
public boolean	isSplit()
public boolean	isSplitLast()
public boolean	isTab()
public void	justify(int offset, float width)
public void	merge(TextRun run)
private void	reset()
public void	setComplex(boolean complex)
public void	setEmbedded(RectBounds bounds, int length)
public void	setLeftBearing()
public void	setLine(TextLine line)
public void	setLinebreak()
public void	setLocation(float x, float y)
public void	setMetrics(float ascent, float descent, float leading)
public void	setRightBearing()
public void	setSoftbreak()
public void	setTab()
public void	setWidth(float width)
public void	shape(int count, int[] glyphs, float[] pos, int[] indices)
public void	shape(int count, int[] glyphs, float[] pos)
public TextRun	split(int offset)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public TextRun	unwrap()

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

Field Detail

ascent	back to summary
private float ascent

cacheIndex	back to summary
pack-priv int cacheIndex

cacheWidth	back to summary
pack-priv float cacheWidth

charIndices	back to summary
pack-priv int[] charIndices

descent	back to summary
private float descent

flags	back to summary
pack-priv int flags

FLAGS_CANONICAL	back to summary
pack-priv static final int FLAGS_CANONICAL

FLAGS_COMPACT	back to summary
pack-priv static final int FLAGS_COMPACT

FLAGS_COMPLEX	back to summary
pack-priv static final int FLAGS_COMPLEX

FLAGS_EMBEDDED	back to summary
pack-priv static final int FLAGS_EMBEDDED

FLAGS_LEFT_BEARING	back to summary
pack-priv static final int FLAGS_LEFT_BEARING

FLAGS_LINEBREAK	back to summary
pack-priv static final int FLAGS_LINEBREAK

FLAGS_NO_LINK_AFTER	back to summary
pack-priv static final int FLAGS_NO_LINK_AFTER

FLAGS_NO_LINK_BEFORE	back to summary
pack-priv static final int FLAGS_NO_LINK_BEFORE

FLAGS_RIGHT_BEARING	back to summary
pack-priv static final int FLAGS_RIGHT_BEARING

FLAGS_SOFTBREAK	back to summary
pack-priv static final int FLAGS_SOFTBREAK

FLAGS_SPLIT	back to summary
pack-priv static final int FLAGS_SPLIT

FLAGS_SPLIT_LAST	back to summary
pack-priv static final int FLAGS_SPLIT_LAST

FLAGS_TAB	back to summary
pack-priv static final int FLAGS_TAB

gids	back to summary
pack-priv int[] gids

glyphCount	back to summary
pack-priv int glyphCount

leading	back to summary
private float leading

length	back to summary
pack-priv int length

level	back to summary
pack-priv byte level

line	back to summary
pack-priv TextLine line

location	back to summary
pack-priv Point2D location

positions	back to summary
pack-priv float[] positions

script	back to summary
pack-priv int script

slot	back to summary
pack-priv int slot

span	back to summary
pack-priv TextSpan span

start	back to summary
pack-priv int start

width	back to summary
pack-priv float width

Constructor Detail

TextRun	back to summary
public TextRun(int start, int length, byte level, boolean complex, int script, TextSpan span, int slot, boolean canonical)

Method Detail

getAdvance	back to summary
public float getAdvance(int glyphIndex)

getAscent	back to summary
public float getAscent()

getCharOffset	back to summary
public int getCharOffset(int glyphIndex) Implements com.sun.javafx.scene.text.GlyphList.getCharOffset. Doc from com.sun.javafx.scene.text.GlyphList.getCharOffset. Maps the given glyph index to the char offset. (used during rendering (selection)) Annotations @Override

getCharOffset

back to summary

public int getCharOffset(int glyphIndex)

Implements com.sun.javafx.scene.text.GlyphList.getCharOffset.

Doc from com.sun.javafx.scene.text.GlyphList.getCharOffset.

Maps the given glyph index to the char offset. (used during rendering (selection))

Annotations

@Override

getDescent	back to summary
public float getDescent()

getEnd	back to summary
public int getEnd()

getGlyphAtX	back to summary
public int getGlyphAtX(float x, int[] trailing)

getGlyphCode	back to summary
public int getGlyphCode(int glyphIndex) Implements com.sun.javafx.scene.text.GlyphList.getGlyphCode. Doc from com.sun.javafx.scene.text.GlyphList.getGlyphCode. Returns the glyph code for the given glyphIndex. Annotations @Override

getGlyphCode

back to summary

public int getGlyphCode(int glyphIndex)

Implements com.sun.javafx.scene.text.GlyphList.getGlyphCode.

Doc from com.sun.javafx.scene.text.GlyphList.getGlyphCode.

Returns the glyph code for the given glyphIndex.

Annotations

@Override

getGlyphCount	back to summary
public int getGlyphCount() Implements com.sun.javafx.scene.text.GlyphList.getGlyphCount. Doc from com.sun.javafx.scene.text.GlyphList.getGlyphCount. Returns the number of glyphs in GlyphList. Annotations @Override

getGlyphCount

back to summary

public int getGlyphCount()

Implements com.sun.javafx.scene.text.GlyphList.getGlyphCount.

Doc from com.sun.javafx.scene.text.GlyphList.getGlyphCount.

Returns the number of glyphs in GlyphList.

Annotations

@Override

getGlyphIndex	back to summary
public int getGlyphIndex(int charOffset)

getHeight	back to summary
public float getHeight() Implements com.sun.javafx.scene.text.GlyphList.getHeight. Doc from com.sun.javafx.scene.text.GlyphList.getHeight. Returns the height of the GlyphList Annotations @Override

getHeight

back to summary

public float getHeight()

Implements com.sun.javafx.scene.text.GlyphList.getHeight.

Doc from com.sun.javafx.scene.text.GlyphList.getHeight.

Returns the height of the GlyphList

Annotations

@Override

getLeading	back to summary
public float getLeading()

getLength	back to summary
public int getLength()

getLevel	back to summary
public byte getLevel()

getLineBounds	back to summary
public RectBounds getLineBounds() Implements com.sun.javafx.scene.text.GlyphList.getLineBounds. Doc from com.sun.javafx.scene.text.GlyphList.getLineBounds. See TextLine#getBounds() (used outside text layout in rendering and span bounds) Annotations @Override

getLineBounds

back to summary

public RectBounds getLineBounds()

Implements com.sun.javafx.scene.text.GlyphList.getLineBounds.

Doc from com.sun.javafx.scene.text.GlyphList.getLineBounds.

See TextLine#getBounds() (used outside text layout in rendering and span bounds)

Annotations

@Override

getLocation

back to summary

public Point2D getLocation()

Implements com.sun.javafx.scene.text.GlyphList.getLocation.

Doc from com.sun.javafx.scene.text.GlyphList.getLocation.

The top-left location of the GlyphList relative to the origin of the Text Layout.

Annotations

@Override

getOffsetAtX	back to summary
public int getOffsetAtX(float x, int[] trailing)

getPosX

back to summary

public float getPosX(int glyphIndex)

Implements com.sun.javafx.scene.text.GlyphList.getPosX.

Doc from com.sun.javafx.scene.text.GlyphList.getPosX.

The x position for the given glyphIndex relative the GlyphList.

Annotations

@Override

getPosY

back to summary

public float getPosY(int glyphIndex)

Implements com.sun.javafx.scene.text.GlyphList.getPosY.

Doc from com.sun.javafx.scene.text.GlyphList.getPosY.

The y position for the given glyphIndex relative the GlyphList.

Annotations

@Override

getScript	back to summary
public int getScript()

getSlot	back to summary
public int getSlot()

getStart	back to summary
public int getStart()

getTextSpan

back to summary

public TextSpan getTextSpan()

Implements com.sun.javafx.scene.text.GlyphList.getTextSpan.

Doc from com.sun.javafx.scene.text.GlyphList.getTextSpan.

Used during layout children (for rich text) can be null (for non-rich text) but never null for rich text.

Annotations

@Override

getWidth

back to summary

public float getWidth()

Implements com.sun.javafx.scene.text.GlyphList.getWidth.

Doc from com.sun.javafx.scene.text.GlyphList.getWidth.

Returns the width of the GlyphList

Annotations

@Override

getWrapIndex	back to summary
public int getWrapIndex(float width)

getXAtOffset	back to summary
public float getXAtOffset(int offset, boolean leading)

isBreak	back to summary
public boolean isBreak()

isCanonical	back to summary
public boolean isCanonical()

isComplex

back to summary

public boolean isComplex()

Implements com.sun.javafx.scene.text.GlyphList.isComplex.

Doc from com.sun.javafx.scene.text.GlyphList.isComplex.

Means that this GlyphList was shaped using complex processing (ICU), either because it is complex script or because font features were requested. (used outside text layout in rendering)

Annotations

@Override

isEmbedded	back to summary
public boolean isEmbedded()

isLeftBearing	back to summary
public boolean isLeftBearing()

isLeftToRight	back to summary
public boolean isLeftToRight()

isLinebreak	back to summary
public boolean isLinebreak()

isNoLinkAfter	back to summary
public boolean isNoLinkAfter()

isNoLinkBefore	back to summary
public boolean isNoLinkBefore()

isRightBearing	back to summary
public boolean isRightBearing()

isSoftbreak	back to summary
public boolean isSoftbreak()

isSplit	back to summary
public boolean isSplit()

isSplitLast	back to summary
public boolean isSplitLast()

isTab	back to summary
public boolean isTab()

justify	back to summary
public void justify(int offset, float width)

merge	back to summary
public void merge(TextRun run)

reset	back to summary
private void reset()

setComplex	back to summary
public void setComplex(boolean complex)

setEmbedded	back to summary
public void setEmbedded(RectBounds bounds, int length)

setLeftBearing	back to summary
public void setLeftBearing()

setLine	back to summary
public void setLine(TextLine line)

setLinebreak	back to summary
public void setLinebreak()

setLocation	back to summary
public void setLocation(float x, float y)

setMetrics	back to summary
public void setMetrics(float ascent, float descent, float leading)

setRightBearing	back to summary
public void setRightBearing()

setSoftbreak	back to summary
public void setSoftbreak()

setTab	back to summary
public void setTab()

setWidth	back to summary
public void setWidth(float width)

shape	back to summary
public void shape(int count, int[] glyphs, float[] pos, int[] indices)

shape	back to summary
public void shape(int count, int[] glyphs, float[] pos)

split	back to summary
public TextRun split(int offset)

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.

Returns:String

a string representation of the object

Annotations

@Override

unwrap	back to summary
public TextRun unwrap()

public Class TextRun

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail