KeyPopupTrigger (TerraExplorer Java Library 2.0)

java.lang.Object
- com.datagis.terraexplorer.menu.PopupTrigger
- - com.datagis.terraexplorer.menu.KeyPopupTrigger

All Implemented Interfaces:

Serializable
```
public class KeyPopupTrigger
extends PopupTrigger
```
An implementation of PopupTrigger for key events.
Valid key event ids are those, that are re-declared in this class: KEY_PRESSED and KEY_RELEASED.
Valid keys are a subset of the virtual key code constants declared in class KeyEvent. Supported are those, that are re-declared in this class. Method isKeySupported determines, whether a certain key code constant is supported or not.
Basically, the set of supported key codes contains those:
- for which method KeyEvent.isActionKey returns true
- which are available on the Windows platform
- which are not related to extended input methods for Asian keyboards (Japanese PC 106 keyboard)
In other words, a key popup trigger can be registered for action keys available on the Windows platform, which are not related to extended input methods.
Since:

TEJ2.0

Author:

Carsten Klein

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`KEY_FIRST` The first number in the range of ids used for key events with this popup trigger.
`static int`	`KEY_LAST` The last number in the range of ids used for key events with this popup trigger.
`static int`	`KEY_PRESSED` The "key pressed" event.
`static int`	`KEY_RELEASED` The "key released" event.
`static int`	`VK_BEGIN`
`static int`	`VK_CAPS_LOCK`
`static int`	`VK_CONTEXT_MENU`
`static int`	`VK_DOWN`
`static int`	`VK_END`
`static int`	`VK_F1`
`static int`	`VK_F10`
`static int`	`VK_F11`
`static int`	`VK_F12`
`static int`	`VK_F13`
`static int`	`VK_F14`
`static int`	`VK_F15`
`static int`	`VK_F16`
`static int`	`VK_F17`
`static int`	`VK_F18`
`static int`	`VK_F19`
`static int`	`VK_F2`
`static int`	`VK_F20`
`static int`	`VK_F21`
`static int`	`VK_F22`
`static int`	`VK_F23`
`static int`	`VK_F24`
`static int`	`VK_F3`
`static int`	`VK_F4`
`static int`	`VK_F5`
`static int`	`VK_F6`
`static int`	`VK_F7`
`static int`	`VK_F8`
`static int`	`VK_F9`
`static int`	`VK_HELP`
`static int`	`VK_HOME`
`static int`	`VK_INSERT`
`static int`	`VK_KP_DOWN`
`static int`	`VK_KP_LEFT`
`static int`	`VK_KP_RIGHT`
`static int`	`VK_KP_UP`
`static int`	`VK_LEFT`
`static int`	`VK_NUM_LOCK`
`static int`	`VK_PAGE_DOWN`
`static int`	`VK_PAGE_UP`
`static int`	`VK_PAUSE`
`static int`	`VK_PRINTSCREEN`
`static int`	`VK_RIGHT`
`static int`	`VK_SCROLL_LOCK`
`static int`	`VK_UP`
`static int`	`VK_WINDOWS`

Fields inherited from class com.datagis.terraexplorer.menu.PopupTrigger
eventId, key

Constructor Summary

Constructors
Constructor and Description

KeyPopupTrigger(int eventId, int keyCode)
Initializes a KeyPopupTrigger with the specified event id and key code constant.

