KeyCode (LuciadCPillar Java Android API documentation)

java.lang.Object
- com.luciad.input.KeyCode

```
public class KeyCode
extends Object
```
Represents a key in the controller API.

See Also:

KeyCode#KeyCode, ModifierKeys

Field Summary

Fields
Modifier and Type	Field and Description
`static KeyCode`	`A` A key code representing the 'A' key.
`static KeyCode`	`Asterisk` A key code representing the '*' key.
`static KeyCode`	`B` A key code representing the 'B' key.
`static KeyCode`	`Backspace` A key code representing the backspace key.
`static KeyCode`	`C` A key code representing the 'C' key.
`static KeyCode`	`D` A key code representing the 'D' key.
`static KeyCode`	`Down` A key code representing the down key.
`static KeyCode`	`E` A key code representing the 'E' key.
`static KeyCode`	`Eight` A key code representing the '8' key.
`static KeyCode`	`End` A key code representing the end key.
`static KeyCode`	`Escape` A key code representing the escape key.
`static KeyCode`	`F` A key code representing the 'F' key.
`static KeyCode`	`Five` A key code representing the '5' key.
`static KeyCode`	`Four` A key code representing the '4' key.
`static KeyCode`	`G` A key code representing the 'G' key.
`static KeyCode`	`H` A key code representing the 'H' key.
`static KeyCode`	`Home` A key code representing the home key.
`static KeyCode`	`I` A key code representing the 'I' key.
`static KeyCode`	`J` A key code representing the 'J' key.
`static KeyCode`	`K` A key code representing the 'K' key.
`static KeyCode`	`L` A key code representing the 'L' key.
`static KeyCode`	`Left` A key code representing the left key.
`static KeyCode`	`M` A key code representing the 'M' key.
`static KeyCode`	`Minus` A key code representing the '-' key.
`static KeyCode`	`N` A key code representing the 'N' key.
`static KeyCode`	`Nine` A key code representing the '9' key.
`static KeyCode`	`O` A key code representing the 'O' key.
`static KeyCode`	`One` A key code representing the '1' key.
`static KeyCode`	`P` A key code representing the 'P' key.
`static KeyCode`	`PageDown` A key code representing the page down key.
`static KeyCode`	`PageUp` A key code representing the pacge up key.
`static KeyCode`	`Plus` A key code representing the '+' key.
`static KeyCode`	`Q` A key code representing the 'Q' key.
`static KeyCode`	`R` A key code representing the 'R' key.
`static KeyCode`	`Right` A key code representing the right key.
`static KeyCode`	`S` A key code representing the 'S' key.
`static KeyCode`	`Seven` A key code representing the '7' key.
`static KeyCode`	`Six` A key code representing the '6' key.
`static KeyCode`	`Slash` A key code representing the '/' key.
`static KeyCode`	`Space` A key code representing the space key.
`static KeyCode`	`T` A key code representing the 'T' key.
`static KeyCode`	`Three` A key code representing the '3' key.
`static KeyCode`	`Two` A key code representing the '2' key.
`static KeyCode`	`U` A key code representing the 'U' key.
`static KeyCode`	`Unknown` A key code representing an unknown key.
`static KeyCode`	`Up` A key code representing the up key.
`static KeyCode`	`V` A key code representing the 'V' key.
`static KeyCode`	`W` A key code representing the 'W' key.
`static KeyCode`	`X` A key code representing the 'X' key.
`static KeyCode`	`Y` A key code representing the 'Y' key.
`static KeyCode`	`Z` A key code representing the 'Z' key.
`static KeyCode`	`Zero` A key code representing the '0' key.

Constructor Summary

Constructors
Constructor and Description

KeyCode(long index)
Creates a new KeyCode with the given index.

Constructors
Constructor and Description
`KeyCode(long index)` Creates a new `KeyCode` with the given index.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(@Nullable Object other)`
`long`	`getIndex()` The index of the key code.
`int`	`hashCode()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - Unknown
```
public static final KeyCode Unknown
```
    A key code representing an unknown key.
  - Space
```
public static final KeyCode Space
```
    A key code representing the space key.
  - Plus
```
public static final KeyCode Plus
```
    A key code representing the '+' key.
  - Minus
```
public static final KeyCode Minus
```
    A key code representing the '-' key.
  - Asterisk
```
public static final KeyCode Asterisk
```
    A key code representing the '*' key.
  - Slash
```
public static final KeyCode Slash
```
    A key code representing the '/' key.
  - Escape
```
public static final KeyCode Escape
```
    A key code representing the escape key.
  - Backspace
```
public static final KeyCode Backspace
```
    A key code representing the backspace key.
  - Zero
```
public static final KeyCode Zero
```
    A key code representing the '0' key.
  - One
```
public static final KeyCode One
```
    A key code representing the '1' key.
  - Two
