Package io.guise.framework.platform.web

Enum KeyCode

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<KeyCode>
    public enum KeyCode
extends java.lang.Enum<KeyCode>
    A key on a keyboard as reported by a browser's Event.keyCode property.
    Author:
    Garret Wilson

    • Method Detail

      • values

        public static KeyCode[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (KeyCode c : KeyCode.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static KeyCode valueOf​(java.lang.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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • getCode

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

      • getKey

        public Key getKey()
        Returns:
        The key this key code represents.

      • valueOf

        public static KeyCode valueOf​(int code)
        Retrieves a key code corresponding to the given code.
        Parameters:
        code - The code for which a key code should be returned.
        Returns:
        The key code representing the given code.
        Throws:
        java.lang.IllegalArgumentException - if the given code does not match one of the known key codes.