Constructors
Constructor and Description
`KeyPopupTrigger(int eventId, int keyCode)` Initializes a `KeyPopupTrigger` with the specified event id and key code constant.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getKeyCode()` Returns this key popup trigger's key code constant.
`int[]`	`getNativeKeys()` Returns the native keys as an array of integers.
`static boolean`	`isKeySupported(int keyCode)` Determines whether the specified key code is supported by a `KeyPopupTrigger`.
`static KeyPopupTrigger`	`valueOf(int eventId, int keyCode)` Returns a `KeyPopupTrigger` instance representing the specified event id and key code constant.

Methods inherited from class com.datagis.terraexplorer.menu.PopupTrigger
equals, getEventId, getKey, hashCode

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

- Field Detail
  - KEY_FIRST
```
public static final int KEY_FIRST
```
    The first number in the range of ids used for key events with this popup trigger.
    
    See Also:
    
    Constant Field Values
  - KEY_LAST
```
public static final int KEY_LAST
```
    The last number in the range of ids used for key events with this popup trigger.
    
    See Also:
    
    Constant Field Values
  - KEY_PRESSED
```
public static final int KEY_PRESSED
```
    The "key pressed" event. This event is generated when a key is pushed down.
    
    See Also:
    
    Constant Field Values
  - KEY_RELEASED
```
public static final int KEY_RELEASED
```
    The "key released" event. This event is generated when a key is let up.
    
    See Also:
    
    Constant Field Values
  - VK_HOME
```
public static final int VK_HOME
```
    See Also:
    
    Constant Field Values
  - VK_END
```
public static final int VK_END
```
    See Also:
    
    Constant Field Values
  - VK_PAGE_UP
```
public static final int VK_PAGE_UP
```
    See Also:
    
    Constant Field Values
  - VK_PAGE_DOWN
```
public static final int VK_PAGE_DOWN
```
    See Also:
    
    Constant Field Values
  - VK_UP
```
public static final int VK_UP
```
    See Also:
    
    Constant Field Values
  - VK_DOWN
```
public static final int VK_DOWN
```
    See Also:
    
    Constant Field Values
  - VK_LEFT
```
public static final int VK_LEFT
```
    See Also:
    
    Constant Field Values
  - VK_RIGHT
```
public static final int VK_RIGHT
```
    See Also:
    
    Constant Field Values
  - VK_BEGIN
```
public static final int VK_BEGIN
```
    See Also:
    
    Constant Field Values
  - VK_KP_LEFT
```
public static final int VK_KP_LEFT
```
    See Also:
    
    Constant Field Values
  - VK_KP_UP
```
public static final int VK_KP_UP
```
    See Also:
    
    Constant Field Values
  - VK_KP_RIGHT
```
public static final int VK_KP_RIGHT
```
    See Also:
    
    Constant Field Values
  - VK_KP_DOWN
```
public static final int VK_KP_DOWN
```
    See Also:
    
    Constant Field Values
  - VK_F1
```
public static final int VK_F1
```
    See Also:
    
    Constant Field Values
  - VK_F2
```
public static final int VK_F2
```
    See Also:
    
    Constant Field Values
  - VK_F3
```
public static final int VK_F3
```
    See Also:
    
    Constant Field Values
  - VK_F4
```
public static final int VK_F4
```
    See Also:
    
    Constant Field Values
  - VK_F5
```
public static final int VK_F5
```
    See Also:
    
    Constant Field Values
  - VK_F6
```
public static final int VK_F6
```
    See Also:
    
    Constant Field Values
  - VK_F7
```
public static final int VK_F7
```
    See Also:
    
    Constant Field Values
  - VK_F8
```
public static final int VK_F8
```
    See Also:
    
    Constant Field Values
  - VK_F9
```
public static final int VK_F9
```
    See Also:
    
    Constant Field Values
  - VK_F10
```
public static final int VK_F10
```
    See Also:
    
    Constant Field Values
  - VK_F11
```
public static final int VK_F11
```
    See Also:
    
    Constant Field Values
  - VK_F12
```
public static final int VK_F12
```
    See Also:
    
    Constant Field Values
  - VK_F13
```
public static final int VK_F13
```
    See Also:
    
    Constant Field Values
  - VK_F14
```
public static final int VK_F14
```
    See Also:
    
    Constant Field Values
  - VK_F15
```
public static final int VK_F15
```
    See Also:
    
    Constant Field Values
  - VK_F16
```
public static final int VK_F16
```
    See Also:
    
    Constant Field Values
  - VK_F17
```
public static final int VK_F17
```
    See Also:
    
    Constant Field Values
  - VK_F18
```
public static final int VK_F18
```
    See Also:
    
    Constant Field Values
  - VK_F19
```
public static final int VK_F19
```
    See Also:
    
    Constant Field Values
  - VK_F20
```
public static final int VK_F20
```
    See Also:
    
    Constant Field Values
  - VK_F21
```
public static final int VK_F21
```
    See Also:
    
    Constant Field Values
  - VK_F22
```
public static final int VK_F22
```
    See Also:
    
    Constant Field Values
  - VK_F23
```
public static final int VK_F23
```
    See Also:
    
    Constant Field Values
  - VK_F24
```
public static final int VK_F24
```
    See Also:
    
    Constant Field Values
  - VK_PRINTSCREEN
```
public static final int VK_PRINTSCREEN
```
    See Also:
    
    Constant Field Values
  - VK_SCROLL_LOCK
```
public static final int VK_SCROLL_LOCK
```
    See Also:
    
    Constant Field Values
  - VK_CAPS_LOCK
```
public static final int VK_CAPS_LOCK
```
    See Also:
    
    Constant Field Values
  - VK_NUM_LOCK
```
public static final int VK_NUM_LOCK
```
    See Also:
    
    Constant Field Values
  - VK_PAUSE
```
public static final int VK_PAUSE
```
    See Also:
    
    Constant Field Values
  - VK_INSERT
```
public static final int VK_INSERT
```
    See Also:
    
    Constant Field Values
  - VK_HELP
```
public static final int VK_HELP
```
    See Also:
    
    Constant Field Values
  - VK_WINDOWS
```
public static final int VK_WINDOWS
```
    See Also:
    
    Constant Field Values
  - VK_CONTEXT_MENU
```
public static final int VK_CONTEXT_MENU
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - KeyPopupTrigger
```
public KeyPopupTrigger(int eventId,
                       int keyCode)
```
    Initializes a KeyPopupTrigger with the specified event id and key code constant.
    The supported event ids are a subset of the key event ids declared in class KeyEvent. Actually, only those event ids re-declared in this class, are the supported ones: KEY_PRESSED and KEY_RELEASED. Specifying any other event id results in an IllegalArgumentException.
    The supported key code constants ids are a subset of the key code constants declared in class KeyEvent. Actually, only those key code constants re-declared in this class, are the supported ones. Method isKeySupported determines, whether a certain key code constant is supported. Specifying an unsupported key code constant results in an IllegalArgumentException.
    Basically, the set of supported key codes contains those:
    - for which method KeyEvent.isActionKey returns true
    - which are available on the Windows platform
    - which are not related to extended input methods for Asian keyboards (Japanese PC 106 keyboard)
    In other words, a key popup trigger can be registered for action keys available on the Windows platform, which are not related to extended input methods.
    Parameters:
    
    eventId - the eventId of the new key popup trigger
    
    keyCode - the key code constant of the new key popup trigger
    
    Throws:
    
    IllegalArgumentException - if any of the specified arguments is invalid
    
    See Also:
    
    isKeySupported(int), KeyEvent, KeyEvent.isActionKey()
