Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD DETAIL: ENUM CONSTANTS | FIELD | METHOD

org.scijava.input
Enum KeyCode

java.lang.Object
  extended by java.lang.Enum<KeyCode>
      extended by org.scijava.input.KeyCode
All Implemented Interfaces:
Serializable, Comparable<KeyCode>
public enum KeyCode
extends Enum<KeyCode>

A UI-independent enumeration of keyboard key codes.

Author:
Curtis Rueden

Enum Constant Summary
A
          The letter A.
ACCEPT
          Accept or Commit function key.
AGAIN
          Again (Sun keyboard).
ALL_CANDIDATES
          All Candidates function key.
ALPHANUMERIC
          Alphanumeric function key.
ALT
          Alt (left or right).
ALT_GRAPH
          AltGraph function key.
AMPERSAND
          Ampersand ('&').
ASTERISK
          Asterisk ('*').
AT
          At sign ('@').
B
          The letter B.
BACK_QUOTE
          Backquote ('`').
BACK_SLASH
          Backslash ('\\').
BACK_SPACE
          Backspace.
BEGIN
          Begin key.
BRACELEFT
          Left curly brace ('{').
BRACERIGHT
          Right curly brace ('}').
C
          The letter C.
CANCEL
          Cancel.
CAPS_LOCK
          Caps Lock.
CIRCUMFLEX
          Caret ('^').
CLEAR
          Clear.
CLOSE_BRACKET
          Right bracket (']').
CODE_INPUT
          Code Input function key.
COLON
          Colon (':').
COMMA
          Comma (',').
COMPOSE
          Compose function key.
CONTEXT_MENU
          Windows Context Menu key.
CONTROL
          Control (left or right).
CONVERT
          Convert function key.
COPY
          Copy (Sun keyboard).
CUT
          Cut (Sun keyboard).
D
          The letter D.
DEAD_ABOVEDOT
          TODO.
DEAD_ABOVERING
          TODO.
DEAD_ACUTE
          TODO.
DEAD_BREVE
          TODO.
DEAD_CARON
          TODO.
DEAD_CEDILLA
          TODO.
DEAD_CIRCUMFLEX
          TODO.
DEAD_DIAERESIS
          TODO.
DEAD_DOUBLEACUTE
          TODO.
DEAD_GRAVE
          TODO.
DEAD_IOTA
          TODO.
DEAD_MACRON
          TODO.
DEAD_OGONEK
          TODO.
DEAD_SEMIVOICED_SOUND
          TODO.
DEAD_TILDE
          TODO.
DEAD_VOICED_SOUND
          TODO.
DELETE
          Delete (non-numpad).
DOLLAR
          Dollar sign ('$').
DOWN
          Down arrow (non-numpad).
E
          The letter E.
END
          End.