```
public static final KeyCode Two
```
    A key code representing the '2' key.
  - Three
```
public static final KeyCode Three
```
    A key code representing the '3' key.
  - Four
```
public static final KeyCode Four
```
    A key code representing the '4' key.
  - Five
```
public static final KeyCode Five
```
    A key code representing the '5' key.
  - Six
```
public static final KeyCode Six
```
    A key code representing the '6' key.
  - Seven
```
public static final KeyCode Seven
```
    A key code representing the '7' key.
  - Eight
```
public static final KeyCode Eight
```
    A key code representing the '8' key.
  - Nine
```
public static final KeyCode Nine
```
    A key code representing the '9' key.
  - A
```
public static final KeyCode A
```
    A key code representing the 'A' key.
  - B
```
public static final KeyCode B
```
    A key code representing the 'B' key.
  - C
```
public static final KeyCode C
```
    A key code representing the 'C' key.
  - D
```
public static final KeyCode D
```
    A key code representing the 'D' key.
  - E
```
public static final KeyCode E
```
    A key code representing the 'E' key.
  - F
```
public static final KeyCode F
```
    A key code representing the 'F' key.
  - G
```
public static final KeyCode G
```
    A key code representing the 'G' key.
  - H
```
public static final KeyCode H
```
    A key code representing the 'H' key.
  - I
```
public static final KeyCode I
```
    A key code representing the 'I' key.
  - J
```
public static final KeyCode J
```
    A key code representing the 'J' key.
  - K
```
public static final KeyCode K
```
    A key code representing the 'K' key.
  - L
```
public static final KeyCode L
```
    A key code representing the 'L' key.
  - M
```
public static final KeyCode M
```
    A key code representing the 'M' key.
  - N
```
public static final KeyCode N
```
    A key code representing the 'N' key.
  - O
```
public static final KeyCode O
```
    A key code representing the 'O' key.
  - P
```
public static final KeyCode P
```
    A key code representing the 'P' key.
  - Q
```
public static final KeyCode Q
```
    A key code representing the 'Q' key.
  - R
```
public static final KeyCode R
```
    A key code representing the 'R' key.
  - S
```
public static final KeyCode S
```
    A key code representing the 'S' key.
  - T
```
public static final KeyCode T
```
    A key code representing the 'T' key.
  - U
```
public static final KeyCode U
```
    A key code representing the 'U' key.
  - V
```
public static final KeyCode V
```
    A key code representing the 'V' key.
  - W
```
public static final KeyCode W
```
    A key code representing the 'W' key.
  - X
```
public static final KeyCode X
```
    A key code representing the 'X' key.
  - Y
```
public static final KeyCode Y
```
    A key code representing the 'Y' key.
  - Z
```
public static final KeyCode Z
```
    A key code representing the 'Z' key.
  - Home
```
public static final KeyCode Home
```
    A key code representing the home key.
  - End
```
public static final KeyCode End
```
    A key code representing the end key.
  - Left
```
public static final KeyCode Left
```
    A key code representing the left key.
  - Up
```
public static final KeyCode Up
```
    A key code representing the up key.
  - Right
```
public static final KeyCode Right
```
    A key code representing the right key.
  - Down
```
public static final KeyCode Down
```
    A key code representing the down key.
  - PageUp
```
public static final KeyCode PageUp
```
    A key code representing the pacge up key.
  - PageDown
```
public static final KeyCode PageDown
```
    A key code representing the page down key.
- Constructor Detail
  - KeyCode
```
public KeyCode(long index)
```
    Creates a new KeyCode with the given index.
    The key button index maps on to keys as follows:
    - 0 => Unknown
    - 8 => Backspace
    - 27 => Escape
    - 32 => Space
    - 42 => Asterisk
    - 43 => Plus
    - 45 => Minus
    - 47 => Slash
    - 48 => 0
    - 49 => 1
    - ...
    - 57 => 9
    - 65 => A
    - 66 => B
    - ...
    - 90 => Z
    - 200 => Home
    - 201 => End
    - 202 => Left
    - 203 => Up
    - 204 => Right
    - 205 => Down
    - 206 => Page-Up
    - 207 => Page-Down
    If needed other indexes can be used if out of those values. For example if you want to handle unicode characters. Please use index values greater than 1024 for custom key codes.
    Parameters:
    
    index - the mouse button index.
- Method Detail
  - getIndex
```
public long getIndex()
```
    The index of the key code.
  - equals
```
public boolean equals(@Nullable
                      @Nullable Object other)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class KeyCode

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

Unknown

Space

Plus

Minus

Asterisk

Slash

Escape

Backspace

Zero

One

Two

Three

Four

Five

Six

Seven

Eight

Nine

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

Home

End

Left

Up

Right

Down

PageUp

PageDown

Constructor Detail

KeyCode

Method Detail

getIndex

equals

hashCode