APIdia Launch Partner
Top Description Fields Constructors Methods
javafx.scene.text

public final Record TextLineInfo

extends Record
Class Inheritance
Record Components
start:int
the start offset for the line
end:int
the end offset for the line (index of the last character + 1)
bounds:Rectangle2D
the bounds of the text line, in local coordinates:
  • minX - 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.
  • minY - the ascent of the line (negative). The ascent of the line is the max ascent of all fonts in the line.
  • width - the width of the line. The width of the line is sum of all the run widths in the line, it is not affect by the wrapping width but it will include any changes caused by justification.
  • height - 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.
Imports
javafx.geometry.Rectangle2D
Provides the information about a text line in a text layout.
Since
25

Field Summary

Modifier and TypeField and Description
private final Rectangle2D
bounds

Record Component accessed by bounds().

the bounds of the text line, in local coordinates:
  • minX - 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.
  • minY - the ascent of the line (negative). The ascent of the line is the max ascent of all fonts in the line.
  • width - the width of the line. The width of the line is sum of all the run widths in the line, it is not affect by the wrapping width but it will include any changes caused by justification.
  • height - 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.
private final int
end

Record Component accessed by end().

the end offset for the line (index of the last character + 1)
private final int
start

Record Component accessed by start().

the start offset for the line

Constructor Summary

AccessConstructor and Description
public
TextLineInfo(int start, int end, Rectangle2D bounds)

Method Summary

Modifier and TypeMethod and Description
public Rectangle2D
bounds()

Record Component getter of bounds.

Record Component the bounds of the text line, in local coordinates:

  • minX - 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.
  • minY - the ascent of the line (negative). The ascent of the line is the max ascent of all fonts in the line.
  • width - the width of the line. The width of the line is sum of all the run widths in the line, it is not affect by the wrapping width but it will include any changes caused by justification.
  • height - 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.
public int
end()

Record Component getter of end.

Record Component the end offset for the line (index of the last character + 1)

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

Record Component getter of start.

Record Component the start offset for the line

public final String
toString()

Implements abstract java.lang.Record.toString.

Returns a string representation of the record.

Field Detail

boundsback to summary
private final Rectangle2D bounds

Record Component accessed by bounds().

the bounds of the text line, in local coordinates:

  • minX - 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.
  • minY - the ascent of the line (negative). The ascent of the line is the max ascent of all fonts in the line.
  • width - the width of the line. The width of the line is sum of all the run widths in the line, it is not affect by the wrapping width but it will include any changes caused by justification.
  • height - 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.
endback to summary
private final int end

Record Component accessed by end().

the end offset for the line (index of the last character + 1)

startback to summary
private final int start

Record Component accessed by start().

the start offset for the line

Constructor Detail

TextLineInfoback to summary
public TextLineInfo(int start, int end, Rectangle2D bounds)

Method Detail

boundsback to summary
public Rectangle2D bounds()

Record Component getter of bounds.

Record Component
the bounds of the text line, in local coordinates:
  • minX - 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.
  • minY - the ascent of the line (negative). The ascent of the line is the max ascent of all fonts in the line.
  • width - the width of the line. The width of the line is sum of all the run widths in the line, it is not affect by the wrapping width but it will include any changes caused by justification.
  • height - 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.
endback to summary
public int end()

Record Component getter of end.

Record Component
the end offset for the line (index of the last character + 1)
equalsback 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).
hashCodeback 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.

startback to summary
public int start()

Record Component getter of start.

Record Component
the start offset for the line
toStringback 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.