Record Class FoliosLayout.Flow

java.lang.Object
java.lang.Record
net.ixdarklord.folios.api.client.page.FoliosLayout.Flow
Enclosing class:
FoliosLayout
public static record FoliosLayout.Flow(@Nullable String title, int reserved, @Nullable String text, @Nullable FoliosPageElement.Part part) extends Record
What a page asked FoliosLayout.flow(String, int, String, FoliosPageElement.Part) for: its title, its own part and how tall it is, and its text. A page that holds others (a page's "elements") sets each of them out from these, one under another.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Flow(@Nullable String title, int reserved, @Nullable String text, @Nullable FoliosPageElement.Part part)
    Creates an instance of a Flow 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.
    @Nullable FoliosPageElement.Part
    part()
    Returns the value of the part record component.
    int
    reserved()
    Returns the value of the reserved record component.
    @Nullable String
    text()
    Returns the value of the text record component.
    @Nullable 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 Object

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

  • Constructor Details

    • Flow

      public Flow(@Nullable String title, int reserved, @Nullable String text, @Nullable FoliosPageElement.Part part)
      Creates an instance of a Flow record class.
      Parameters:
      title - the value for the title record component
      reserved - the value for the reserved record component
      text - the value for the text record component
      part - the value for the part record component

  • Method Details

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

    • title

      public @Nullable String title()
      Returns the value of the title record component.
      Returns:
      the value of the title record component

    • reserved

      public int reserved()
      Returns the value of the reserved record component.
      Returns:
      the value of the reserved record component

    • text

      public @Nullable String text()
      Returns the value of the text record component.
      Returns:
      the value of the text record component

    • part

      public @Nullable FoliosPageElement.Part part()
      Returns the value of the part record component.
      Returns:
      the value of the part record component