Module technology.sola.engine

Package technology.sola.engine.input

Enum Class Key

java.lang.Object

java.lang.Enum<Key>

technology.sola.engine.input.Key

All Implemented Interfaces:

Serializable, Comparable<Key>, Constable

@NullMarked
public enum Key
extends Enum<Key>

Key enum contains information about keyboard keys.

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.
ALT	Alt key.
B	B key.
BACK_QUOTE	Back Quote key.
BACKSLASH	Backslash key.
BACKSPACE	Backspace key.
C	C key.
CAPS_LOCK	Caps Lock key.
CARRIAGE_RETURN	Carriage Return key.
COMMA	Comma key.
CONTROL	Control key.
D	D key.
DELETE	Delete key.
DOWN	Down key.
E	E key.
EIGHT	8 key.
END	End key.
ENTER	Enter key.
EQUALS	Equals key.
ESCAPE	Escape key.
F	F key.
F1	F1 key.
F10	F10 key.
F11	F11 key.
F12	F12 key.
F2	F2 key.
F3	F3 key.
F4	F4 key.
F5	F5 key.
F6	F6 key.
F7	F7 key.
F8	F8 key.
F9	F8 key.
FIVE	5 key.
FORWARD_SLASH	Forward Slash key.
FOUR	4 key.
G	G key.
H	H key.
HOME	Home key.
HYPHEN	Hyphen key.
I	I key.
INSERT	Insert key.
J	J key.
K	K key.
L	L key.
LEFT	Left key.
LEFT_BRACKET	Left Bracket key.
M	M key.
N	N key.
NINE	9 key.
NUM_DIVIDE	Divide key.
NUM_EIGHT	Num 8 key.
NUM_FIVE	Num 5 key.
NUM_FOUR	Num 4 key.
NUM_LOCK	Num Lock key.
NUM_MINUS	Minus key.
NUM_MULTIPLY	Multiply key.
NUM_NINE	Num 9 key.
NUM_ONE	Num 1 key.
NUM_PLUS	Plus key.
NUM_POINT	Point key.
NUM_SEVEN	Num 7 key.
NUM_SIX	Num 6 key.
NUM_THREE	Num 3 key.
NUM_TWO	Num 2 key.
NUM_ZERO	Num 0 key.
O	O key.
ONE	1 key.
P	P key.
PAGE_DOWN	Page Down key.
PAGE_UP	Page Up key.
PERIOD	Period key.
Q	Q key.
R	R key.
RIGHT	Right key.
RIGHT_BRACKET	Right Bracket key.
S	S key.
SEMI_COLON	Semi Colon key.
SEVEN	7 key.
SHIFT	Shift key.
SINGLE_QUOTE	Single Quote key.
SIX	6 key.
SPACE	Space key.
T	T key.
TAB	Tab key.
THREE	3 key.
TWO	2 key.
U	U key.
UP	Up key.
V	V key.
W	W key.
X	X key.
Y	Y key.
Z	Z key.
ZERO	0 key.

Method Summary

Modifier and Type	Method	Description
int	getCode()
String	getName()
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

BACKSPACE

public static final Key BACKSPACE

Backspace key.

TAB

public static final Key TAB

Tab key.

ENTER

public static final Key ENTER

Enter key.

CARRIAGE_RETURN

public static final Key CARRIAGE_RETURN

Carriage Return key.

SHIFT

public static final Key SHIFT

Shift key.

CONTROL

public static final Key CONTROL

Control key.

ALT

public static final Key ALT

Alt key.

CAPS_LOCK

public static final Key CAPS_LOCK

Caps Lock key.

ESCAPE

public static final Key ESCAPE

Escape key.

SPACE

public static final Key SPACE

Space key.

PAGE_UP

public static final Key PAGE_UP

Page Up key.

PAGE_DOWN

public static final Key PAGE_DOWN

Page Down key.

END

public static final Key END

End key.

HOME

public static final Key HOME

Home key.

LEFT

public static final Key LEFT

Left key.

UP

public static final Key UP

Up key.

RIGHT

public static final Key RIGHT

Right key.

DOWN

public static final Key DOWN

Down key.

COMMA

public static final Key COMMA

Comma key.

HYPHEN

public static final Key HYPHEN

Hyphen key.

PERIOD

public static final Key PERIOD

Period key.

FORWARD_SLASH

public static final Key FORWARD_SLASH

Forward Slash key.

ZERO

public static final Key ZERO

0 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.

SEMI_COLON

public static final Key SEMI_COLON

Semi Colon key.

EQUALS

public static final Key EQUALS

Equals key.

A

public static final Key A

A key.

B

public static final Key B

B key.

C

public static final Key C

C key.

D

public static final Key D

D key.

E

public static final Key E

E 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.

I

public static final Key I

I 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.

M

public static final Key M

M key.

N

public static final Key N

N key.

O

public static final Key O

O key.

P

public static final Key P

P key.

Q

public static final Key Q

Q key.

R

public static final Key R

R key.

S

public static final Key S

S key.

T

public static final Key T

T key.

U

public static final Key U

U key.

V

public static final Key V

V key.

W

public static final Key W

W key.

X

public static final Key X

X key.

Y

public static final Key Y

Y key.

Z

public static final Key Z

Z key.

LEFT_BRACKET

public static final Key LEFT_BRACKET

Left Bracket key.

BACKSLASH

public static final Key BACKSLASH

Backslash key.

RIGHT_BRACKET

public static final Key RIGHT_BRACKET

Right Bracket key.

NUM_ZERO

public static final Key NUM_ZERO

Num 0 key.

NUM_ONE

public static final Key NUM_ONE

Num 1 key.

NUM_TWO

public static final Key NUM_TWO

Num 2 key.

NUM_THREE

public static final Key NUM_THREE

Num 3 key.

NUM_FOUR

public static final Key NUM_FOUR

Num 4 key.

NUM_FIVE

public static final Key NUM_FIVE

Num 5 key.

NUM_SIX

public static final Key NUM_SIX

Num 6 key.

NUM_SEVEN

public static final Key NUM_SEVEN

Num 7 key.

NUM_EIGHT

public static final Key NUM_EIGHT

Num 8 key.

NUM_NINE

public static final Key NUM_NINE

Num 9 key.

NUM_MULTIPLY

public static final Key NUM_MULTIPLY

Multiply key.

NUM_PLUS

public static final Key NUM_PLUS

Plus key.

NUM_MINUS

public static final Key NUM_MINUS

Minus key.

NUM_POINT

public static final Key NUM_POINT

Point key.

NUM_DIVIDE

public static final Key NUM_DIVIDE

Divide 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

F8 key.

F10

public static final Key F10

F10 key.

F11

public static final Key F11

F11 key.

F12

public static final Key F12

F12 key.

DELETE

public static final Key DELETE

Delete key.

NUM_LOCK

public static final Key NUM_LOCK

Num Lock key.

INSERT

public static final Key INSERT

Insert key.

BACK_QUOTE

public static final Key BACK_QUOTE

Back Quote key.

SINGLE_QUOTE

public static final Key SINGLE_QUOTE

Single Quote key.

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

getCode

public int getCode()

Returns:

the ASCII code of the Key

getName

public String getName()

Returns:

the display name of the Key