Enum Class MouseEvent.Button

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

public static enum MouseEvent.Button extends Enum<MouseEvent.Button>
Defines the mouse buttons that can be involved in a mouse event.
  • Enum Constant Details

    • NoButton

      public static final MouseEvent.Button NoButton
      No specific button is involved (used for move events).
    • Button1

      public static final MouseEvent.Button Button1
      The primary mouse button (usually the left button).
    • Button2

      public static final MouseEvent.Button Button2
      The middle mouse button.
    • Button3

      public static final MouseEvent.Button Button3
      The secondary mouse button (usually the right button).
    • WheelUp

      public static final MouseEvent.Button WheelUp
      The mouse wheel was scrolled upward.
    • WheelDown

      public static final MouseEvent.Button WheelDown
      The mouse wheel was scrolled downward.
  • Method Details

    • values

      public static MouseEvent.Button[] 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 MouseEvent.Button 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