org.appformer.kogito.bridge.client.keyboardshortcuts

Class KeyboardShortcutsService

java.lang.Object

org.appformer.kogito.bridge.client.keyboardshortcuts.KeyboardShortcutsService

All Implemented Interfaces:

KeyboardShortcutsApi

public class KeyboardShortcutsService
extends Object
implements KeyboardShortcutsApi

A KeyboardShortcutsApi implementation used when envelope API is available

Nested Class Summary

Nested classes/interfaces inherited from interface org.appformer.kogito.bridge.client.keyboardshortcuts.KeyboardShortcutsApi

KeyboardShortcutsApi.Action

Constructor Summary

Constructors

Constructor and Description
KeyboardShortcutsService()

Method Summary

Modifier and Type	Method and Description
void	deregister(int id) Deregister a Keyboard Shortcut.
int	registerKeyDownThenUp(String combination, String label, KeyboardShortcutsApi.Action onKeyDown, KeyboardShortcutsApi.Action onKeyUp, KeyboardShortcutsApiOpts opts) Register a Keyboard Shortcuts for a keypress event.
int	registerKeyPress(String combination, String label, KeyboardShortcutsApi.Action onKeyDown, KeyboardShortcutsApiOpts opts) Register a Keyboard Shortcuts for a keypress event.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KeyboardShortcutsService

public KeyboardShortcutsService()

Method Detail

registerKeyPress

public int registerKeyPress(String combination,
                            String label,
                            KeyboardShortcutsApi.Action onKeyDown,
                            KeyboardShortcutsApiOpts opts)

Description copied from interface: KeyboardShortcutsApi

Register a Keyboard Shortcuts for a keypress event.

Specified by:

registerKeyPress in interface KeyboardShortcutsApi

Parameters:

combination - The combination of keys that trigger 'onKeyDown' action. This is shown on the Keyboard Shortcuts panel.

label - The label for this Keyboard Shortcut. This is shown on the Keyboard Shortcuts panel. Use a `|` character to separate its section from its description. (e.g. "Moving | Arrow up")

onKeyDown - The action to be executed when 'combination' is pressed.

opts - Options of this registration.

Returns:

An id representing this registration. This id can be used to 'deregister' the Keyboard Shortcut.

registerKeyDownThenUp

public int registerKeyDownThenUp(String combination,
                                 String label,
                                 KeyboardShortcutsApi.Action onKeyDown,
                                 KeyboardShortcutsApi.Action onKeyUp,
                                 KeyboardShortcutsApiOpts opts)

Description copied from interface: KeyboardShortcutsApi

Register a Keyboard Shortcuts for a keypress event.

Specified by:

registerKeyDownThenUp in interface KeyboardShortcutsApi

Parameters:

combination - The combination of keys that trigger 'onKeyDown' action when they're pressed and 'onKeyUp' when they're released. This is shown on the Keyboard Shortcuts panel.

label - The label for this Keyboard Shortcut. This is shown on the Keyboard Shortcuts panel. Use a `|` character to separate its section from its description. (e.g. "Moving | Arrow up")

onKeyDown - The action to be executed when 'combination' is pressed.

onKeyUp - The action to be executed when 'combination' is released.

opts - Options of this registration.

Returns:

An id representing this registration. This id can be used to 'deregister' the Keyboard Shortcut.

deregister

public void deregister(int id)

Description copied from interface: KeyboardShortcutsApi

Deregister a Keyboard Shortcut.

Specified by:

deregister in interface KeyboardShortcutsApi

Parameters:

id - The id obtained when registering a Keyboard Shortcut.