Key Capture

Component Type: Sensor (Subcategory: Standard Input Devices)

This component provides access to keystrokes of a single key on the keyboard. The keystroke capture does not depend on a particular window or text field to have the input focus. For every keypress and release of the specified key an event gets fired. Possible applications include triggering functions by keyboard input, interfacing to speech recognition software or remapping keys to other keycodes.

Requirements

A keyboard which generates keystrokes or a software component which injects keystrokes into the operating system message queue.

Mapping of keyCodes to actual keys

The full list of keycodes is defined here: https://github.com/kwhat/jnativehook/blob/master/src/java/org/jnativehook/keyboard/NativeKeyEvent.java

Input Port Description

• keyCode [integer]: The keycode of the key which should be captured. For a list of the mapping between keycodes and keys see the graphics above.

Event Trigger Description

• keyPressed: This event port fires an event if the key with the specified keyCode was pressed.
• keyReleased: This event port fires an event if the key with the specified keyCode was released.

Event Listener Description

• enable: The keystate is captured and events get fired
• disable: The plugin does not fire any event.
• block: After this event, the keystroke of the key with the specified keyCode is not forwarded to the operating system.
• unblock: After this event, the keystroke of the key with the specified keyCode is forwarded to the operating system.

Properties

• block [boolean]: If this property is set to true, no key press activities will be routed to the operating system
• keyCode[integer]:The keycode of the key which should be captured. For a list of the mapping between keycodes and keys see the graphics above.