Package net.ixdarklord.folios.internal.client.page

Record Class SpotlightPageElement

java.lang.Object

java.lang.Record

net.ixdarklord.folios.internal.client.page.SpotlightPageElement

All Implemented Interfaces:

GuidePage

public record SpotlightPageElement(GuideStack item, Optional<String> title, String text, boolean link)
extends Record
implements GuidePage

Nested Class Summary

Nested classes/interfaces inherited from interface net.ixdarklord.folios.api.client.page.GuidePage

GuidePage.Laid, GuidePage.Part, GuidePage.SpreadHalf

Field Summary

Fields

Modifier and Type	Field	Description
static final com.mojang.serialization.MapCodec<SpotlightPageElement>	CODEC

Constructor Summary

Constructors

Constructor	Description
SpotlightPageElement(GuideStack item, Optional<String> title, String text, boolean link)	Creates an instance of a SpotlightPageElement record class.

Method Summary

Modifier and Type	Method	Description
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.
GuideStack	item()	Returns the value of the item record component.
List<GuideStack>	items()	The items this page is about: anywhere in the book, pressing one of them opens this page.
List<GuidePage.Laid>	lay(GuideLayout layout)	Sets the page out: one or more pages, each drawn on its own.
boolean	link()	Returns the value of the link record component.
String	searchText()	Words of the page a search should find it by.
String	text()	Returns the value of the text record component.
Optional<String>	title()	Returns the value of the title 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

Methods inherited from interface net.ixdarklord.folios.api.client.page.GuidePage

objectives, spread

Field Details

CODEC

public static final com.mojang.serialization.MapCodec<SpotlightPageElement> CODEC

Constructor Details

SpotlightPageElement

public SpotlightPageElement(GuideStack item,
 Optional<String> title,
 String text,
 boolean link)

Creates an instance of a SpotlightPageElement record class.

Parameters:

item - the value for the item record component

title - the value for the title record component

text - the value for the text record component

link - the value for the link record component

Method Details

lay

public List<GuidePage.Laid> lay(GuideLayout layout)

Description copied from interface: GuidePage

Sets the page out: one or more pages, each drawn on its own.

Specified by:

lay in interface GuidePage

searchText

public String searchText()

Description copied from interface: GuidePage

Words of the page a search should find it by.

Specified by:

searchText in interface GuidePage

items

public List<GuideStack> items()

Description copied from interface: GuidePage

The items this page is about: anywhere in the book, pressing one of them opens this page.

Specified by:

items in interface GuidePage

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.

item

public GuideStack item()

Returns the value of the item record component.

Returns:

the value of the item record component

title

public Optional<String> title()

Returns the value of the title record component.

Returns:

the value of the title record component

text

public String text()

Returns the value of the text record component.

Returns:

the value of the text record component

link

public boolean link()

Returns the value of the link record component.

Returns:

the value of the link record component