Record Class GuiPageTemplate

java.lang.Object

java.lang.Record

com.render.api.gui.pagination.GuiPageTemplate

Record Components:

name - stable template name

margins - page content margins

header - running header factory, or null

footer - running footer factory, or null

public record GuiPageTemplate(String name, GuiPageMargins margins, Function<GuiPageContext, net.minecraft.network.chat.Component> header, Function<GuiPageContext, net.minecraft.network.chat.Component> footer)
extends Record

Named on-screen page template with margins and running text factories.

Constructor Summary

Constructors

Constructor	Description
GuiPageTemplate(String name, GuiPageMargins margins, Function<GuiPageContext, net.minecraft.network.chat.Component> header, Function<GuiPageContext, net.minecraft.network.chat.Component> footer)	Creates an instance of a GuiPageTemplate record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
Function<GuiPageContext, net.minecraft.network.chat.Component>	footer()	Returns the value of the footer record component.
final int	hashCode()	Returns a hash code value for this object.
Function<GuiPageContext, net.minecraft.network.chat.Component>	header()	Returns the value of the header record component.
GuiPageMargins	margins()	Returns the value of the margins record component.
String	name()	Returns the value of the name record component.
static GuiPageTemplate	named(String name, GuiPageMargins margins)
final String	toString()	Returns a string representation of this record class.
GuiPageTemplate	withFooter(Function<GuiPageContext, net.minecraft.network.chat.Component> factory)
GuiPageTemplate	withHeader(Function<GuiPageContext, net.minecraft.network.chat.Component> factory)

Methods inherited from class Object

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

Constructor Details

GuiPageTemplate

public GuiPageTemplate(String name,
 GuiPageMargins margins,
 Function<GuiPageContext, net.minecraft.network.chat.Component> header,
 Function<GuiPageContext, net.minecraft.network.chat.Component> footer)

Creates an instance of a GuiPageTemplate record class.

Parameters:

name - the value for the name record component

margins - the value for the margins record component

header - the value for the header record component

footer - the value for the footer record component

Method Details

named

public static GuiPageTemplate named(String name,
 GuiPageMargins margins)

withHeader

public GuiPageTemplate withHeader(Function<GuiPageContext, net.minecraft.network.chat.Component> factory)

withFooter

public GuiPageTemplate withFooter(Function<GuiPageContext, net.minecraft.network.chat.Component> factory)

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. All components in this record class are compared with Objects::equals(Object,Object).

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.

name

public String name()

Returns the value of the name record component.

Returns:

the value of the name record component

margins

public GuiPageMargins margins()

Returns the value of the margins record component.

Returns:

the value of the margins record component

header

public Function<GuiPageContext, net.minecraft.network.chat.Component> header()

Returns the value of the header record component.

Returns:

the value of the header record component

footer

public Function<GuiPageContext, net.minecraft.network.chat.Component> footer()

Returns the value of the footer record component.

Returns:

the value of the footer record component