Package com.ardor3d.input

Enum Class Key

java.lang.Object

java.lang.Enum<Key>

com.ardor3d.input.Key

All Implemented Interfaces:

Serializable, Comparable<Key>, Constable

public enum Key
extends Enum<Key>

Keys supported by Ardor3D platforms. Note that all keys are not likely supported by any one platform.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
A	a key.
APOSTROPHE	' key.
APPS	Applications key.
AT	@ key .
AX	ax key .
B	b key.
BACK	back key.
BACKSLASH	\ key.
C	c key.
CALL	mobile call button
CAMERA	mobile camera button
CAPITAL	caps lock key.
CENTER	dpad center button
CIRCUMFLEX	circum flex key .
CLEAR	mobile clear button
COLON	: key
COMMA	, key.
CONVERT	convert key .
D	d key.
DECIMAL	. key .
DELETE	delete key.
DIVIDE	/ key .
DOWN	down arrow key.
E	e key.
EIGHT	8 key.
END	end key.
ENDCALL	mobile end call button
ENVELOPE	mobile envelope button
EQUALS	= key.
ESCAPE	escape key.
EXPLORER	mobile explorer button
F	f key.
F1	F1 key.
F10	F10 key.
F11	F11 key.
F12	F12 key.
F13	F13 key.
F14	F14 key.
F15	F15 key.
F2	F2 key.
F3	F3 key.
F4	F4 key.
F5	F5 key.
F6	F6 key.
F7	F7 key.
F8	F8 key.
F9	F9 key.
FIVE	5 key.
FOCUS	mobile focus button
FOUR	4 key.
G	g key.
GRAVE	` key.
H	h key.
HEADSETHOOK	mobile headsethook button
HOME	home key.
I	i key.
INSERT	insert key.
J	j key.
K	k key.
KANA	kana key .
KANJI	kanji key .
L	l key.
LBRACKET	[ key.
LCONTROL	left control key.
LEFT	left arrow key.
LMENU	left alt key.
LMETA	Left Windows/Option key
LSHIFT	left shift key.
M	m key.
MEDIA_FAST_FORWARD	mobile fast fwd button
MEDIA_NEXT	mobile next button
MEDIA_PREVIOUS	mobile previous button
MEDIA_REWIND	mobile rewind button
MEDIA_STOP	mobile stop button
MENU	mobile menu button
MINUS	- key.
MULTIPLY	* key .
MUTE	mobile mute button
N	n key.
NINE	9 key.
NOCONVERT	noconvert key .
NOTIFICATION	mobile notification button
NUMLOCK	NumLK key.
NUMPAD0	0 key .
NUMPAD1	1 key .
NUMPAD2	2 key .
NUMPAD3	3 key .
NUMPAD4	4 key .
NUMPAD5	5 key .
NUMPAD6	6 key .
NUMPAD7	7 key .
NUMPAD8	8 key .
NUMPAD9	9 key .
NUMPADADD	+ key .
NUMPADCOMMA	, key on num pad .
NUMPADENTER	Enter key .
NUMPADEQUALS	= on num pad .
NUMPADSUBTRACT	- key .
O	o key.
ONE	1 key.
P	p key.
PAGEDOWN_NEXT	PageDown/Next key.
PAGEUP_PRIOR	PageUp/Prior key.
PAUSE	pause key.
PERIOD	. key .
PLAY_PAUSE	mobile play/pause button
PLUS	plus key
POUND	pound key
POWER	power key.
Q	q key.
R	r key.
RBRACKET	] key.
RCONTROL	right control key.
RETURN	enter key.
RIGHT	right arrow key.
RMENU	right alt key.
RMETA	Right Windows/Option key
RSHIFT	right shift key.
S	s key.
SCROLL	Scroll lock key.
SEARCH	mobile call button
SEMICOLON	; key.
SEVEN	7 key.
SIX	6 key.
SLASH	/ key .
SLEEP	sleep key.
SPACE	space key.
STAR	mobile star button
STOP	stop key .
SYM	mobile # button
SYSRQ	SysRq key.
T	t key.
TAB	tab key.
THREE	3 key.
TWO	2 key.
U	u key.
UNDERLINE	_ key .
UNKNOWN	Returned when a key character is not supported.
UNLABELED	.
UP	up arrow key.
V	v key.
VOLUME_DOWN	volume down button
VOLUME_UP	volume up button
W	w key.
X	x key.
Y	y key.
YEN	yen key .
Z	z key.
ZERO	0 key.

Method Summary

Modifier and Type	Method	Description
static Key	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Key[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

UNKNOWN

public static final Key UNKNOWN

Returned when a key character is not supported.

ESCAPE

public static final Key ESCAPE

escape key.

ONE

public static final Key ONE

1 key.

TWO

public static final Key TWO

2 key.

THREE

public static final Key THREE

3 key.

FOUR

public static final Key FOUR

4 key.

FIVE

public static final Key FIVE

5 key.

SIX

public static final Key SIX

6 key.

SEVEN

public static final Key SEVEN

7 key.

EIGHT

public static final Key EIGHT

8 key.

NINE

public static final Key NINE

9 key.

ZERO

public static final Key ZERO

0 key.

MINUS

public static final Key MINUS

- key.

EQUALS

public static final Key EQUALS

= key.

BACK

public static final Key BACK

back key.

TAB

public static final Key TAB

tab key.

Q

public static final Key Q

q key.

W

public static final Key W

w key.

E

public static final Key E

e key.

R

public static final Key R

r key.

T

public static final Key T

t key.

Y

public static final Key Y

y key.

U

public static final Key U

u key.

I

public static final Key I

i key.

O

public static final Key O

o key.

P

public static final Key P

p key.

LBRACKET

public static final Key LBRACKET

[ key.

RBRACKET

public static final Key RBRACKET

] key.

RETURN

public static final Key RETURN

enter key.

LCONTROL

public static final Key LCONTROL

left control key.

A

public static final Key A

a key.

S

public static final Key S

s key.

D

public static final Key D

d key.

F

public static final Key F

f key.

G

public static final Key G

g key.

H

public static final Key H

h key.

J

public static final Key J

j key.

K

public static final Key K

k key.

L

public static final Key L

l key.

SEMICOLON

public static final Key SEMICOLON

; key.

APOSTROPHE

public static final Key APOSTROPHE

' key.

APPS

public static final Key APPS

Applications key.

GRAVE

public static final Key GRAVE

` key.

