Record Class GuiKeyEvent

java.lang.Object
java.lang.Record
dev.boze.api.gui.input.GuiKeyEvent
Record Components:
key - GLFW key code
scancode - Platform scancode
modifiers - GLFW modifier bits
public record GuiKeyEvent(int key, int scancode, int modifiers) extends Record
A key press or release.

  • Constructor Details

    • GuiKeyEvent

      public GuiKeyEvent(int key, int scancode, int modifiers)
      Creates an instance of a GuiKeyEvent record class.
      Parameters:
      key - the value for the key record component
      scancode - the value for the scancode record component
      modifiers - the value for the modifiers record component

  • Method Details

    • isEscape

      public boolean isEscape()

    • isEnter

      public boolean isEnter()

    • isBackspace

      public boolean isBackspace()

    • isDelete

      public boolean isDelete()

    • isTab

      public boolean isTab()

    • hasShift

      public boolean hasShift()

    • hasControl

      public boolean hasControl()

    • hasAlt

      public boolean hasAlt()

    • hasActionModifier

      public boolean hasActionModifier()
      Returns:
      Whether Cmd (macOS) or Ctrl (elsewhere) is held

    • isPaste

      public boolean isPaste()

    • isCopy

      public boolean isCopy()

    • isSelectAll

      public boolean isSelectAll()

    • keyName

      public String keyName()
      Returns:
      The printable name of the key in the current keyboard layout, or null

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

    • key

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

    • scancode

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

    • modifiers

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