com.guiseframework.input
Enum Key

java.lang.Object
  java.lang.Enum<Key>
      com.guiseframework.input.Key

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Key>

public enum Key
extends java.lang.Enum<Key>

A key on a keyboard. The Unicode code point to which a particular key corresponds vary according to keyboard layout. Some keys, such as control keys, do not respond to any Unicode code point at all.

Author:

Garret Wilson

See Also:

java.awt.event.KeyEvent

Enum Constant Summary

ALT_LEFT

ALT_RIGHT

BACKSPACE

CANCEL

CAPS_LOCK

CLEAR

CONTEXT_MENU

CONTROL_LEFT

CONTROL_RIGHT

DELETE

DOWN

END

ENTER

ESCAPE

F1

F10

F11

F12

F2

F3

F4

F5

F6

F7

F8

F9

HOME

INSERT

LEFT

MULTIPLY

NUMPAD_0

NUMPAD_1

NUMPAD_2

NUMPAD_3

NUMPAD_4

NUMPAD_5

NUMPAD_6

NUMPAD_7

NUMPAD_8

NUMPAD_9

NUMPAD_ADD

NUMPAD_DECIMAL

NUMPAD_DIVIDE

NUMPAD_ENTER

NUMPAD_NUM_LOCK

NUMPAD_SCROLL_LOCK

NUMPAD_SUBTRACT

PAGE_DOWN

PAGE_UP

PAUSE

PRINT_SCREEN

RIGHT

SHIFT_LEFT

SHIFT_RIGHT

SPACE

TAB

UP

WINDOWS

Method Summary

static Key	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Key[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ALT_LEFT

public static final Key ALT_LEFT

ALT_RIGHT

public static final Key ALT_RIGHT

BACKSPACE

public static final Key BACKSPACE

CANCEL

public static final Key CANCEL

CAPS_LOCK

public static final Key CAPS_LOCK

CLEAR

public static final Key CLEAR

CONTEXT_MENU

public static final Key CONTEXT_MENU

CONTROL_LEFT

public static final Key CONTROL_LEFT

CONTROL_RIGHT

public static final Key CONTROL_RIGHT

DELETE

public static final Key DELETE

DOWN

public static final Key DOWN

END

public static final Key END

ENTER

public static final Key ENTER

ESCAPE

public static final Key ESCAPE

F1

public static final Key F1

F2

public static final Key F2

F3

public static final Key F3

F4

public static final Key F4

F5

public static final Key F5

F6

public static final Key F6

F7

public static final Key F7

F8

public static final Key F8

F9

public static final Key F9

F10

public static final Key F10

F11

public static final Key F11

F12

public static final Key F12

HOME

public static final Key HOME

INSERT

public static final Key INSERT

LEFT

public static final Key LEFT

MULTIPLY

public static final Key MULTIPLY

NUMPAD_0

public static final Key NUMPAD_0

NUMPAD_1

public static final Key NUMPAD_1

NUMPAD_2

public static final Key NUMPAD_2

NUMPAD_3

public static final Key NUMPAD_3

NUMPAD_4

public static final Key NUMPAD_4

NUMPAD_5

public static final Key NUMPAD_5

NUMPAD_6

public static final Key NUMPAD_6

NUMPAD_7

public static final Key NUMPAD_7

NUMPAD_8

public static final Key NUMPAD_8

NUMPAD_9

public static final Key NUMPAD_9

NUMPAD_ADD

public static final Key NUMPAD_ADD

NUMPAD_DECIMAL

public static final Key NUMPAD_DECIMAL

NUMPAD_DIVIDE

public static final Key NUMPAD_DIVIDE

NUMPAD_ENTER

public static final Key NUMPAD_ENTER

NUMPAD_NUM_LOCK

public static final Key NUMPAD_NUM_LOCK

NUMPAD_SCROLL_LOCK

public static final Key NUMPAD_SCROLL_LOCK

NUMPAD_SUBTRACT

public static final Key NUMPAD_SUBTRACT

PAGE_DOWN

public static final Key PAGE_DOWN

PAGE_UP

public static final Key PAGE_UP

PAUSE

public static final Key PAUSE

PRINT_SCREEN

public static final Key PRINT_SCREEN

RIGHT

public static final Key RIGHT

SHIFT_LEFT

public static final Key SHIFT_LEFT

SHIFT_RIGHT

public static final Key SHIFT_RIGHT

SPACE

public static final Key SPACE

TAB

public static final Key TAB

UP

public static final Key UP

WINDOWS

public static final Key WINDOWS

Method Detail

values

public static Key[] 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 (Key c : Key.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Key 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