ENTER
          Enter (a.k.a.
EQUALS
          Equals ('=').
ESCAPE
          Escape.
EURO_SIGN
          Euro sign.
EXCLAMATION_MARK
          Bang ('!').
F
          The letter F.
F1
          F1.
F10
          F10.
F11
          F11.
F12
          F12.
F13
          F13.
F14
          F14.
F15
          F15.
F16
          F16.
F17
          F17.
F18
          F18
F19
          F19.
F2
          F2.
F20
          F20.
F21
          F21.
F22
          F22.
F23
          F23.
F24
          F24.
F3
          F3.
F4
          F4.
F5
          F5.
F6
          F6.
F7
          F7.
F8
          F8.
F9
          F9.
FINAL
           
FIND
          Find (Sun keyboard).
FULL_WIDTH
          Full-Width Characters function key.
G
          The letter G.
GREATER
          Greater than ('>').
H
          The letter H.
HALF_WIDTH
          Half-Width Characters function key.
HELP
          Help.
HIRAGANA
          Hiragana function key.
HOME
          Home.
I
          The letter I.
INPUT_METHOD_ON_OFF
          Input method on/off key.
INSERT
          Insert.
INVERTED_EXCLAMATION_MARK
          Inverted bang.
J
          The letter J.
JAPANESE_HIRAGANA
          Japanese-Hiragana function key.
JAPANESE_KATAKANA
          Japanese-Katakana function key.
JAPANESE_ROMAN
          Japanese-Roman function key.
K
          The letter K.
KANA
           
KANA_LOCK
          Locking Kana function key.
KANJI
           
KATAKANA
          Katakana function key.
KP_DOWN
          Down arrow on numeric keypad.
KP_LEFT
          Left arrow on numeric keypad.
KP_RIGHT
          Right arrow on numeric keypad.
KP_UP
          Up arrow on numeric keypad.
L
          The letter L.
LEFT
          Left arrow (non-numpad).
LEFT_PARENTHESIS
          Left parenthesis ('(').
LESS
          Less than ('<').
M
          The letter M.
META
          Meta.
MINUS
          Minus ('-').
MODECHANGE
           
N
          The letter N.
NONCONVERT
          Don't Convert function key.
NUM_LOCK
          Num Lock.
NUM0
          Zero ('0', non-numpad).
NUM1
          One ('1', non-numpad).
NUM2
          Two ('2', non-numpad).
NUM3
          Three ('3', non-numpad).
NUM4
          Four ('4', non-numpad).
NUM5
          Five ('5', non-numpad).
NUM6
          Six ('6', non-numpad).
NUM7
          Seven ('7', non-numpad).
NUM8
          Eight ('8', non-numpad).
NUM9
          Nine ('9', non-numpad).
NUMBER_SIGN
          Pound sign ('#').
NUMPAD_0
          Zero ('0') on numeric keypad.
NUMPAD_1
          One ('1') on numeric keypad.
NUMPAD_2
          Two ('2') on numeric keypad.
NUMPAD_3
          Three ('3') on numeric keypad.
NUMPAD_4
          Four ('4') on numeric keypad.
NUMPAD_5
          Five ('5') on numeric keypad.
NUMPAD_6
          Six ('6') on numeric keypad.
NUMPAD_7
          Seven ('7') on numeric keypad.
NUMPAD_8
          Eight ('8') on numeric keypad.
NUMPAD_9
          Nine ('9') on numeric keypad.
NUMPAD_ASTERISK
          Asterisk ('*') on numeric keypad.
NUMPAD_MINUS
          Minus ('-') on numeric keypad.
NUMPAD_PERIOD
          Period ('.') on numeric keypad.
NUMPAD_PLUS
          Plus ('+') on numeric keypad.
NUMPAD_SEPARATOR
           
NUMPAD_SLASH
          Slash ('/') on numeric keypad.
O
          The letter O.
OPEN_BRACKET
          Left bracket ('[').
P
          The letter P.
PAGE_DOWN
          Page Down.
PAGE_UP
          Page Up.
PASTE
          Paste (Sun keyboard).
PAUSE
          Pause.
PERIOD
          Period ('.').
PLUS
          Plus ('+').
PREVIOUS_CANDIDATE
          Previous Candidate function key.
PRINTSCREEN
          Print Screen.
PROPS
          Props (Sun keyboard).
Q
          The letter Q.
QUOTE
          Single quote ('\'').
QUOTEDBL
          Double quote ('"').
R
          The letter R.
RIGHT
          Right arrow (non-numpad).
RIGHT_PARENTHESIS
          Right parenthesis (')').
ROMAN_CHARACTERS
          Roman Characters function key.
S
          The letter S.
SCROLL_LOCK
          Scroll Lock.
SEMICOLON
          Semicolon (';').
SHIFT
          Shift (left or right).
SLASH
          Forward slash ('/').
SPACE
          Space (' ').
STOP
          Stop (Sun keyboard).
T
          The letter T.
TAB
          Tab.
U
          The letter U.
UNDEFINED
          Unknown code.
UNDERSCORE
          Underscore ('_').
UNDO
          Undo (Sun keyboard).
UP
          Up arrow (non-numpad).
V
          The letter V.
W
          The letter W.
WINDOWS
          Windows key (both left and right).
X
          The letter X.
Y
          The letter Y.
Z
          The letter Z.
 
Method Summary
static KeyCode get(int code)
          Gets the KeyCode corresponding to the given numeric code, or UNDEFINED if no such code.
static KeyCode get(String name)
          Gets the KeyCode with the given name, or UNDEFINED if no such code.
 int getCode()
          Gets the key's numeric code.
static KeyCode valueOf(String name)
          Returns the enum constant of this type with the specified name.
static KeyCode[] 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

ENTER

public static final KeyCode ENTER
Enter (a.k.a. Return).

BACK_SPACE

public static final KeyCode BACK_SPACE
Backspace.

TAB

public static final KeyCode TAB
Tab.

CANCEL

public static final KeyCode CANCEL
Cancel.

CLEAR

public static final KeyCode CLEAR
Clear.

SHIFT

public static final KeyCode SHIFT
Shift (left or right).

CONTROL

public static final KeyCode CONTROL
Control (left or right).

ALT

public static final KeyCode ALT
Alt (left or right).

PAUSE

public static final KeyCode PAUSE
Pause.

CAPS_LOCK

public static final KeyCode CAPS_LOCK
Caps Lock.

ESCAPE

public static final KeyCode ESCAPE
Escape.

SPACE

public static final KeyCode SPACE
Space (' ').

PAGE_UP

public static final KeyCode PAGE_UP
Page Up.

PAGE_DOWN

public static final KeyCode PAGE_DOWN
Page Down.

END

public static final KeyCode END
End.

HOME

public static final KeyCode HOME
Home.

LEFT

public static final KeyCode LEFT
Left arrow (non-numpad).

UP

public static final KeyCode UP
Up arrow (non-numpad).

RIGHT

public static final KeyCode RIGHT
Right arrow (non-numpad).

DOWN

public static final KeyCode DOWN
Down arrow (non-numpad).

COMMA

public static final KeyCode COMMA
Comma (',').

MINUS

public static final KeyCode MINUS
Minus ('-').

PERIOD

public static final KeyCode PERIOD
Period ('.').

SLASH

public static final KeyCode SLASH
Forward slash ('/').

NUM0

public static final KeyCode NUM0
Zero ('0', non-numpad).

NUM1

public static final KeyCode NUM1
One ('1', non-numpad).

NUM2

public static final KeyCode NUM2
Two ('2', non-numpad).

NUM3

public static final KeyCode NUM3
Three ('3', non-numpad).

NUM4

public static final KeyCode NUM4
Four ('4', non-numpad).

NUM5

public static final KeyCode NUM5
Five ('5', non-numpad).

NUM6

public static final KeyCode NUM6
Six ('6', non-numpad).

NUM7

public static final KeyCode NUM7
Seven ('7', non-numpad).

NUM8

public static final KeyCode NUM8
Eight ('8', non-numpad).

NUM9

public static final KeyCode NUM9
Nine ('9', non-numpad).

SEMICOLON

public static final KeyCode SEMICOLON
Semicolon (';').

EQUALS

public static final KeyCode EQUALS
Equals ('=').

A

public static final KeyCode A
The letter A.

B

public static final KeyCode B
The letter B.

C

public static final KeyCode C
The letter C.

D

public static final KeyCode D
The letter D.

E

public static final KeyCode E
The letter E.

F

public static final KeyCode F
The letter F.

G

public static final KeyCode G
The letter G.

H

public static final KeyCode H
The letter H.

I

public static final KeyCode I
The letter I.

J

public static final KeyCode J
The letter J.

K

public static final KeyCode K
The letter K.

L

public static final KeyCode L
The letter L.

M

public static final KeyCode M
The letter M.

N

public static final KeyCode N
The letter N.

O

public static final KeyCode O
The letter O.

P

public static final KeyCode P
The letter P.

Q

public static final KeyCode Q
The letter Q.

R

public static final KeyCode R
The letter R.

S

public static final KeyCode S
The letter S.

T

public static final KeyCode T
The letter T.

U

public static final KeyCode U
The letter U.

V

public static final KeyCode V
The letter V.

W

public static final KeyCode W
The letter W.

X

public static final KeyCode X
The letter X.

Y

public static final KeyCode Y
The letter Y.

Z

public static final KeyCode Z
The letter Z.

OPEN_BRACKET

public static final KeyCode OPEN_BRACKET
Left bracket ('[').

BACK_SLASH

public static final KeyCode BACK_SLASH
Backslash ('\\').

CLOSE_BRACKET

public static final KeyCode CLOSE_BRACKET
Right bracket (']').

NUMPAD_0

public static final KeyCode NUMPAD_0
Zero ('0') on numeric keypad.

NUMPAD_1

public static final KeyCode NUMPAD_1
One ('1') on numeric keypad.

NUMPAD_2

public static final KeyCode NUMPAD_2
Two ('2') on numeric keypad.

NUMPAD_3

public static final KeyCode NUMPAD_3
Three ('3') on numeric keypad.

NUMPAD_4

public static final KeyCode NUMPAD_4
Four ('4') on numeric keypad.

NUMPAD_5

public static final KeyCode NUMPAD_5
Five ('5') on numeric keypad.

NUMPAD_6

public static final KeyCode NUMPAD_6
Six ('6') on numeric keypad.

NUMPAD_7

public static final KeyCode NUMPAD_7
Seven ('7') on numeric keypad.

NUMPAD_8

public static final KeyCode NUMPAD_8
Eight ('8') on numeric keypad.

NUMPAD_9

public static final KeyCode NUMPAD_9
Nine ('9') on numeric keypad.

NUMPAD_ASTERISK

public static final KeyCode NUMPAD_ASTERISK
Asterisk ('*') on numeric keypad.

NUMPAD_PLUS

public static final KeyCode NUMPAD_PLUS
Plus ('+') on numeric keypad.

NUMPAD_SEPARATOR

public static final KeyCode NUMPAD_SEPARATOR

NUMPAD_MINUS

public static final KeyCode NUMPAD_MINUS
Minus ('-') on numeric keypad.

NUMPAD_PERIOD

public static final KeyCode NUMPAD_PERIOD
Period ('.') on numeric keypad.

NUMPAD_SLASH

public static final KeyCode NUMPAD_SLASH
Slash ('/') on numeric keypad.

DELETE

public static final KeyCode DELETE
Delete (non-numpad).

NUM_LOCK

public static final KeyCode NUM_LOCK
Num Lock.

SCROLL_LOCK

public static final KeyCode SCROLL_LOCK
Scroll Lock.

F1

public static final KeyCode F1
F1.

F2

public static final KeyCode F2
F2.

F3

public static final KeyCode F3
F3.

F4

public static final KeyCode F4
F4.

F5

public static final KeyCode F5
F5.

F6

public static final KeyCode F6
F6.

F7

public static final KeyCode F7
F7.

F8

public static final KeyCode F8
F8.

F9

public static final KeyCode F9
F9.

F10

public static final KeyCode F10
F10.

F11

public static final KeyCode F11
F11.

F12

public static final KeyCode F12
F12.

F13

public static final KeyCode F13
F13.

F14

public static final KeyCode F14
F14.

F15

public static final KeyCode F15
F15.

F16

public static final KeyCode F16
F16.

F17

public static final KeyCode F17
F17.

F18

public static final KeyCode F18
F18

F19

public static final KeyCode F19
F19.

F20

public static final KeyCode F20
F20.

F21

public static final KeyCode F21
F21.

F22

public static final KeyCode F22
F22.

F23

public static final KeyCode F23
F23.

F24

public static final KeyCode F24
F24.

PRINTSCREEN

public static final KeyCode PRINTSCREEN
Print Screen.

INSERT

public static final KeyCode INSERT
Insert.

HELP

public static final KeyCode HELP
Help.

META

public static final KeyCode META
Meta.

BACK_QUOTE

public static final KeyCode BACK_QUOTE
Backquote ('`').

QUOTE

public static final KeyCode QUOTE
Single quote ('\'').

KP_UP

public static final KeyCode KP_UP
Up arrow on numeric keypad.

KP_DOWN

public static final KeyCode KP_DOWN
Down arrow on numeric keypad.

KP_LEFT

public static final KeyCode KP_LEFT
Left arrow on numeric keypad.

KP_RIGHT

public static final KeyCode KP_RIGHT
Right arrow on numeric keypad.

DEAD_GRAVE

public static final KeyCode DEAD_GRAVE
TODO.

DEAD_ACUTE

public static final KeyCode DEAD_ACUTE
TODO.

DEAD_CIRCUMFLEX

public static final KeyCode DEAD_CIRCUMFLEX
TODO.

DEAD_TILDE

public static final KeyCode DEAD_TILDE
TODO.

DEAD_MACRON

public static final KeyCode DEAD_MACRON
TODO.

DEAD_BREVE

public static final KeyCode DEAD_BREVE
TODO.

DEAD_ABOVEDOT

public static final KeyCode DEAD_ABOVEDOT
TODO.

DEAD_DIAERESIS

public static final KeyCode DEAD_DIAERESIS
TODO.

DEAD_ABOVERING

public static final KeyCode DEAD_ABOVERING
TODO.

DEAD_DOUBLEACUTE

public static final KeyCode DEAD_DOUBLEACUTE
TODO.

DEAD_CARON

public static final KeyCode DEAD_CARON
TODO.

DEAD_CEDILLA

public static final KeyCode DEAD_CEDILLA
TODO.

DEAD_OGONEK

public static final KeyCode DEAD_OGONEK
TODO.

DEAD_IOTA

public static final KeyCode DEAD_IOTA
TODO.

DEAD_VOICED_SOUND

public static final KeyCode DEAD_VOICED_SOUND
TODO.

DEAD_SEMIVOICED_SOUND

public static final KeyCode DEAD_SEMIVOICED_SOUND
TODO.

AMPERSAND

public static final KeyCode AMPERSAND
Ampersand ('&').

ASTERISK

public static final KeyCode ASTERISK
Asterisk ('*').

QUOTEDBL

public static final KeyCode QUOTEDBL
Double quote ('"').

LESS

public static final KeyCode LESS
Less than ('<').

GREATER

public static final KeyCode GREATER
Greater than ('>').

BRACELEFT

public static final KeyCode BRACELEFT
Left curly brace ('{').

BRACERIGHT

public static final KeyCode BRACERIGHT
Right curly brace ('}').

AT

public static final KeyCode AT
At sign ('@').

COLON

public static final KeyCode COLON
Colon (':').

CIRCUMFLEX

public static final KeyCode CIRCUMFLEX
Caret ('^').

DOLLAR

public static final KeyCode DOLLAR
Dollar sign ('$').

EURO_SIGN

public static final KeyCode EURO_SIGN
Euro sign.

EXCLAMATION_MARK

public static final KeyCode EXCLAMATION_MARK
Bang ('!').

INVERTED_EXCLAMATION_MARK

public static final KeyCode INVERTED_EXCLAMATION_MARK
Inverted bang.

LEFT_PARENTHESIS

public static final KeyCode LEFT_PARENTHESIS
Left parenthesis ('(').

NUMBER_SIGN

public static final KeyCode NUMBER_SIGN
Pound sign ('#').

PLUS

public static final KeyCode PLUS
Plus ('+').

RIGHT_PARENTHESIS

public static final KeyCode RIGHT_PARENTHESIS
Right parenthesis (')').

UNDERSCORE

public static final KeyCode UNDERSCORE
Underscore ('_').

WINDOWS

public static final KeyCode WINDOWS
Windows key (both left and right).

CONTEXT_MENU

public static final KeyCode CONTEXT_MENU
Windows Context Menu key.

FINAL

public static final KeyCode FINAL

CONVERT

public static final KeyCode CONVERT
Convert function key.

NONCONVERT

public static final KeyCode NONCONVERT
Don't Convert function key.

ACCEPT

public static final KeyCode ACCEPT
Accept or Commit function key.

MODECHANGE

public static final KeyCode MODECHANGE

KANA

public static final KeyCode KANA

KANJI

public static final KeyCode KANJI

ALPHANUMERIC

public static final KeyCode ALPHANUMERIC
Alphanumeric function key.

KATAKANA

public static final KeyCode KATAKANA
Katakana function key.

HIRAGANA

public static final KeyCode HIRAGANA
Hiragana function key.

FULL_WIDTH

public static final KeyCode FULL_WIDTH
Full-Width Characters function key.

HALF_WIDTH

public static final KeyCode HALF_WIDTH
Half-Width Characters function key.

ROMAN_CHARACTERS

public static final KeyCode ROMAN_CHARACTERS
Roman Characters function key.

ALL_CANDIDATES

public static final KeyCode ALL_CANDIDATES
All Candidates function key.

PREVIOUS_CANDIDATE

public static final KeyCode PREVIOUS_CANDIDATE
Previous Candidate function key.

CODE_INPUT

public static final KeyCode CODE_INPUT
Code Input function key.

JAPANESE_KATAKANA

public static final KeyCode JAPANESE_KATAKANA
Japanese-Katakana function key.

JAPANESE_HIRAGANA

public static final KeyCode JAPANESE_HIRAGANA
Japanese-Hiragana function key.

JAPANESE_ROMAN

public static final KeyCode JAPANESE_ROMAN
Japanese-Roman function key.

KANA_LOCK

public static final KeyCode KANA_LOCK
Locking Kana function key.

INPUT_METHOD_ON_OFF

public static final KeyCode INPUT_METHOD_ON_OFF
Input method on/off key.

CUT

public static final KeyCode CUT
Cut (Sun keyboard).

COPY

public static final KeyCode COPY
Copy (Sun keyboard).

PASTE

public static final KeyCode PASTE
Paste (Sun keyboard).

UNDO

public static final KeyCode UNDO
Undo (Sun keyboard).

AGAIN

public static final KeyCode AGAIN
Again (Sun keyboard).

FIND

public static final KeyCode FIND
Find (Sun keyboard).

PROPS

public static final KeyCode PROPS
Props (Sun keyboard).

STOP

public static final KeyCode STOP
Stop (Sun keyboard).

COMPOSE

public static final KeyCode COMPOSE
Compose function key.

ALT_GRAPH

public static final KeyCode ALT_GRAPH
AltGraph function key.

BEGIN

public static final KeyCode BEGIN
Begin key.

UNDEFINED

public static final KeyCode UNDEFINED
Unknown code.

Method Detail

values

public static KeyCode[] 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 (KeyCode c : KeyCode.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static KeyCode 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

getCode

public int getCode()
Gets the key's numeric code.

get

public static KeyCode get(int code)
Gets the KeyCode corresponding to the given numeric code, or UNDEFINED if no such code.

get

public static KeyCode get(String name)
Gets the KeyCode with the given name, or UNDEFINED if no such code.

Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD DETAIL: ENUM CONSTANTS | FIELD | METHOD
Copyright © 2009–2015 SciJava. All rights reserved.