Modifier and Type	Class and Description
public static interface	TextLayout.CaretGeometry Encodes the caret geometry, which can be either a single vertical line, or two vertical lines (a "split" caret), represented by `Single` and `Split` classes respectively.
public static interface	TextLayout.GeometryCallback Callback to be called for each rectangular shape
public static class	TextLayout.Hit

Field Summary

Modifier and Type	Field and Description
public static final int	ALIGN_CENTER
public static final int	ALIGN_JUSTIFY
public static final int	ALIGN_LEFT
public static final int	ALIGN_MASK
public static final int	ALIGN_RIGHT
public static final int	ANALYSIS_MASK
public static final int	BOUNDS_CENTER
public static final int	BOUNDS_MASK
public static final int	DEFAULT_TAB_SIZE
public static final int	DIRECTION_DEFAULT_LTR
public static final int	DIRECTION_DEFAULT_RTL
public static final int	DIRECTION_LTR
public static final int	DIRECTION_MASK
public static final int	DIRECTION_RTL
public static final int	FLAGS_ANALYSIS_VALID
public static final int	FLAGS_CACHED_STRIKETHROUGH
public static final int	FLAGS_CACHED_UNDERLINE
public static final int	FLAGS_HAS_BIDI
public static final int	FLAGS_HAS_CJK
public static final int	FLAGS_HAS_COMPLEX
public static final int	FLAGS_HAS_EMBEDDED
public static final int	FLAGS_HAS_TABS
public static final int	FLAGS_LAST
public static final int	FLAGS_LINES_VALID
public static final int	FLAGS_RTL_BASE
public static final int	FLAGS_WRAPPED
public static final int	TYPE_BASELINE
public static final int	TYPE_BEARINGS
public static final int	TYPE_STRIKETHROUGH
public static final int	TYPE_TEXT
public static final int	TYPE_TOP
public static final int	TYPE_UNDERLINE

Method Summary

