Show TOC

Hot KeysLocate this document in the navigation structure

Use

Web Dynpro Framework supports hotkeys .

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

Assignment to UI Elements

The hotkey property is available for the following UI elements:

Caution

Note that additional browser programs such as HTTPWatch in Microsoft Internet Explorer can also use and, possibly, block hot keys. This depends on the Web Dynpro ABAP framework control.

If you use the SAP NetWeaver Business Client, this problem is not relevant.

Visualization

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

A hotkey 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 hotkey is defined in different hotkey 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 hotkeys 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 hotkey can only be assigned once within a hot key handler. If it is defined in multiple, the hotkey is completed deleted to prevent confusion.

Example

Assume that there is a view with two TransparentContainer T1 and T2, and that handleHotkeys is set for both. Each TransparentContainer has a Button B1 and B2 and there is a third Button B3 outside the two TransparentContainer s. All three Button s have the same hotkey combination CRTL+0. If the focus is in T1, CRTL+0 triggers the action for Button B1. If the focus is in T2, it triggers the action for B2. If the focus is outside both TransparentContainer s, CTRL+0 triggers the action for Button B3.

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

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

Note

Special case TabStrip:

For TabStrip s, each Tab is always a hotkey handler hotkeys defined there are always only active if the Tab in question is visible and in focus.

Caution

Set hotkeys and handleHotkeys sparingly and extremely carefully to avoid confusing users.

In particular, make sure that you do not use any nestings.

Enumerations

The hotkey 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