Record Class GuiPageSize

java.lang.Object
java.lang.Record
com.render.api.gui.pagination.GuiPageSize
Record Components:
width - page width
height - page height
public record GuiPageSize(float width, float height) extends Record
Immutable on-screen page dimensions in design-space pixels.

  • Field Details

    • A4_PORTRAIT

      public static final GuiPageSize A4_PORTRAIT

    • A4_LANDSCAPE

      public static final GuiPageSize A4_LANDSCAPE

    • LETTER_PORTRAIT

      public static final GuiPageSize LETTER_PORTRAIT

  • Constructor Details

    • GuiPageSize

      public GuiPageSize(float width, float height)
      Creates an instance of a GuiPageSize record class.
      Parameters:
      width - the value for the width record component
      height - the value for the height record component

  • Method Details

    • of

      public static GuiPageSize of(float width, float height)

    • 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 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.

    • width

      public float width()
      Returns the value of the width record component.
      Returns:
      the value of the width record component

    • height

      public float height()
      Returns the value of the height record component.
      Returns:
      the value of the height record component