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

Record Class Focus<K>

java.lang.Object
java.lang.Record
io.github.cottonmc.cotton.gui.widget.focus.Focus<K>
Type Parameters:
K - the key type
Record Components:
key - the key
area - the focusable area in widget space
public record Focus<K>(K key, Rect2i area) extends Record
A focus is a focusable area in a widget.

Foci can also carry a "key", which is a custom data value used to identify a specific focus. For example, an item slot grid widget might use K = Integer to identify each individual slot.

Since:
7.0.0

  • Constructor Summary

    Constructors
    Constructor
    Description
    Focus(K key, Rect2i area)
    Creates an instance of a Focus record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    Rect2i
    area()
    Returns the value of the area 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.
    K
    key()
    Returns the value of the key record component.
    static Focus<@Nullable Void>
    of(Rect2i area)
    Creates a focus of an area and null data.
    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

  • Constructor Details

    • Focus

      public Focus(K key, Rect2i area)
      Creates an instance of a Focus record class.
      Parameters:
      key - the value for the key record component
      area - the value for the area record component

  • Method Details

    • of

      public static Focus<@Nullable Void> of(Rect2i area)
      Creates a focus of an area and null data.
      Parameters:
      area - the area
      Returns:
      the focus

    • 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 Objects::equals(Object,Object).
      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.

    • key

      public K key()
      Returns the value of the key record component.
      Returns:
      the value of the key record component

    • area

      public Rect2i area()
      Returns the value of the area record component.
      Returns:
      the value of the area record component