java.lang.Object

java.lang.Enum<Keyboard.Key>

swingtree.input.Keyboard.Key

All Implemented Interfaces:: Serializable, Comparable<Keyboard.Key>, Constable

Enclosing class:: Keyboard

public static enum Keyboard.Key extends Enum<Keyboard.Key>

This enum represents all the keys on the keyboard which can be queried for their current state. This is a mapping of the KeyEvent constants to a more readable and type safe enum.

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

ADD

ALT

Constant for the ALT virtual key.

B

BACK_QUOTE

BACK_SLASH

BACK_SPACE

Constant for the BACK_SPACE virtual key.

C

CANCEL

Constant for the CANCEL virtual key.

CAPS_LOCK

Constant for the CAPS_LOCK virtual key.

CLEAR

Constant for the CLEAR virtual key.

CLOSE_BRACKET

COMMA

Constant for the comma key, ","

CONTROL

Constant for the CONTROL virtual key.

D

DECIMAL

DELETE

DIVIDE

DOWN

Constant for the non-numpad down arrow key.See KeyEvent.VK_DOWN for the underlying key-code.

E

EIGHT

Constant for the "8" key.

END

Constant for the END virtual key.

ENTER

Constant for the ENTER virtual key.

EQUALS

Constant for the equals key, "="

ESCAPE

Constant for the ESCAPE virtual key.

F

F1

F10

F11

F12

F13

F14

F15

F16

F17

F18

F19

F2

F20

F21

F22

F23

F24

F3

F4

F5

F6

F7

F8

F9

FIVE

Constant for the "5" key.

FOUR

Constant for the "4" key.

G

H

HELP

HOME

Constant for the HOME virtual key.

I

INSERT

J

K

L

LEFT

Constant for the non-numpad left arrow key.

M

META

MINUS

Constant for the minus key, "-"

MULTIPLY

N

NINE

Constant for the "9" key.

NONE

This value is used to indicate that the keyCode is unknown.

NUM_LOCK

NUMPAD_0

NUMPAD_1

NUMPAD_2

NUMPAD_3

NUMPAD_4

NUMPAD_5

NUMPAD_6

NUMPAD_7

NUMPAD_8

NUMPAD_9

O

ONE

Constant for the "1" key.

OPEN_BRACKET

P

PAGE_DOWN

Constant for the PAGE_DOWN virtual key.

PAGE_UP

Constant for the PAGE_UP virtual key.

PAUSE

Constant for the PAUSE virtual key.

PERIOD

Constant for the period key, "."

PRINTSCREEN

Q

QUOTE

R

RIGHT

Constant for the non-numpad right arrow key.

S

SCROLL_LOCK

SEMICOLON

Constant for the semicolon key, ";"

SEPARATOR

SEVEN

Constant for the "7" key.

SHIFT

Constant for the SHIFT virtual key.

SIX

Constant for the "6" key.

SLASH

Constant for the forward slash key, "/"

SPACE

Constant for the SPACE virtual key.

SUBTRACT

T

TAB

Constant for the TAB virtual key.

THREE

Constant for the "3" key.

TWO

Constant for the "2" key.

U

UP

Constant for the non-numpad up arrow key.See KeyEvent.VK_U for the underlying key-code.

V

W

X

Y

Z

ZERO

Constant for the "0" key.
Field Summary

Fields

Modifier and Type

Field

Description

final int

code
Method Summary

Modifier and Type

Method

Description

boolean

isPressed()

This method checks if this key is currently pressed on the keyboard by checking if it is in a list of currently pressed keys.

static Keyboard.Key

valueOf(String name)

Returns the enum constant of this class with the specified name.

static Keyboard.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
- NONE
  
  public static final Keyboard.Key NONE
  
  This value is used to indicate that the keyCode is unknown. KEY_TYPED events do not have a keyCode value; this value is used instead. See KeyEvent.VK_UNDEFINED for more information.
- ENTER
  
  public static final Keyboard.Key ENTER
  
  Constant for the ENTER virtual key. See KeyEvent.VK_ENTER for the underlying key-code.
- BACK_SPACE
  
  public static final Keyboard.Key BACK_SPACE
  
  Constant for the BACK_SPACE virtual key. See KeyEvent.VK_BACK_SPACE for the underlying key-code.
- TAB
  
  public static final Keyboard.Key TAB
  
  Constant for the TAB virtual key. See KeyEvent.VK_TAB for the underlying key-code.
- CANCEL
  
  public static final Keyboard.Key CANCEL
  
  Constant for the CANCEL virtual key. See KeyEvent.VK_CANCEL for the underlying key-code.
- CLEAR
  
  public static final Keyboard.Key CLEAR
  
  Constant for the CLEAR virtual key. See KeyEvent.VK_CLEAR for the underlying key-code.
- SHIFT
  
  public static final Keyboard.Key SHIFT
  
  Constant for the SHIFT virtual key. See KeyEvent.VK_SHIFT for the underlying key-code.
