Record Class GuiGridPlacement

java.lang.Object

java.lang.Record

com.render.api.gui.layout.GuiGridPlacement

Record Components:

rowStart - row start or zero

columnStart - column start or zero

rowSpan - positive row span

columnSpan - positive column span

area - named area, or empty

rowLine - named row line, or empty

columnLine - named column line, or empty

public record GuiGridPlacement(int rowStart, int columnStart, int rowSpan, int columnSpan, String area, String rowLine, String columnLine)
extends Record

Grid item placement. Numeric positions are one-based; zero means automatic.

Field Summary

Fields

Modifier and Type	Field	Description
static final GuiGridPlacement	AUTO

Constructor Summary

Constructors

Constructor	Description
GuiGridPlacement(int rowStart, int columnStart, int rowSpan, int columnSpan, String area, String rowLine, String columnLine)	Creates an instance of a GuiGridPlacement record class.

Method Summary

Modifier and Type	Method	Description
String	area()	Returns the value of the area record component.
static GuiGridPlacement	area(String name)
static GuiGridPlacement	cell(int row, int column)
String	columnLine()	Returns the value of the columnLine record component.
int	columnSpan()	Returns the value of the columnSpan record component.
int	columnStart()	Returns the value of the columnStart 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.
static GuiGridPlacement	namedLines(String rowLine, String columnLine)
String	rowLine()	Returns the value of the rowLine record component.
int	rowSpan()	Returns the value of the rowSpan record component.
int	rowStart()	Returns the value of the rowStart record component.
static GuiGridPlacement	span(int row, int column, int rowSpan, int columnSpan)
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Field Details

AUTO

public static final GuiGridPlacement AUTO

Constructor Details

GuiGridPlacement

public GuiGridPlacement(int rowStart,
 int columnStart,
 int rowSpan,
 int columnSpan,
 String area,
 String rowLine,
 String columnLine)

Creates an instance of a GuiGridPlacement record class.

Parameters:

rowStart - the value for the rowStart record component

columnStart - the value for the columnStart record component

rowSpan - the value for the rowSpan record component

columnSpan - the value for the columnSpan record component

area - the value for the area record component

rowLine - the value for the rowLine record component

columnLine - the value for the columnLine record component

Method Details

cell

public static GuiGridPlacement cell(int row,
 int column)

span

public static GuiGridPlacement span(int row,
 int column,
 int rowSpan,
 int columnSpan)

area

public static GuiGridPlacement area(String name)

namedLines

public static GuiGridPlacement namedLines(String rowLine,
 String columnLine)

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.

rowStart

public int rowStart()

Returns the value of the rowStart record component.

Returns:

the value of the rowStart record component

columnStart

public int columnStart()

Returns the value of the columnStart record component.

Returns:

the value of the columnStart record component

rowSpan

public int rowSpan()

Returns the value of the rowSpan record component.

Returns:

the value of the rowSpan record component

columnSpan

public int columnSpan()

Returns the value of the columnSpan record component.

Returns:

the value of the columnSpan record component

area

public String area()

Returns the value of the area record component.

Returns:

the value of the area record component

rowLine

public String rowLine()

Returns the value of the rowLine record component.

Returns:

the value of the rowLine record component

columnLine

public String columnLine()

Returns the value of the columnLine record component.

Returns:

the value of the columnLine record component