Keyboard.Key (JSFML API)

java.lang.Object
- java.lang.Enum<Keyboard.Key>
- - org.jsfml.window.Keyboard.Key

All Implemented Interfaces:

Serializable, Comparable<Keyboard.Key>

Enclosing class:

Keyboard
```
public static enum Keyboard.Key
extends Enum<Keyboard.Key>
```
Enumeration of supported keys.
The keys in this enumeration are named after the standard QWERTY keyboard layout. Their locations and labels may vary on different keyboard layouts, even though the scan codes, and therefore their representation in this enumeration, are the same.
There may be some non-standard keys on certain keyboards that are mapped to unknown scan codes. Those special keys will be represented by UNKNOWN.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`A` The `A` key.
`ADD` The `+` (addition) key on the numeric keypad.
`B` The `B` key.
`BACKSLASH` The `\` key.
`BACKSPACE` The Backspace key.
`C` The `C` key.
`COMMA` The `,` key.
`D` The `D` key.
`DASH` The `-` key.
`DELETE` The Delete key.
`DIVIDE` The `/` (division) key on the numeric keypad.
`DOWN` The down arrow key.
`E` The `E` key.
`END` The End key.
`EQUAL` The `=` key.
`ESCAPE` The escape key.
`F` The `F` key.
`F1` The `F1` key.
`F10` The `F10` key.
`F11` The `F11` key.
`F12` The `F12` key.
`F13` The `F13` key, where available.
`F14` The `F14` key, where available.
`F15` The `F15` key, where available.
`F2` The `F2` key.
`F3` The `F3` key.
`F4` The `F4` key.
`F5` The `F5` key.
`F6` The `F6` key.
`F7` The `F7` key.
`F8` The `F8` key.
`F9` The `F9` key.
`G` The `G` key.
`H` The `H` key.
`HOME` The Home key.
`I` The `I` key.
`INSERT` The Insert key.
`J` The `J` key.
`K` The `K` key.
`L` The `L` key.
`LALT` The left Alt key.
`LBRACKET` The `[` key.
`LCONTROL` The left Ctrl key.
`LEFT` The left arrow key.
`LSHIFT` The left Shift key.
`LSYSTEM` The left system key.
`M` The `M` key.
`MENU` The menu key.
`MULTIPLY` The `*` (multiplication) key on the numeric keypad.
`N` The `N` key.
`NUM0` The `0` key.
`NUM1` The `1` key.
`NUM2` The `2` key.
`NUM3` The `3` key.
`NUM4` The `4` key.
`NUM5` The `5` key.
`NUM6` The `6` key.
`NUM7` The `7` key.
`NUM8` The `8` key.
`NUM9` The `9` key.
`NUMPAD0` The `0` key on the numeric keypad.
`NUMPAD1` The `1` key on the numeric keypad.
`NUMPAD2` The `2` key on the numeric keypad.
`NUMPAD3` The `3` key on the numeric keypad.
`NUMPAD4` The `4` key on the numeric keypad.
`NUMPAD5` The `5` key on the numeric keypad.
`NUMPAD6` The `6` key on the numeric keypad.
`NUMPAD7` The `7` key on the numeric keypad.
`NUMPAD8` The `8` key on the numeric keypad.
`NUMPAD9` The `9` key on the numeric keypad.
`O` The `O` key.
`P` The `P` key.
`PAGEDOWN` The Page down key.
`PAGEUP` The Page up key.
`PAUSE` The Pause key.
`PERIOD` `.` key.
`Q` The `Q` key.
`QUOTE` The `'` key.
`R` The `R` key.
`RALT` The right Alt key.
`RBRACKET` The `]` key.
`RCONTROL` The right Ctrl key.
`RETURN` The Return key or the Enter key on the numeric keypad.
`RIGHT` The right arrow key.
`RSHIFT` The right Shift key.
`RSYSTEM` The right system key.
`S` The `S` key.
`SEMICOLON` The `;` key.
`SLASH` The `/` key.
`SPACE` The Space key.
`SUBTRACT` The `-` (subtraction) key on the numeric keypad.
`T` The `T` key.
`TAB` The Tab key.
`TILDE` The `~` key.
`U` The `U` key.
`UNKNOWN` A keyboard specific key which maps to an unknown scan code.
`UP` The up arrow key.
`V` The `V` key.
`W` The `W` key.
`X` The `X` key.
`Y` The `Y` key.
`Z` The `Z` key.

Method Summary

Methods
Modifier and Type	Method and Description
`static Keyboard.Key`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static Keyboard.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

UNKNOWN
```
public static final Keyboard.Key UNKNOWN
```
A keyboard specific key which maps to an unknown scan code.

A
```
public static final Keyboard.Key A
```
The A key.

B
```
public static final Keyboard.Key B
```
The B key.

C
```
public static final Keyboard.Key C
```
The C key.

D
```
public static final Keyboard.Key D
```
The D key.

E
```
public static final Keyboard.Key E
```
The E key.

F
```
public static final Keyboard.Key F
```
The F key.

G
```
public static final Keyboard.Key G
```
The G key.

H
```
public static final Keyboard.Key H
```
The H key.

I
```
public static final Keyboard.Key I
```
The I key.

J
```
public static final Keyboard.Key J
```
The J key.

K
```
public static final Keyboard.Key K
```
The K key.

L
```
public static final Keyboard.Key L
```
The L key.

M
```
public static final Keyboard.Key M
```
The M key.

N
```
public static final Keyboard.Key N
```
The N key.

O
```
public static final Keyboard.Key O
```
The O key.

P
```
public static final Keyboard.Key P
```
The P key.

Q
```
public static final Keyboard.Key Q
```
The Q key.

R
```
public static final Keyboard.Key R
```
The R key.

S
```
public static final Keyboard.Key S
```
The S key.

T
```
public static final Keyboard.Key T
```
The T key.

U
```
public static final Keyboard.Key U
```
The U key.

V
```
public static final Keyboard.Key V
```
The V key.

W
```
public static final Keyboard.Key W
```
The W key.

X
```
public static final Keyboard.Key X
```
The X key.

Y
```
public static final Keyboard.Key Y
```
The Y key.

Z
```
public static final Keyboard.Key Z
```
The Z key.

NUM0
```
public static final Keyboard.Key NUM0
```
The 0 key. For the 0 key on the numeric keypad, see NUMPAD0.

NUM1
```
public static final Keyboard.Key NUM1
```
The 1 key. For the 1 key on the numeric keypad, see NUMPAD1.

NUM2
```
public static final Keyboard.Key NUM2
```
The 2 key. For the 2 key on the numeric keypad, see NUMPAD2.

NUM3
```
public static final Keyboard.Key NUM3
```
The 3 key. For the 3 key on the numeric keypad, see NUMPAD3.

NUM4
```
public static final Keyboard.Key NUM4
```
The 4 key. For the 4 key on the numeric keypad, see NUMPAD4.

NUM5
```
public static final Keyboard.Key NUM5
```
The 5 key. For the 5 key on the numeric keypad, see NUMPAD5.

NUM6
```
public static final Keyboard.Key NUM6
```
The 6 key. For the 6 key on the numeric keypad, see NUMPAD6.

NUM7
```
public static final Keyboard.Key NUM7
```
The 7 key. For the 7 key on the numeric keypad, see NUMPAD7.

NUM8
```
public static final Keyboard.Key NUM8
```
The 8 key. For the 8 key on the numeric keypad, see NUMPAD8.

NUM9
```
public static final Keyboard.Key NUM9
```
The 9 key. For the 9 key on the numeric keypad, see NUMPAD9.

ESCAPE

public static final Keyboard.Key ESCAPE

The escape key.

LCONTROL

public static final Keyboard.Key LCONTROL

The left Ctrl key.

LSHIFT

public static final Keyboard.Key LSHIFT

The left Shift key.

LALT
```
public static final Keyboard.Key LALT
```
The left Alt key.

LSYSTEM
```
public static final Keyboard.Key LSYSTEM
```
The left system key. This is commonly known as the Windows logo key or the Apple key.

RCONTROL

public static final Keyboard.Key RCONTROL

The right Ctrl key.

RSHIFT

public static final Keyboard.Key RSHIFT

The right Shift key.

RALT
```
public static final Keyboard.Key RALT
```
The right Alt key.

RSYSTEM
```
public static final Keyboard.Key RSYSTEM
```
The right system key. This is commonly known as the Windows logo key or the Apple key.

MENU
```
public static final Keyboard.Key MENU
```
The menu key.

LBRACKET

public static final Keyboard.Key LBRACKET

The [ key.

RBRACKET

public static final Keyboard.Key RBRACKET

The ] key.

SEMICOLON

public static final Keyboard.Key SEMICOLON

The ; key.

COMMA
```
public static final Keyboard.Key COMMA
```
The , key.

PERIOD

public static final Keyboard.Key PERIOD

. key.

QUOTE
```
public static final Keyboard.Key QUOTE
```
The ' key.

SLASH
```
public static final Keyboard.Key SLASH
```
The / key.

BACKSLASH

public static final Keyboard.Key BACKSLASH

The \ key.

TILDE
```
public static final Keyboard.Key TILDE
```
The ~ key.

EQUAL
```
public static final Keyboard.Key EQUAL
```
The = key.

DASH
```
public static final Keyboard.Key DASH
```
The - key.

SPACE
```
public static final Keyboard.Key SPACE
```
The Space key.

RETURN
```
public static final Keyboard.Key RETURN
```
The Return key or the Enter key on the numeric keypad. Both keys send the same scancode and can therefore not be distinguished.

BACKSPACE

public static final Keyboard.Key BACKSPACE

The Backspace key.

TAB
```
public static final Keyboard.Key TAB
```
The Tab key.

PAGEUP

public static final Keyboard.Key PAGEUP

The Page up key.

PAGEDOWN

public static final Keyboard.Key PAGEDOWN

The Page down key.

END
```
public static final Keyboard.Key END
```
The End key.

HOME
```
public static final Keyboard.Key HOME
```
The Home key.

INSERT

public static final Keyboard.Key INSERT

The Insert key.

DELETE

public static final Keyboard.Key DELETE

The Delete key.

ADD
```
public static final Keyboard.Key ADD
```
The + (addition) key on the numeric keypad.

SUBTRACT
```
public static final Keyboard.Key SUBTRACT
```
The - (subtraction) key on the numeric keypad.

MULTIPLY
```
public static final Keyboard.Key MULTIPLY
```
The * (multiplication) key on the numeric keypad.

DIVIDE
```
public static final Keyboard.Key DIVIDE
```
The / (division) key on the numeric keypad.

LEFT
```
public static final Keyboard.Key LEFT
```
The left arrow key.

RIGHT
```
public static final Keyboard.Key RIGHT
```
The right arrow key.

UP
```
public static final Keyboard.Key UP
```
The up arrow key.

DOWN
```
public static final Keyboard.Key DOWN
```
The down arrow key.

NUMPAD0
```
public static final Keyboard.Key NUMPAD0
```
The 0 key on the numeric keypad. For the regular 0 key, see NUM0.

NUMPAD1
```
public static final Keyboard.Key NUMPAD1
```
The 1 key on the numeric keypad. For the regular 1 key, see NUM1.

NUMPAD2
```
public static final Keyboard.Key NUMPAD2
```
The 2 key on the numeric keypad. For the regular 2 key, see NUM2.

NUMPAD3
```
public static final Keyboard.Key NUMPAD3
```
The 3 key on the numeric keypad. For the regular 3 key, see NUM3.

NUMPAD4
```
public static final Keyboard.Key NUMPAD4
```
The 4 key on the numeric keypad. For the regular 4 key, see NUM4.

NUMPAD5
```
public static final Keyboard.Key NUMPAD5
```
The 5 key on the numeric keypad. For the regular 5 key, see NUM5.

NUMPAD6
```
public static final Keyboard.Key NUMPAD6
```
The 6 key on the numeric keypad. For the regular 6 key, see NUM6.

NUMPAD7
```
public static final Keyboard.Key NUMPAD7
```
The 7 key on the numeric keypad. For the regular 7 key, see NUM7.

NUMPAD8
```
public static final Keyboard.Key NUMPAD8
```
The 8 key on the numeric keypad. For the regular 8 key, see NUM8.

NUMPAD9
```
public static final Keyboard.Key NUMPAD9
```
The 9 key on the numeric keypad. For the regular 9 key, see NUM9.

F1
```
public static final Keyboard.Key F1
```
The F1 key.

F2
```
public static final Keyboard.Key F2
```
The F2 key.

F3
```
public static final Keyboard.Key F3
```
The F3 key.

F4
```
public static final Keyboard.Key F4
```
The F4 key.

F5
```
public static final Keyboard.Key F5
```
The F5 key.

F6
```
public static final Keyboard.Key F6
```
The F6 key.

F7
```
public static final Keyboard.Key F7
```
The F7 key.

F8
```
public static final Keyboard.Key F8
```
The F8 key.

F9
```
public static final Keyboard.Key F9
```
The F9 key.

F10
```
public static final Keyboard.Key F10
```
The F10 key.

F11
```
public static final Keyboard.Key F11
```
The F11 key.

F12
```
public static final Keyboard.Key F12
```
The F12 key.

F13
```
public static final Keyboard.Key F13
```
The F13 key, where available.

F14
```
public static final Keyboard.Key F14
```
The F14 key, where available.

F15
```
public static final Keyboard.Key F15
```
The F15 key, where available.

PAUSE
```
public static final Keyboard.Key PAUSE
```
The Pause key.

Method Detail
- values
```
public static Keyboard.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 (Keyboard.Key c : Keyboard.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 Keyboard.Key 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

Enum Keyboard.Key

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

UNKNOWN

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

NUM0

NUM1

NUM2

NUM3

NUM4

NUM5

NUM6

NUM7

NUM8

NUM9

ESCAPE

LCONTROL

LSHIFT

LALT

LSYSTEM

RCONTROL

RSHIFT

RALT

RSYSTEM

MENU

LBRACKET

RBRACKET

SEMICOLON

COMMA

PERIOD

QUOTE

SLASH

BACKSLASH

TILDE

EQUAL

DASH

SPACE

RETURN

BACKSPACE

TAB

PAGEUP

PAGEDOWN

END

HOME

INSERT

DELETE

ADD

SUBTRACT

MULTIPLY

DIVIDE

LEFT

RIGHT