- CONTROL
  
  public static final Keyboard.Key CONTROL
  
  Constant for the CONTROL virtual key. See KeyEvent.VK_CONTROL for the underlying key-code.
- ALT
  
  public static final Keyboard.Key ALT
  
  Constant for the ALT virtual key. See KeyEvent.VK_ALT for the underlying key-code.
- PAUSE
  
  public static final Keyboard.Key PAUSE
  
  Constant for the PAUSE virtual key. See KeyEvent.VK_PAUSE for the underlying key-code.
- CAPS_LOCK
  
  public static final Keyboard.Key CAPS_LOCK
  
  Constant for the CAPS_LOCK virtual key. See KeyEvent.VK_CAPS_LOCK for the underlying key-code.
- ESCAPE
  
  public static final Keyboard.Key ESCAPE
  
  Constant for the ESCAPE virtual key. See KeyEvent.VK_ESCAPE for the underlying key-code.
- SPACE
  
  public static final Keyboard.Key SPACE
  
  Constant for the SPACE virtual key. See KeyEvent.VK_SPACE for the underlying key-code.
- PAGE_UP
  
  public static final Keyboard.Key PAGE_UP
  
  Constant for the PAGE_UP virtual key. See KeyEvent.VK_PAGE_UP for the underlying key-code.
- PAGE_DOWN
  
  public static final Keyboard.Key PAGE_DOWN
  
  Constant for the PAGE_DOWN virtual key. See KeyEvent.VK_PAGE_DOWN for the underlying key-code.
- END
  
  public static final Keyboard.Key END
  
  Constant for the END virtual key. See KeyEvent.VK_END for the underlying key-code.
- HOME
  
  public static final Keyboard.Key HOME
  
  Constant for the HOME virtual key. See KeyEvent.VK_HOME for the underlying key-code.
- LEFT
  
  public static final Keyboard.Key LEFT
  
  Constant for the non-numpad left arrow key. See KeyEvent.VK_LEFT for the underlying key-code.
  See Also:
  
  LEFT
- UP
  
  public static final Keyboard.Key UP
  
  Constant for the non-numpad up arrow key.See KeyEvent.VK_U for the underlying key-code.
  See Also:
  
  UP
- RIGHT
  
  public static final Keyboard.Key RIGHT
  
  Constant for the non-numpad right arrow key. See KeyEvent.VK_RIGHT for the underlying key-code.
  See Also:
  
  RIGHT
- DOWN
  
  public static final Keyboard.Key DOWN
  
  Constant for the non-numpad down arrow key.See KeyEvent.VK_DOWN for the underlying key-code.
  See Also:
  
  DOWN
- COMMA
  
  public static final Keyboard.Key COMMA
  
  Constant for the comma key, ","
- MINUS
  
  public static final Keyboard.Key MINUS
  
  Constant for the minus key, "-"
- PERIOD
  
  public static final Keyboard.Key PERIOD
  
  Constant for the period key, "."
- SLASH
  
  public static final Keyboard.Key SLASH
  
  Constant for the forward slash key, "/"
- ZERO
  
  public static final Keyboard.Key ZERO
  
  Constant for the "0" key.
- ONE
  
  public static final Keyboard.Key ONE
  
  Constant for the "1" key.
- TWO
  
  public static final Keyboard.Key TWO
  
  Constant for the "2" key.
- THREE
  
  public static final Keyboard.Key THREE
  
  Constant for the "3" key.
- FOUR
  
  public static final Keyboard.Key FOUR
  
  Constant for the "4" key.
- FIVE
  
  public static final Keyboard.Key FIVE
  
  Constant for the "5" key.
- SIX
  
  public static final Keyboard.Key SIX
  
  Constant for the "6" key.
- SEVEN
  
  public static final Keyboard.Key SEVEN
  
  Constant for the "7" key.
- EIGHT
  
  public static final Keyboard.Key EIGHT
  
  Constant for the "8" key.
- NINE
  
  public static final Keyboard.Key NINE
  
  Constant for the "9" key.
- SEMICOLON
  
  public static final Keyboard.Key SEMICOLON
  
  Constant for the semicolon key, ";"
- EQUALS
  
  public static final Keyboard.Key EQUALS
  
  Constant for the equals key, "="
- A
  
  public static final Keyboard.Key A
- B
  
  public static final Keyboard.Key B
- C
  
  public static final Keyboard.Key C
- D
  
  public static final Keyboard.Key D
- E
  
  public static final Keyboard.Key E
- F
  
  public static final Keyboard.Key F
- G
  
  public static final Keyboard.Key G
- H
  
  public static final Keyboard.Key H
- I
  
  public static final Keyboard.Key I
- J
  
  public static final Keyboard.Key J
- K
  
  public static final Keyboard.Key K
- L
  
  public static final Keyboard.Key L
- M
  
  public static final Keyboard.Key M
- N
  
  public static final Keyboard.Key N
- O
  
  public static final Keyboard.Key O
- P
  
  public static final Keyboard.Key P
- Q
  
  public static final Keyboard.Key Q
