com.vaadin.flow.component.

Enum Class KeyLocation

java.lang.Object
java.lang.Enum<KeyLocation>
com.vaadin.flow.component.KeyLocation

All Implemented Interfaces:

Serializable, Comparable<KeyLocation>, Constable

public enum KeyLocation extends Enum<KeyLocation>

Possible keyboard key locations. The location attribute can be used to disambiguate between key values that can be generated by different physical keys on the keyboard, for example, the left and right Shift key.

Since:

1.0

  • Enum Constant Details

    • STANDARD

      public static final KeyLocation STANDARD

      Standard key location.

    • LEFT

      public static final KeyLocation LEFT

      Left key location.

    • NUMPAD

      public static final KeyLocation NUMPAD

      Numeric pad key location.

  • Method Details

    • values

      public static KeyLocation[] 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 KeyLocation 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

    • getLocation

      public int getLocation()

      Gets the key location integer value.

      Returns:

      the key location integer value

    • of

      public static KeyLocation of(int location)

      Returns the KeyLocation for location.

      Parameters:

      location - the location integer value

      Returns:

      the KeyLocation