- Method Detail
  - valueOf
```
public static KeyPopupTrigger valueOf(int eventId,
                                      int keyCode)
```
    Returns a KeyPopupTrigger instance representing the specified event id and key code constant. This method uses a cache, so that different requests for key popup triggers with the same event ids and key code constants return the same trigger instance.
    The supported event ids are a subset of the key event ids declared in class KeyEvent. Actually, only those event ids re-declared in this class, are the supported ones: KEY_PRESSED and KEY_RELEASED. Specifying any other event id results in an IllegalArgumentException.
    The supported key code constants ids are a subset of the key code constants declared in class KeyEvent. Actually, only those key code constants re-declared in this class, are the supported ones. Method isKeySupported determines, whether a certain key code constant is supported. Specifying an unsupported key code constant results in an IllegalArgumentException.
    Basically, the set of supported key codes contains those:
    - for which method KeyEvent.isActionKey returns true
    - which are available on the Windows platform
    - which are not related to extended input methods for Asian keyboards (Japanese PC 106 keyboard)
    In other words, a key popup trigger can be registered for action keys available on the Windows platform, which are not related to extended input methods.
    Parameters:
    
    eventId - the eventId of the new key popup trigger
    
    keyCode - the key code constant of the new key popup trigger
    
    Returns:
    
    a KeyPopupTrigger instance representing the specified event id and key code constant
    
    Throws:
    
    IllegalArgumentException - if any of the specified arguments is invalid
    
    See Also:
    
    KeyEvent, KeyEvent.isActionKey()
  - getKeyCode
```
public int getKeyCode()
```
    Returns this key popup trigger's key code constant.
    
    Returns:
    
    this key popup trigger's key code constant
  - getNativeKeys
```
public int[] getNativeKeys()
```
    Description copied from class: PopupTrigger
    
    Returns the native keys as an array of integers.
    
    Overrides:
    
    getNativeKeys in class PopupTrigger
    
    Returns:
    
    the native keys as an array of integers
  - isKeySupported
```
public static boolean isKeySupported(int keyCode)
```
    Determines whether the specified key code is supported by a KeyPopupTrigger.
    
    Parameters:
    
    keyCode - the key code to test
    
    Returns:
    
    true if the spefified key code is supported by a KeyPopupTrigger; false otherwise

Class KeyPopupTrigger

Field Summary

Fields inherited from class com.datagis.terraexplorer.menu.PopupTrigger

Constructor Summary

Method Summary

Methods inherited from class com.datagis.terraexplorer.menu.PopupTrigger

Methods inherited from class java.lang.Object

Field Detail

KEY_FIRST

KEY_LAST

KEY_PRESSED

KEY_RELEASED

VK_HOME

VK_END

VK_PAGE_UP

VK_PAGE_DOWN

VK_UP

VK_DOWN

VK_LEFT

VK_RIGHT

VK_BEGIN

VK_KP_LEFT

VK_KP_UP

VK_KP_RIGHT

VK_KP_DOWN

VK_F1

VK_F2

VK_F3

VK_F4

VK_F5

VK_F6

VK_F7

VK_F8

VK_F9

VK_F10

VK_F11

VK_F12

VK_F13

VK_F14

VK_F15

VK_F16

VK_F17

VK_F18

VK_F19

VK_F20

VK_F21

VK_F22

VK_F23

VK_F24

VK_PRINTSCREEN

VK_SCROLL_LOCK

VK_CAPS_LOCK

VK_NUM_LOCK

VK_PAUSE

VK_INSERT

VK_HELP

VK_WINDOWS

VK_CONTEXT_MENU

Constructor Detail

KeyPopupTrigger

Method Detail

valueOf

getKeyCode

getNativeKeys

isKeySupported