LSHIFT

public static final Key LSHIFT

left shift key.

BACKSLASH

public static final Key BACKSLASH

\ key.

Z

public static final Key Z

z key.

X

public static final Key X

x key.

C

public static final Key C

c key.

V

public static final Key V

v key.

B

public static final Key B

b key.

N

public static final Key N

n key.

M

public static final Key M

m key.

COMMA

public static final Key COMMA

, key.

PERIOD

public static final Key PERIOD

. key .

SLASH

public static final Key SLASH

/ key .

RSHIFT

public static final Key RSHIFT

right shift key.

MULTIPLY

public static final Key MULTIPLY

* key .

LMENU

public static final Key LMENU

left alt key.

SPACE

public static final Key SPACE

space key.

CAPITAL

public static final Key CAPITAL

caps lock key.

F1

public static final Key F1

F1 key.

F2

public static final Key F2

F2 key.

F3

public static final Key F3

F3 key.

F4

public static final Key F4

F4 key.

F5

public static final Key F5

F5 key.

F6

public static final Key F6

F6 key.

F7

public static final Key F7

F7 key.

F8

public static final Key F8

F8 key.

F9

public static final Key F9

F9 key.

F10

public static final Key F10

F10 key.

NUMLOCK

public static final Key NUMLOCK

NumLK key.

SCROLL

public static final Key SCROLL

Scroll lock key.

NUMPAD7

public static final Key NUMPAD7

7 key .

NUMPAD8

public static final Key NUMPAD8

8 key .

NUMPAD9

public static final Key NUMPAD9

9 key .

NUMPADSUBTRACT

public static final Key NUMPADSUBTRACT

- key .

NUMPAD4

public static final Key NUMPAD4

4 key .

NUMPAD5

public static final Key NUMPAD5

5 key .

NUMPAD6

public static final Key NUMPAD6

6 key .

NUMPADADD

public static final Key NUMPADADD

+ key .

NUMPAD1

public static final Key NUMPAD1

