Package io.github.cottonmc.cotton.gui.widget.data

Record Class Insets

java.lang.Object
java.lang.Record
io.github.cottonmc.cotton.gui.widget.data.Insets
Record Components:
top - the top (Y-) inset size
left - the left (X-) inset size
bottom - the bottom (Y+) inset size
right - the right (X+) inset size
public record Insets(int top, int left, int bottom, int right) extends Record
The layout insets of a panel. The insets describe how many pixels should be around the panel's contents. For example, root panels have 7 pixels around their contents, which is set via ROOT_PANEL.
Since:
4.0.0

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final Insets
    NONE
    Empty layout insets that do not provide any borders around content.
    static final Insets
    ROOT_PANEL
    The default insets of a root panel, providing 7 pixels around the content on all sides.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Insets(int size)
    Constructs layout insets.
    Insets(int vertical, int horizontal)
    Constructs layout insets.
    Insets(int top, int left, int bottom, int right)
    Constructs layout insets.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    bottom()
    Returns the value of the bottom record component.
    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.
    int
    height()
    Returns the total height of these insets.
    int
    left()
    Returns the value of the left record component.
    int
    right()
    Returns the value of the right record component.
    int
    top()
    Returns the value of the top record component.
    final String
    toString()
    Returns a string representation of this record class.
    int
    width()
    Returns the total width of these insets.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • NONE

      public static final Insets NONE
      Empty layout insets that do not provide any borders around content.

    • ROOT_PANEL

      public static final Insets ROOT_PANEL
      The default insets of a root panel, providing 7 pixels around the content on all sides.

  • Constructor Details

    • Insets

      public Insets(int top, int left, int bottom, int right)
      Constructs layout insets.
      Parameters:
      top - the top (Y-) inset size
      left - the left (X-) inset size
      bottom - the bottom (Y+) inset size
      right - the right (X+) inset size

    • Insets

      public Insets(int vertical, int horizontal)
      Constructs layout insets.
      Parameters:
      vertical - the vertical (Y) size of the insets
      horizontal - the horizontal (X) size of the insets

    • Insets

      public Insets(int size)
      Constructs layout insets.
      Parameters:
      size - the size of the insets on all sides

  • Method Details

    • width

      public int width()
      Returns the total width of these insets.

      Equivalent to left() + right().

      Returns:
      the total width of these insets
      Since:
      9.1.0

    • height

      public int height()
      Returns the total height of these insets.

      Equivalent to top() + bottom().

      Returns:
      the total height of these insets
      Since:
      9.1.0

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

    • top

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

    • left

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

    • bottom

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

    • right

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