Enum Class KeyEvent.Modifier

java.lang.Object
java.lang.Enum<KeyEvent.Modifier>
org.jline.terminal.KeyEvent.Modifier
All Implemented Interfaces:
Serializable, Comparable<KeyEvent.Modifier>, Constable
Enclosing class:
KeyEvent

public static enum KeyEvent.Modifier extends Enum<KeyEvent.Modifier>
Defines modifier keys that can be held during a key event.
  • Enum Constant Details

    • Shift

      public static final KeyEvent.Modifier Shift
      The Shift key was held.
    • Alt

      public static final KeyEvent.Modifier Alt
      The Alt key was held.
    • Control

      public static final KeyEvent.Modifier Control
      The Control key was held.
    • Super

      public static final KeyEvent.Modifier Super
      The Super (Windows/Command) key was held. Reported by the Kitty Keyboard Protocol.
    • Hyper

      public static final KeyEvent.Modifier Hyper
      The Hyper key was held. Reported by the Kitty Keyboard Protocol.
    • Meta

      public static final KeyEvent.Modifier Meta
      The Meta key was held. Reported by the Kitty Keyboard Protocol.
    • CapsLock

      public static final KeyEvent.Modifier CapsLock
      The Caps Lock key was active. Reported by the Kitty Keyboard Protocol.
    • NumLock

      public static final KeyEvent.Modifier NumLock
      The Num Lock key was active. Reported by the Kitty Keyboard Protocol.
  • Method Details

    • values

      public static KeyEvent.Modifier[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static KeyEvent.Modifier valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null