Record Class GuiTextMetrics

java.lang.Object

java.lang.Record

com.render.api.gui.GuiTextMetrics

Record Components:

width - logical layout width

height - logical layout height

ascent - maximum line ascent

descent - maximum line descent

leading - maximum line leading

inkBounds - aggregate logical ink bounds

lines - immutable per-line metrics

truncated - whether height, max-lines, or ellipsis truncated the source

public record GuiTextMetrics(float width, float height, float ascent, float descent, float leading, GuiRect inkBounds, List<GuiTextMetrics.Line> lines, boolean truncated)
extends Record

Immutable aggregate and per-line geometry for a shaped text layout.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	GuiTextMetrics.Line	One laid-out line.

Constructor Summary

Constructors

Constructor	Description
GuiTextMetrics(float width, float height, float ascent, float descent, float leading, GuiRect inkBounds, List<GuiTextMetrics.Line> lines, boolean truncated)	Creates an instance of a GuiTextMetrics record class.

Method Summary

Modifier and Type	Method	Description
float	ascent()	Returns the value of the ascent record component.
float	descent()	Returns the value of the descent record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
float	height()	Returns the value of the height record component.
GuiRect	inkBounds()	Returns the value of the inkBounds record component.
float	leading()	Returns the value of the leading record component.
int	lineCount()
List<GuiTextMetrics.Line>	lines()	Returns the value of the lines record component.
final String	toString()	Returns a string representation of this record class.
boolean	truncated()	Returns the value of the truncated record component.
float	width()	Returns the value of the width record component.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

GuiTextMetrics

public GuiTextMetrics(float width,
 float height,
 float ascent,
 float descent,
 float leading,
 GuiRect inkBounds,
 List<GuiTextMetrics.Line> lines,
 boolean truncated)

Creates an instance of a GuiTextMetrics record class.

Parameters:

width - the value for the width record component

height - the value for the height record component

ascent - the value for the ascent record component

descent - the value for the descent record component

leading - the value for the leading record component

inkBounds - the value for the inkBounds record component

lines - the value for the lines record component

truncated - the value for the truncated record component

Method Details

lineCount

public int lineCount()

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

width

public float width()

Returns the value of the width record component.

Returns:

the value of the width record component

height

public float height()

Returns the value of the height record component.

Returns:

the value of the height record component

ascent

public float ascent()

Returns the value of the ascent record component.

Returns:

the value of the ascent record component

descent

public float descent()

Returns the value of the descent record component.

Returns:

the value of the descent record component

leading

public float leading()

Returns the value of the leading record component.

Returns:

the value of the leading record component

inkBounds

public GuiRect inkBounds()

Returns the value of the inkBounds record component.

Returns:

the value of the inkBounds record component

lines

public List<GuiTextMetrics.Line> lines()

Returns the value of the lines record component.

Returns:

the value of the lines record component

truncated

public boolean truncated()

Returns the value of the truncated record component.

Returns:

the value of the truncated record component