org.appformer.kogito.bridge.client.keyboardshortcuts

Interface KeyboardShortcutsApi

All Known Implementing Classes:

KeyboardShortcutsService, NoOpKeyboardShortcutsService

public interface KeyboardShortcutsApi

API for registering Keyboard Shortcuts.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	KeyboardShortcutsApi.Action

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.

Method Detail

registerKeyPress

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

Register a Keyboard Shortcuts for a keypress event.

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

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

Register a Keyboard Shortcuts for a keypress event.

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

void deregister(int id)

Deregister a Keyboard Shortcut.

Parameters:

id - The id obtained when registering a Keyboard Shortcut.