Package io.guise.framework.platform.web

Enum Button

java.lang.Object
java.lang.Enum<Button>
io.guise.framework.platform.web.Button
All Implemented Interfaces:
Serializable, Comparable<Button>
public enum Button extends Enum<Button>
A button on a mouse as reported by a browser's Event.button property.
Author:
Garret Wilson
See Also:

  • Enum Constant Details

    • LEFT

      public static final Button LEFT
      Left button.

    • MIDDLE

      public static final Button MIDDLE
      Middle button.

  • Method Details

    • values

      public static Button[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static Button valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name
      NullPointerException - if the argument is null

    • getCode

      public int getCode()
      Returns:
      The code reported by the browser.

    • getMouseButton

      public MouseButton getMouseButton()
      Returns:
      The mouse button this button represents.

    • valueOf

      public static Button valueOf(int code)
      Retrieves a button corresponding to the given code.
      Parameters:
      code - The code for which a button should be returned.
      Returns:
      The button representing the given code.
      Throws:
      IllegalArgumentException - if the given code does not match one of the known buttons.