Record Class PaginatedListSection

java.lang.Object
java.lang.Record
de.Keyle.MyPet.api.gui.PaginatedListSection
Record Components:
id - this section's id within its menu
type - the registered type handle this section was decoded as
col - left-hand column of the region
row - top row of the region
width - region width in slots
height - region height in slots
template - appearance applied to each item in turn
previousPageSectionId - id of the slot section acting as the previous-page button, or null when the list does not paginate
nextPageSectionId - id of the slot section acting as the next-page button, or null when the list does not paginate
soundOnPageChange - played when the page changes
soundOnTemplateClick - played when an item is clicked
All Implemented Interfaces:
Section

public record PaginatedListSection(String id, SectionType<PaginatedListSection> type, int col, int row, int width, int height, ItemAppearance template, @Nullable String previousPageSectionId, @Nullable String nextPageSectionId, SoundSpec soundOnPageChange, SoundSpec soundOnTemplateClick) extends Record implements Section
Rectangular region populated by a per-item template applied to a stream supplied by the menu handler. previousPageSectionId / nextPageSectionId are optional: when both are null the list does not paginate and any items past slotCapacity() are dropped (useful for bounded item sets like beacon buffs).
  • Constructor Details

    • PaginatedListSection

      public PaginatedListSection(String id, SectionType<PaginatedListSection> type, int col, int row, int width, int height, ItemAppearance template, @Nullable @Nullable String previousPageSectionId, @Nullable @Nullable String nextPageSectionId, SoundSpec soundOnPageChange, SoundSpec soundOnTemplateClick)
      Rejects a non-positive region and substitutes silence for absent sounds.
  • Method Details

    • slotCapacity

      public int slotCapacity()
      Returns how many items fit on one page.
      Returns:
      width * height
    • isPaginated

      public boolean isPaginated()
      True if both page-button refs are supplied — the list paginates on overflow.
      Returns:
      true if both page-button references are set
    • 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.
    • id

      public String id()
      Returns the value of the id record component.
      Specified by:
      id in interface Section
      Returns:
      the value of the id record component
    • type

      Returns the value of the type record component.
      Specified by:
      type in interface Section
      Returns:
      the value of the type record component
    • col

      public int col()
      Returns the value of the col record component.
      Returns:
      the value of the col record component
    • row

      public int row()
      Returns the value of the row record component.
      Returns:
      the value of the row record component
    • width

      public int width()
      Returns the value of the width record component.
      Returns:
      the value of the width record component
    • height

      public int height()
      Returns the value of the height record component.
      Returns:
      the value of the height record component
    • template

      public ItemAppearance template()
      Returns the value of the template record component.
      Returns:
      the value of the template record component
    • previousPageSectionId

      @Nullable public @Nullable String previousPageSectionId()
      Returns the value of the previousPageSectionId record component.
      Returns:
      the value of the previousPageSectionId record component
    • nextPageSectionId

      @Nullable public @Nullable String nextPageSectionId()
      Returns the value of the nextPageSectionId record component.
      Returns:
      the value of the nextPageSectionId record component
    • soundOnPageChange

      public SoundSpec soundOnPageChange()
      Returns the value of the soundOnPageChange record component.
      Returns:
      the value of the soundOnPageChange record component
    • soundOnTemplateClick

      public SoundSpec soundOnTemplateClick()
      Returns the value of the soundOnTemplateClick record component.
      Returns:
      the value of the soundOnTemplateClick record component