Module technology.sola.engine

Package technology.sola.engine.graphics.gui.util

Record Class TextRenderDetails

java.lang.Object

java.lang.Record

technology.sola.engine.graphics.gui.util.TextRenderDetails

Record Components:

lineHeight - the line height

lines - the string of text in each line

dimensions - the dimensions of the text for rendering

@NullMarked
public record TextRenderDetails(int lineHeight, List<String> lines, GuiElementDimensions dimensions)
extends Record

TextRenderDetails contains the rendering information needed for text.

Constructor Summary

Constructors

Constructor	Description
TextRenderDetails(int lineHeight, List<String> lines, GuiElementDimensions dimensions)	Creates an instance of a TextRenderDetails record class.

Method Summary

Modifier and Type	Method	Description
GuiElementDimensions	dimensions()	Returns the value of the dimensions 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.
int	lineHeight()	Returns the value of the lineHeight record component.
List<String>	lines()	Returns the value of the lines record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

TextRenderDetails

public TextRenderDetails(int lineHeight,
 List<String> lines,
 GuiElementDimensions dimensions)

Creates an instance of a TextRenderDetails record class.

Parameters:

lineHeight - the value for the lineHeight record component

lines - the value for the lines record component

dimensions - the value for the dimensions record component

Method Details

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 '=='.

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.

lineHeight

public int lineHeight()

Returns the value of the lineHeight record component.

Returns:

the value of the lineHeight record component

lines

public List<String> lines()

Returns the value of the lines record component.

Returns:

the value of the lines record component

dimensions

public GuiElementDimensions dimensions()

Returns the value of the dimensions record component.

Returns:

the value of the dimensions record component