Package org.pepstock.charba.client.dom.enums

Enum KeyboardUiKey

java.lang.Object

java.lang.Enum<KeyboardUiKey>

org.pepstock.charba.client.dom.enums.KeyboardUiKey

All Implemented Interfaces:

Serializable, Comparable<KeyboardUiKey>, Key, IsKeyboardKey

public enum KeyboardUiKey
extends Enum<KeyboardUiKey>
implements IsKeyboardKey

Enumerates the user interface keys for NativeKeyboardEvent.

Author:

Andrea "Stock" Stocchero

Enum Constant Summary

Enum Constants

Enum Constant	Description
ACCEPT	The Accept, Commit, or OK key or button.
AGAIN	The Again key.
ATTENTION	The Attn (Attention) key.
CANCEL	The Cancel key.
CONTEXT_MENU	Shows the context menu.
ESCAPE	The Esc (Escape) key.
EXECUTE	The Execute key.
FIND	The Find key.
FINISH	The Finish key.
HELP	The Help key.
PAUSE	The Pause key.
PLAY	The Play key.
PROPERTIES	The Props (Properties) key.
SELECT	The Select key.
ZOOM_IN	The ZoomIn key.
ZOOM_OUT	The ZoomOut key.

Method Summary

Modifier and Type	Method	Description
String	value()	Returns the name value of property
static KeyboardUiKey	valueOf(String name)	Returns the enum constant of this type with the specified name.
static KeyboardUiKey[]	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

Methods inherited from interface org.pepstock.charba.client.dom.enums.IsKeyboardKey

is, is, is

Enum Constant Detail

ACCEPT

public static final KeyboardUiKey ACCEPT

The Accept, Commit, or OK key or button.

AGAIN

public static final KeyboardUiKey AGAIN

The Again key. Redoes or repeats a previous action.

ATTENTION

public static final KeyboardUiKey ATTENTION

The Attn (Attention) key.

CANCEL

public static final KeyboardUiKey CANCEL

The Cancel key.

CONTEXT_MENU

public static final KeyboardUiKey CONTEXT_MENU

Shows the context menu. Typically found between theWindows (or OS) key and the Control key on the right side of the keyboard.

ESCAPE

public static final KeyboardUiKey ESCAPE

The Esc (Escape) key. Typically used as an exit, cancel, or"escape this operation" button. Historically, the Escape character was used to signal the start of a special control sequence of characters called an "escape sequence."

EXECUTE

public static final KeyboardUiKey EXECUTE

The Execute key.

FIND

public static final KeyboardUiKey FIND

The Find key. Opens an interface (typically a dialog box) for performing a find/search operation.

FINISH

public static final KeyboardUiKey FINISH

The Finish key.

HELP

public static final KeyboardUiKey HELP

The Help key. Opens or toggles the display of help information.

PAUSE

public static final KeyboardUiKey PAUSE

The Pause key. Pauses the current application or state, if applicable.
Note: This shouldn't be confused with the "MediaPause" key value, which is used for media controllers, rather than to control applications and processes.

PLAY

public static final KeyboardUiKey PLAY

The Play key. Resumes a previously paused application, if applicable.
Note: This shouldn't be confused with the"MediaPlay" key value, which is used for media controllers, rather than to control applications and processes.

PROPERTIES

public static final KeyboardUiKey PROPERTIES

The Props (Properties) key.

SELECT

public static final KeyboardUiKey SELECT

The Select key.

ZOOM_IN

public static final KeyboardUiKey ZOOM_IN

The ZoomIn key.

ZOOM_OUT

public static final KeyboardUiKey ZOOM_OUT

The ZoomOut key.

Method Detail

values

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

Returns:

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

valueOf

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

value

public String value()

Description copied from interface: Key

Returns the name value of property

Specified by:

value in interface Key

Returns:

the name value of property