com.sun.javafx.text

Class TextLine

java.lang.Object

com.sun.javafx.text.TextLine

All Implemented Interfaces:

TextLine

public class TextLine
extends java.lang.Object
implements TextLine

Field Summary

Fields

Modifier and Type	Field and Description
(package private) RectBounds	bounds
(package private) float	leading
(package private) int	length
(package private) float	lsb
(package private) float	rsb
(package private) TextRun[]	runs
(package private) int	start

Constructor Summary

Constructors

Constructor and Description
TextLine(int start, int length, TextRun[] runs, float width, float ascent, float descent, float leading)

Method Summary

Modifier and Type	Method and Description
RectBounds	getBounds() Returns metrics information about the line as follow: bounds().getWidth() - the width of the line.
float	getLeading()
float	getLeftSideBearing() Returns the left side bearing of the line (negative).
int	getLength() Returns the line length in character.
float	getRightSideBearing() Returns the right side bearing of the line (positive).
TextRun[]	getRuns() Returns the list of GlyphList in the line.
int	getStart() Returns the line start offset.
void	setAlignment(float x)
void	setSideBearings(float lsb, float rsb)
void	setWidth(float width)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

runs

TextRun[] runs

bounds

RectBounds bounds

lsb

float lsb

rsb

float rsb

leading

float leading

start

int start

length

int length

Constructor Detail

TextLine

public TextLine(int start,
                int length,
                TextRun[] runs,
                float width,
                float ascent,
                float descent,
                float leading)

Method Detail

getBounds

public RectBounds getBounds()

Description copied from interface: TextLine

Returns metrics information about the line as follow: bounds().getWidth() - the width of the line. The width for the line is sum of all run's width in the line, it is not affect by any wrapping width but it will include any changes caused by justification. bounds().getHeight() - the height of the line. The height of the line is sum of the max ascent, max descent, and max line gap of all the fonts in the line. bounds.().getMinY() - the ascent of the line (negative). The ascent of the line is the max ascent of all fonts in the line. bounds().getMinX() - the x origin of the line (relative to the layout). The x origin is defined by TextAlignment of the text layout, always zero for left-aligned text.

Specified by:

getBounds in interface TextLine

getLeading

public float getLeading()

getRuns

public TextRun[] getRuns()

Description copied from interface: TextLine

Returns the list of GlyphList in the line. The list is visually orderded.

Specified by:

getRuns in interface TextLine

getStart

public int getStart()

Description copied from interface: TextLine

Returns the line start offset.

Specified by:

getStart in interface TextLine

getLength

public int getLength()

Description copied from interface: TextLine

Returns the line length in character.

Specified by:

getLength in interface TextLine

setSideBearings

public void setSideBearings(float lsb,
                            float rsb)

getLeftSideBearing

public float getLeftSideBearing()

Description copied from interface: TextLine

Returns the left side bearing of the line (negative).

Specified by:

getLeftSideBearing in interface TextLine

getRightSideBearing

public float getRightSideBearing()

Description copied from interface: TextLine

Returns the right side bearing of the line (positive).

Specified by:

getRightSideBearing in interface TextLine

setAlignment

public void setAlignment(float x)

setWidth

public void setWidth(float width)