- R
  
  public static final Keyboard.Key R
- S
  
  public static final Keyboard.Key S
- T
  
  public static final Keyboard.Key T
- U
  
  public static final Keyboard.Key U
- V
  
  public static final Keyboard.Key V
- W
  
  public static final Keyboard.Key W
- X
  
  public static final Keyboard.Key X
- Y
  
  public static final Keyboard.Key Y
- Z
  
  public static final Keyboard.Key Z
- OPEN_BRACKET
  
  public static final Keyboard.Key OPEN_BRACKET
- BACK_SLASH
  
  public static final Keyboard.Key BACK_SLASH
- CLOSE_BRACKET
  
  public static final Keyboard.Key CLOSE_BRACKET
- NUMPAD_0
  
  public static final Keyboard.Key NUMPAD_0
- NUMPAD_1
  
  public static final Keyboard.Key NUMPAD_1
- NUMPAD_2
  
  public static final Keyboard.Key NUMPAD_2
- NUMPAD_3
  
  public static final Keyboard.Key NUMPAD_3
- NUMPAD_4
  
  public static final Keyboard.Key NUMPAD_4
- NUMPAD_5
  
  public static final Keyboard.Key NUMPAD_5
- NUMPAD_6
  
  public static final Keyboard.Key NUMPAD_6
- NUMPAD_7
  
  public static final Keyboard.Key NUMPAD_7
- NUMPAD_8
  
  public static final Keyboard.Key NUMPAD_8
- NUMPAD_9
  
  public static final Keyboard.Key NUMPAD_9
- MULTIPLY
  
  public static final Keyboard.Key MULTIPLY
- ADD
  
  public static final Keyboard.Key ADD
- SEPARATOR
  
  public static final Keyboard.Key SEPARATOR
- SUBTRACT
  
  public static final Keyboard.Key SUBTRACT
- DECIMAL
  
  public static final Keyboard.Key DECIMAL
- DIVIDE
  
  public static final Keyboard.Key DIVIDE
- DELETE
  
  public static final Keyboard.Key DELETE
- NUM_LOCK
  
  public static final Keyboard.Key NUM_LOCK
- SCROLL_LOCK
  
  public static final Keyboard.Key SCROLL_LOCK
- F1
  
  public static final Keyboard.Key F1
- F2
  
  public static final Keyboard.Key F2
- F3
  
  public static final Keyboard.Key F3
- F4
  
  public static final Keyboard.Key F4
- F5
  
  public static final Keyboard.Key F5
- F6
  
  public static final Keyboard.Key F6
- F7
  
  public static final Keyboard.Key F7
- F8
  
  public static final Keyboard.Key F8
- F9
  
  public static final Keyboard.Key F9
- F10
  
  public static final Keyboard.Key F10
- F11
  
  public static final Keyboard.Key F11
- F12
  
  public static final Keyboard.Key F12
- F13
  
  public static final Keyboard.Key F13
- F14
  
  public static final Keyboard.Key F14
- F15
  
  public static final Keyboard.Key F15
- F16
  
  public static final Keyboard.Key F16
- F17
  
  public static final Keyboard.Key F17
- F18
  
  public static final Keyboard.Key F18
- F19
  
  public static final Keyboard.Key F19
- F20
  
  public static final Keyboard.Key F20
- F21
  
  public static final Keyboard.Key F21
- F22
  
  public static final Keyboard.Key F22
- F23
  
  public static final Keyboard.Key F23
- F24
  
  public static final Keyboard.Key F24
- PRINTSCREEN
  
  public static final Keyboard.Key PRINTSCREEN
- INSERT
  
  public static final Keyboard.Key INSERT
- HELP
  
  public static final Keyboard.Key HELP
- META
  
  public static final Keyboard.Key META
- BACK_QUOTE
  
  public static final Keyboard.Key BACK_QUOTE
- QUOTE
  
  public static final Keyboard.Key QUOTE
Field Details
- code
  
  public final int code
Method Details
- values
  
  public static Keyboard.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 Keyboard.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
- isPressed
  
  public boolean isPressed()
  
  This method checks if this key is currently pressed on the keyboard by checking if it is in a list of currently pressed keys.
  
  Returns:
  
  The truth value determining if this key is currently pressed on the keyboard.

Enum Class Keyboard.Key

Nested Class Summary

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

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Details

NONE

ENTER

BACK_SPACE

TAB

CANCEL

CLEAR

SHIFT

CONTROL

ALT

PAUSE

CAPS_LOCK

ESCAPE

SPACE

PAGE_UP

PAGE_DOWN

END

HOME

LEFT

UP

RIGHT

DOWN

COMMA

MINUS

PERIOD

SLASH

ZERO

ONE

TWO

THREE

FOUR

FIVE

SIX

SEVEN

EIGHT

NINE

SEMICOLON

EQUALS

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

OPEN_BRACKET

BACK_SLASH

CLOSE_BRACKET

NUMPAD_0

NUMPAD_1

NUMPAD_2

NUMPAD_3

NUMPAD_4