1 key .

NUMPAD2

public static final Key NUMPAD2

2 key .

NUMPAD3

public static final Key NUMPAD3

3 key .

NUMPAD0

public static final Key NUMPAD0

0 key .

DECIMAL

public static final Key DECIMAL

. key .

F11

public static final Key F11

F11 key.

F12

public static final Key F12

F12 key.

F13

public static final Key F13

F13 key.

F14

public static final Key F14

F14 key.

F15

public static final Key F15

F15 key.

KANA

public static final Key KANA

kana key .

CONVERT

public static final Key CONVERT

convert key .

NOCONVERT

public static final Key NOCONVERT

noconvert key .

YEN

public static final Key YEN

yen key .

NUMPADEQUALS

public static final Key NUMPADEQUALS

= on num pad .

CIRCUMFLEX

public static final Key CIRCUMFLEX

circum flex key .

AT

public static final Key AT

@ key .

COLON

public static final Key COLON

: key

UNDERLINE

public static final Key UNDERLINE

_ key .

KANJI

public static final Key KANJI

kanji key .

STOP

public static final Key STOP

stop key .

AX

public static final Key AX

ax key .

UNLABELED

public static final Key UNLABELED

.

NUMPADENTER

public static final Key NUMPADENTER

Enter key .

RCONTROL

public static final Key RCONTROL

right control key.

NUMPADCOMMA

public static final Key NUMPADCOMMA

, key on num pad .

DIVIDE

public static final Key DIVIDE

/ key .

SYSRQ

public static final Key SYSRQ

SysRq key.

RMENU

public static final Key RMENU

right alt key.

PAUSE

public static final Key PAUSE

pause key.

HOME

public static final Key HOME

home key.

UP

public static final Key UP

up arrow key.

PAGEUP_PRIOR

public static final Key PAGEUP_PRIOR

PageUp/Prior key.

LEFT

public static final Key LEFT

left arrow key.

RIGHT

public static final Key RIGHT

right arrow key.

END

public static final Key END

end key.

DOWN

public static final Key DOWN

down arrow key.

PAGEDOWN_NEXT

public static final Key PAGEDOWN_NEXT

PageDown/Next key.

INSERT

public static final Key INSERT

insert key.

DELETE

public static final Key DELETE

delete key.

LMETA

public static final Key LMETA

Left Windows/Option key

RMETA

public static final Key RMETA

Right Windows/Option key

POWER

public static final Key POWER

power key.

SLEEP

public static final Key SLEEP

sleep key.

CALL

public static final Key CALL

mobile call button

CAMERA

public static final Key CAMERA

mobile camera button

CLEAR

public static final Key CLEAR

mobile clear button

CENTER

public static final Key CENTER

dpad center button

ENDCALL

public static final Key ENDCALL

mobile end call button

ENVELOPE

public static final Key ENVELOPE

mobile envelope button

EXPLORER

public static final Key EXPLORER

mobile explorer button

FOCUS

public static final Key FOCUS

mobile focus button

HEADSETHOOK

public static final Key HEADSETHOOK

mobile headsethook button

MEDIA_FAST_FORWARD

public static final Key MEDIA_FAST_FORWARD

mobile fast fwd button

MEDIA_NEXT

public static final Key MEDIA_NEXT

mobile next button

PLAY_PAUSE

public static final Key PLAY_PAUSE

mobile play/pause button

MEDIA_PREVIOUS

public static final Key MEDIA_PREVIOUS

mobile previous button

MEDIA_REWIND

public static final Key MEDIA_REWIND

mobile rewind button

MEDIA_STOP

public static final Key MEDIA_STOP

mobile stop button

MENU

public static final Key MENU

mobile menu button

MUTE

public static final Key MUTE

mobile mute button

NOTIFICATION

public static final Key NOTIFICATION

mobile notification button

PLUS

public static final Key PLUS

plus key

POUND

public static final Key POUND

pound key

SEARCH

public static final Key SEARCH

mobile call button

STAR

public static final Key STAR

mobile star button

SYM

public static final Key SYM

mobile # button

VOLUME_DOWN

public static final Key VOLUME_DOWN

volume down button

VOLUME_UP

public static final Key VOLUME_UP

volume up button

Method Details

values

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