Modifier and Type	Method and Description
public BaseBounds	Returns: the layout bounds 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)
public TextLayout.CaretGeometry	Returns: the caret geometry getCaretGeometry(int the character offset offset, boolean whether the caret is biased on the leading edge of the character leading) Queries the caret geometry and associated information at the specified text position.
public TextLayout.Hit	Returns: returns a `Hit` object containing character index, insertion index and position of cursor on the character. getHitInfo(float x coordinate value. x, float y coordinate value. y) Calculates character index and insertion index for the given coordinates and maps to `Hit` class.
public TextLine[]	Returns: the text lines getLines() Returns the lines of text layout.
public void	getRange(int the start offset start, int the end offset end, int the type of the geometry type, TextLayout.GeometryCallback the callback to invoke for each rectangular shape client) 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[]	Returns: the runs getRuns() Returns the GlyphList of text layout.
public Shape	Returns: the shape getShape(int the type of the shapes to include type, TextSpan filter) Returns the shape of the entire text layout relative to the baseline of the first line.
public BaseBounds	Returns: the visual bounds getVisualBounds(int type) Returns the visual bounds of the layout using glyph bounding box
public boolean	Returns: returns true is the call modifies the layout internal state. setAlignment(int alignment) Sets the alignment for the TextLayout.
public boolean	Returns: returns true is the call modifies the layout internal state. setBoundsType(int type) Sets the bounds type for the TextLayout.
public boolean	Returns: returns true is the call modifies the layout internal state. setContent(TextSpan[] spans) Sets the content for the TextLayout.
public boolean	Returns: returns true is the call modifies the layout internal state. setContent(String string, Object font) Sets the content for the TextLayout.
public boolean	Returns: returns true is the call modifies the layout internal state. setDirection(int direction) Sets the direction (bidi algorithm's) for the TextLayout.
public boolean	Returns: returns true is the call modifies the layout internal state. setLineSpacing(float spacing) Sets the line spacing for the TextLayout.
public boolean	Returns: returns true if the call modifies the layout internal state setTabAdvancePolicy(int the tab size tabSize, TabAdvancePolicy the tab advance policy, or null policy) Sets the tab size and the tab advance policy for the TextLayout.
public boolean	Returns: returns true is the call modifies the layout internal state. setWrapWidth(float wrapWidth) Sets the wrap width for the TextLayout.

Field Detail

ALIGN_CENTER	back to summary
public static final int ALIGN_CENTER

ALIGN_JUSTIFY	back to summary
public static final int ALIGN_JUSTIFY

ALIGN_LEFT	back to summary
public static final int ALIGN_LEFT

ALIGN_MASK	back to summary
public static final int ALIGN_MASK

ALIGN_RIGHT	back to summary
public static final int ALIGN_RIGHT

ANALYSIS_MASK	back to summary
public static final int ANALYSIS_MASK

BOUNDS_CENTER	back to summary
public static final int BOUNDS_CENTER

BOUNDS_MASK	back to summary
public static final int BOUNDS_MASK

DEFAULT_TAB_SIZE	back to summary
public static final int DEFAULT_TAB_SIZE

DIRECTION_DEFAULT_LTR	back to summary
public static final int DIRECTION_DEFAULT_LTR

DIRECTION_DEFAULT_RTL	back to summary
public static final int DIRECTION_DEFAULT_RTL

DIRECTION_LTR	back to summary
public static final int DIRECTION_LTR

DIRECTION_MASK	back to summary
public static final int DIRECTION_MASK

DIRECTION_RTL	back to summary
public static final int DIRECTION_RTL

FLAGS_ANALYSIS_VALID	back to summary
public static final int FLAGS_ANALYSIS_VALID

FLAGS_CACHED_STRIKETHROUGH	back to summary
public static final int FLAGS_CACHED_STRIKETHROUGH

FLAGS_CACHED_UNDERLINE	back to summary
public static final int FLAGS_CACHED_UNDERLINE

FLAGS_HAS_BIDI	back to summary
public static final int FLAGS_HAS_BIDI

FLAGS_HAS_CJK	back to summary
public static final int FLAGS_HAS_CJK

FLAGS_HAS_COMPLEX	back to summary
public static final int FLAGS_HAS_COMPLEX

FLAGS_HAS_EMBEDDED	back to summary
public static final int FLAGS_HAS_EMBEDDED

FLAGS_HAS_TABS	back to summary
public static final int FLAGS_HAS_TABS

FLAGS_LAST	back to summary
public static final int FLAGS_LAST

FLAGS_LINES_VALID	back to summary
public static final int FLAGS_LINES_VALID

FLAGS_RTL_BASE	back to summary
public static final int FLAGS_RTL_BASE

FLAGS_WRAPPED	back to summary
public static final int FLAGS_WRAPPED

TYPE_BASELINE	back to summary
public static final int TYPE_BASELINE

TYPE_BEARINGS	back to summary
public static final int TYPE_BEARINGS

TYPE_STRIKETHROUGH	back to summary
public static final int TYPE_STRIKETHROUGH

TYPE_TEXT	back to summary
public static final int TYPE_TEXT

TYPE_TOP	back to summary
public static final int TYPE_TOP

TYPE_UNDERLINE	back to summary
public static final int TYPE_UNDERLINE

Method Detail

getBounds	back to summary
public BaseBounds 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

getBounds

back to summary

public BaseBounds 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

getBounds	back to summary
public BaseBounds getBounds(TextSpan filter, BaseBounds bounds)

getCaretGeometry	back to summary
public TextLayout.CaretGeometry getCaretGeometry(int offset, boolean leading) Queries the caret geometry and associated information at the specified text position. Parameters offset:int the character offset leading:boolean whether the caret is biased on the leading edge of the character Returns:TextLayout.CaretGeometry the caret geometry

getCaretGeometry

back to summary

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

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

Parameters

offset:int: the character offset
leading:boolean: whether the caret is biased on the leading edge of the character

Returns:TextLayout.CaretGeometry

the caret geometry

getHitInfo back to summary

getHitInfo	back to summary
public TextLayout.Hit getHitInfo(float x, float y) 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.

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

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.

getLines	back to summary
public TextLine[] getLines() Returns the lines of text layout. Returns:TextLine[] the text lines

getLines

back to summary

public TextLine[] getLines()

Returns the lines of text layout.

Returns:TextLine[]: the text lines

getRange back to summary

getRange	back to summary
public void getRange(int start, int end, int type, TextLayout.GeometryCallback client) 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 Parameters start:int the start offset end:int the end offset type:int the type of the geometry client:TextLayout.GeometryCallback the callback to invoke for each rectangular shape

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

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

Parameters

start:int: the start offset
end:int: the end offset
type:int: the type of the geometry
client:TextLayout.GeometryCallback: the callback to invoke for each rectangular shape

getRuns	back to summary
public GlyphList[] getRuns() Returns the GlyphList of text layout. The runs are returned order visually (rendering order), starting from the first line. Returns:GlyphList[] the runs

getRuns

back to summary

public GlyphList[] getRuns()

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

Returns:GlyphList[]: the runs

getShape	back to summary
public Shape getShape(int type, TextSpan filter) 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

getShape

back to summary

public Shape getShape(int type, TextSpan filter)

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

getVisualBounds	back to summary
public BaseBounds getVisualBounds(int type) Returns the visual bounds of the layout using glyph bounding box Returns:BaseBounds the visual bounds

getVisualBounds

back to summary

public BaseBounds getVisualBounds(int type)

Returns the visual bounds of the layout using glyph bounding box

Returns:BaseBounds: the visual bounds

setAlignment	back to summary
public boolean setAlignment(int alignment) Sets the alignment for the TextLayout. Returns:boolean returns true is the call modifies the layout internal state.

setAlignment

back to summary

public boolean setAlignment(int alignment)

Sets the alignment for the TextLayout.

Returns:boolean: returns true is the call modifies the layout internal state.

setBoundsType	back to summary
public boolean setBoundsType(int type) Sets the bounds type for the TextLayout. Returns:boolean returns true is the call modifies the layout internal state.

setBoundsType

back to summary

public boolean setBoundsType(int type)

Sets the bounds type for the TextLayout.

Returns:boolean: returns true is the call modifies the layout internal state.

setContent	back to summary
public boolean setContent(TextSpan[] spans) Sets the content for the TextLayout. Supports multiple spans (rich text). Returns:boolean returns true is the call modifies the layout internal state.

setContent

back to summary

public boolean setContent(TextSpan[] spans)

Sets the content for the TextLayout. Supports multiple spans (rich text).

Returns:boolean: returns true is the call modifies the layout internal state.

setContent	back to summary
public boolean setContent(String string, Object font) 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.

setContent

back to summary

public boolean setContent(String string, Object font)

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.

setDirection	back to summary
public boolean setDirection(int direction) Sets the direction (bidi algorithm's) for the TextLayout. Returns:boolean returns true is the call modifies the layout internal state.

setDirection

back to summary

public boolean setDirection(int direction)

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

Returns:boolean: returns true is the call modifies the layout internal state.

setLineSpacing	back to summary
public boolean setLineSpacing(float spacing) Sets the line spacing for the TextLayout. Returns:boolean returns true is the call modifies the layout internal state.

setLineSpacing

back to summary

public boolean setLineSpacing(float spacing)

Sets the line spacing for the TextLayout.

Returns:boolean: returns true is the call modifies the layout internal state.

setTabAdvancePolicy back to summary

public boolean setTabAdvancePolicy(int tabSize, TabAdvancePolicy policy)

Sets the tab size and the tab advance policy for the TextLayout. A non-null policy will override the fixed tab size.

Parameters

tabSize:int: the tab size
policy:TabAdvancePolicy: the tab advance policy, or null

Returns:boolean

returns true if the call modifies the layout internal state

setWrapWidth

back to summary

public boolean setWrapWidth(float wrapWidth)

Sets the wrap width for the TextLayout.

Returns:boolean: returns true is the call modifies the layout internal state.

com.sun.javafx.scene.text back to summary

public sealed Interface TextLayout.CaretGeometry

Known Direct Implementers: com.sun.javafx.scene.text.TextLayout.CaretGeometry.Single, com.sun.javafx.scene.text.TextLayout.CaretGeometry.Split

Encodes the caret geometry, which can be either a single vertical line, or two vertical lines (a "split" caret), represented by Single and Split classes respectively.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static record	TextLayout.CaretGeometry.Single Represents a single line from (x, y) to (x, y + height)
public static record	TextLayout.CaretGeometry.Split Represents a split caret drawn as two lines, the first line from (x1, y) to (x1, y + height/2), the second line from (x2, y + height/2) to (x2, y + height).

com.sun.javafx.scene.text back to summary

public final Record TextLayout.CaretGeometry.Single

Class Inheritance

extends Record
implements CaretGeometry

java.lang.Object
java.lang.Record
com.sun.javafx.scene.text.TextLayout.CaretGeometry.Single

All Implemented Interfaces

com.sun.javafx.scene.text.TextLayout.CaretGeometry

Record Components

x:float
y:float
height:float

Represents a single line from (x, y) to (x, y + height)

Field Summary

Modifier and Type	Field and Description
private final float	height Record Component accessed by height().
private final float	x Record Component accessed by x().
private final float	y Record Component accessed by y().

Constructor Summary

Access	Constructor and Description
public	Single(float x, float y, float height)

Method Summary

Modifier and Type	Method and Description
public final boolean	equals(Object o) Implements abstract java.lang.Record.equals. Indicates whether some other object is "equal to" this one.
public final int	hashCode() Implements abstract java.lang.Record.hashCode. Returns a hash code value for the record.
public float	height() Record Component getter of height.
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.
public float	x() Record Component getter of x.
public float	y() Record Component getter of y.

Field Detail

height	back to summary
private final float height Record Component accessed by height().

x	back to summary
private final float x Record Component accessed by x().

y	back to summary
private final float y Record Component accessed by y().

Constructor Detail

Single	back to summary
public Single(float x, float y, float height)

Method Detail

equals back to summary

public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

Indicates whether some other object is "equal to" this one. In addition to the general contract of Object.equals, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows:

    R copy = new R(r.c1(), r.c2(), ..., r.cn());

then it must be the case that r.equals(copy).

hashCode back to summary

public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

Returns a hash code value for the record. Obeys the general contract of Object.hashCode. For records, hashing behavior is constrained by the refined contract of Record.equals, so that any two records created from the same components must have the same hash code.

height	back to summary
public float height() Record Component getter of height.

toString back to summary

public final String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

Returns a string representation of the record. In accordance with the general contract of Object#toString(), the toString method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read.

In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

x	back to summary
public float x() Record Component getter of x.

y	back to summary
public float y() Record Component getter of y.

com.sun.javafx.scene.text back to summary

public final Record TextLayout.CaretGeometry.Split

Class Inheritance

extends Record
implements CaretGeometry

java.lang.Object
java.lang.Record
com.sun.javafx.scene.text.TextLayout.CaretGeometry.Split

All Implemented Interfaces

com.sun.javafx.scene.text.TextLayout.CaretGeometry

Record Components

x1:float
x2:float
y:float
height:float

Represents a split caret drawn as two lines, the first line from (x1, y) to (x1, y + height/2), the second line from (x2, y + height/2) to (x2, y + height).

Field Summary

Modifier and Type	Field and Description
private final float	height Record Component accessed by height().
private final float	x1 Record Component accessed by x1().
private final float	x2 Record Component accessed by x2().
private final float	y Record Component accessed by y().

Constructor Summary

Access	Constructor and Description
public	Split(float x1, float x2, float y, float height)

Method Summary

Modifier and Type	Method and Description
public final boolean	equals(Object o) Implements abstract java.lang.Record.equals. Indicates whether some other object is "equal to" this one.
public final int	hashCode() Implements abstract java.lang.Record.hashCode. Returns a hash code value for the record.
public float	height() Record Component getter of height.
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.
public float	x1() Record Component getter of x1.
public float	x2() Record Component getter of x2.
public float	y() Record Component getter of y.

Field Detail

height	back to summary
private final float height Record Component accessed by height().

x1	back to summary
private final float x1 Record Component accessed by x1().

x2	back to summary
private final float x2 Record Component accessed by x2().

y	back to summary
private final float y Record Component accessed by y().

Constructor Detail

Split	back to summary
public Split(float x1, float x2, float y, float height)

Method Detail

equals back to summary

public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

    R copy = new R(r.c1(), r.c2(), ..., r.cn());

then it must be the case that r.equals(copy).

hashCode back to summary

public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

height	back to summary
public float height() Record Component getter of height.

toString back to summary

public final String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

x1	back to summary
public float x1() Record Component getter of x1.

x2	back to summary
public float x2() Record Component getter of x2.

y	back to summary
public float y() Record Component getter of y.

com.sun.javafx.scene.text back to summary

public Interface TextLayout.GeometryCallback

Annotations

@FunctionalInterface

Callback to be called for each rectangular shape

Method Summary

Modifier and Type	Method and Description
public void	addRectangle(float left, float top, float right, float bottom)

Method Detail

addRectangle	back to summary
public void addRectangle(float left, float top, float right, float bottom)

com.sun.javafx.scene.text back to summary

public Class TextLayout.Hit

Class Inheritance

extends Object

java.lang.Object
com.sun.javafx.scene.text.TextLayout.Hit

Field Summary

Modifier and Type	Field and Description
pack-priv int	charIndex
pack-priv int	insertionIndex
pack-priv boolean	leading

Constructor Summary

Access	Constructor and Description
public	Hit(int charIndex, int insertionIndex, boolean leading)

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public int	getCharIndex()
public int	getInsertionIndex()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public boolean	isLeading()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

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

Field Detail

charIndex	back to summary
pack-priv int charIndex

insertionIndex	back to summary
pack-priv int insertionIndex

leading	back to summary
pack-priv boolean leading

Constructor Detail

Hit	back to summary
public Hit(int charIndex, int insertionIndex, boolean leading)

Method Detail

equals back to summary

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Annotations

@Override

getCharIndex	back to summary
public int getCharIndex()

getInsertionIndex	back to summary
public int getInsertionIndex()

hashCode back to summary

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Annotations

@Override

isLeading	back to summary
public boolean isLeading()

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.

Annotations

@Override