VirtualKey (Jowidgets API Specification)

java.lang.Object
- java.lang.Enum<VirtualKey>
- - org.jowidgets.common.types.VirtualKey

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<VirtualKey>
```
public enum VirtualKey
extends java.lang.Enum<VirtualKey>
```

Enum Constant Summary

Enum Constants
Enum Constant and Description
`A`
`ALT`
`ARROW_DOWN`
`ARROW_LEFT`
`ARROW_RIGHT`
`ARROW_UP`
`B`
`BACK_SPACE`
`C`
`CAPS_LOCK`
`CONTROL`
`D`
`DELETE`
`DIGIT_0`
`DIGIT_1`
`DIGIT_2`
`DIGIT_3`
`DIGIT_4`
`DIGIT_5`
`DIGIT_6`
`DIGIT_7`
`DIGIT_8`
`DIGIT_9`
`E`
`END`
`ENTER`
`ESC`
`F`
`F1`
`F10`
`F11`
`F12`
`F2`
`F3`
`F4`
`F5`
`F6`
`F7`
`F8`
`F9`
`G`
`H`
`HOME`
`I`
`INSERT`
`J`
`K`
`L`
`M`
`N`
`O`
`P`
`PAGE_DOWN`
`PAGE_UP`
`PAUSE`
`Q`
`R`
`S`
`SHIFT`
`SPACE`
`T`
`TAB`
`U`
`UNDEFINED` The key pressed or released is not defined as a virtual key.
`V`
`W`
`X`
`Y`
`Z`

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.Character`	`getCharacter()` Gets a character representation of the virtual key, or null, if the virtual key is not representable by a character.
`java.lang.String`	`getLabel()` Gets the label of the key.
`boolean`	`isCharacter()`
`static VirtualKey`	`toVirtualKey(char character)` Gets the virtual key for a char.
`static VirtualKey`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static VirtualKey[]`	`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

F1
```
public static final VirtualKey F1
```

F2
```
public static final VirtualKey F2
```

F3
```
public static final VirtualKey F3
```

F4
```
public static final VirtualKey F4
```

F5
```
public static final VirtualKey F5
```

F6
```
public static final VirtualKey F6
```

F7
```
public static final VirtualKey F7
```

F8
```
public static final VirtualKey F8
```

F9
```
public static final VirtualKey F9
```

F10
```
public static final VirtualKey F10
```

F11
```
public static final VirtualKey F11
```

F12
```
public static final VirtualKey F12
```

ENTER
```
public static final VirtualKey ENTER
```

BACK_SPACE

public static final VirtualKey BACK_SPACE

TAB
```
public static final VirtualKey TAB
```

SHIFT
```
public static final VirtualKey SHIFT
```

CONTROL
```
public static final VirtualKey CONTROL
```

ALT
```
public static final VirtualKey ALT
```

PAUSE
```
public static final VirtualKey PAUSE
```

CAPS_LOCK

public static final VirtualKey CAPS_LOCK

ESC
```
public static final VirtualKey ESC
```

SPACE
```
public static final VirtualKey SPACE
```

PAGE_UP
```
public static final VirtualKey PAGE_UP
```

PAGE_DOWN

public static final VirtualKey PAGE_DOWN

END
```
public static final VirtualKey END
```

HOME
```
public static final VirtualKey HOME
```

DELETE
```
public static final VirtualKey DELETE
```

INSERT
```
public static final VirtualKey INSERT
```

ARROW_LEFT

public static final VirtualKey ARROW_LEFT

ARROW_UP

public static final VirtualKey ARROW_UP

ARROW_RIGHT

public static final VirtualKey ARROW_RIGHT

ARROW_DOWN

public static final VirtualKey ARROW_DOWN

DIGIT_0
```
public static final VirtualKey DIGIT_0
```

DIGIT_1
```
public static final VirtualKey DIGIT_1
```

DIGIT_2
```
public static final VirtualKey DIGIT_2
```

DIGIT_3
```
public static final VirtualKey DIGIT_3
```

DIGIT_4
```
public static final VirtualKey DIGIT_4
```

DIGIT_5
```
public static final VirtualKey DIGIT_5
```

DIGIT_6
```
public static final VirtualKey DIGIT_6
```

DIGIT_7
```
public static final VirtualKey DIGIT_7
```

DIGIT_8
```
public static final VirtualKey DIGIT_8
```

DIGIT_9
```
public static final VirtualKey DIGIT_9
```

A
```
public static final VirtualKey A
```

B
```
public static final VirtualKey B
```

C
```
public static final VirtualKey C
```

D
```
public static final VirtualKey D
```

E
```
public static final VirtualKey E
```

F
```
public static final VirtualKey F
```

G
```
public static final VirtualKey G
```

H
```
public static final VirtualKey H
```

I
```
public static final VirtualKey I
```

J
```
public static final VirtualKey J
```

K
```
public static final VirtualKey K
```

L
```
public static final VirtualKey L
```

M
```
public static final VirtualKey M
```

N
```
public static final VirtualKey N
```

O
```
public static final VirtualKey O
```

P
```
public static final VirtualKey P
```

Q
```
public static final VirtualKey Q
```

R
```
public static final VirtualKey R
```

S
```
public static final VirtualKey S
```

T
```
public static final VirtualKey T
```

U
```
public static final VirtualKey U
```

V
```
public static final VirtualKey V
```

W
```
public static final VirtualKey W
```

X
```
public static final VirtualKey X
```

Y
```
public static final VirtualKey Y
```

Z
```
public static final VirtualKey Z
```

UNDEFINED
```
public static final VirtualKey UNDEFINED
```
The key pressed or released is not defined as a virtual key. This must not be used to define accelerators.

Method Detail
- values
```
public static VirtualKey[] 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 (VirtualKey c : VirtualKey.values())
    System.out.println(c);
```
  Returns:
  an array containing the constants of this enum type, in the order they are declared
- valueOf
```
public static VirtualKey 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
- getLabel
```
public java.lang.String getLabel()
```
  Gets the label of the key.
  
  Returns:
  The label of the key
- getCharacter
```
public java.lang.Character getCharacter()
```
  Gets a character representation of the virtual key, or null, if the virtual key is not representable by a character.
  
  Returns:
  The character representation or null
- isCharacter
```
public boolean isCharacter()
```
  Returns:
  true, if the virtual key is representable by a character, false otherwise.
- toVirtualKey
```
public static VirtualKey toVirtualKey(char character)
```
  Gets the virtual key for a char.
  
  Parameters:
  character - The char to get the virtual key for
  
  Returns:
  The virtual key for the char or null, if no virtual key exists for the char

Enum VirtualKey

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

F1

F2

F3

F4

F5

F6

F7

F8

F9

F10

F11

F12

ENTER

BACK_SPACE

TAB

SHIFT

CONTROL

ALT

PAUSE

CAPS_LOCK

ESC

SPACE

PAGE_UP

PAGE_DOWN

END

HOME

DELETE

INSERT

ARROW_LEFT

ARROW_UP

ARROW_RIGHT

ARROW_DOWN

DIGIT_0

DIGIT_1

DIGIT_2

DIGIT_3

DIGIT_4

DIGIT_5

DIGIT_6

DIGIT_7

DIGIT_8

DIGIT_9

A

B

C

D

E

F

G

H

I

J

K

L

M

N

O

P

Q

R

S

T

U

V

W

X

Y

Z

UNDEFINED

Method Detail

values

valueOf

getLabel

getCharacter