Hot Keys

Use

Web Dynpro Framework supports hot keys.

Hot keys are key combinations with which a user can trigger a specific action (for example, open a browser window or trigger an event) for specific UI elements.

Assignment to UI Elements

The hotkey property is available for the following UI elements:

Visualization

The key combination for the corresponding hot key is always inserted automatically into the tooltip of the appropriate UI element. If a text already exists for the tooltip, the text for the hot key is appended at the end. For a MenuActionItem, the text for the hot key is appended to the existing text.

A hot key might be used by several UI elements. If this is the case, it is deleted because no clear assignment is possible and the user would otherwise become confused. An exception to this rule is if the same hot key is defined in different hot key containers.

handleHotkeys property

The handleHotkeys property is also available for the following UI elements:

This property specifies whether hot keys defined within the UI element ( TransparentContainer, Table, and so on) can be triggered globally or locally (when the focus is in the UI element).

If handleHotKeys is set, the UI element becomes a hot key handler. All hot keys defined in this UI element can only be triggered if the focus is in the UI element in question. If the focus is outside the UI element, pressing the same hot key combination triggers no action or triggers an action that belongs to another UI element. By default, the entire pane is a hot key handler.

A hot key can only be assigned once within a hot key handler. If it is defined in multiple, the hot key is completely deleted to prevent confusion.

If handleHotKey is not set, the hot key can be triggered throughout the entire page.

However, the focus must be in the browser page to enable global hot keys to be triggered.

Enumerations

The hot key property can have the following variants:

CTRL_0

CTRL_1

CTRL_2

CTRL_3

CTRL_4

CTRL_5

CTRL_6

CTRL_7

CTRL_8

CTRL_9

CTRL_F2

CTRL_F3

CTRL_F4

CTRL_F5

CTRL_F6

CTRL_F7

CTRL_F8

CTRL_F9

CTRL_F10

CTRL_F11

CTRL_F12

CTRL_A

CTRL_B

CTRL_C

CTRL_D

CTRL_E

CTRL_F

CTRL_G

CTRL_H

CTRL_I

CTRL_J

CTRL_K

CTRL_L

CTRL_M

CTRL_N

CTRL_O

CTRL_P

CTRL_Q

CTRL_R

CTRL_S

CTRL_T

CTRL_U

CTRL_V

CTRL_W

CTRL_X

CTRL_Y

CTRL_Z

CTRL_NONE

CTRL_SHIFT_F1

CTRL_SHIFT_F2

CTRL_SHIFT_F3

CTRL_SHIFT_F4

CTRL_SHIFT_F5

CTRL_SHIFT_F6

CTRL_SHIFT_F7

CTRL_SHIFT_F8

CTRL_SHIFT_F9

CTRL_SHIFT_F10

CTRL_SHIFT_F11

CTRL_SHIFT_F12