IconButton
The IconButton is a simple version of a Button, and is currently used as a HeaderFunctions aggregation of the Panel.
The IconButton does not contain any text, just an image. Normally, you set the type property of an imageSource, (for example, help, menu, personalize, etc.), and the image and tooltip are provided by the framework. You can override both image and tooltip by entering the imageSource and tooltip properties directly. Properties hotKey, enabled, visible and event onAction behave exactly the same as a Button does.
A IconButton is only enabled when its enabled property is set to true, and when an action handler is specified for the onAction event.
In addition, the exception described below applies if the type is set to menu.
Unlike a Button, an IconButton can have a menu. If a menu is specified, and the type is not equal to menu, the IconButton is split into two areas. When the user clicks on the left-hand area, the onAction event is triggered, and when the user clicks on the right-hand area, a menu is expanded.
IconButtons with type=menu behave differently. When the user clicks on an IconButton, a menu is always opened, and the action handler is not called. In this case an IconButton is only enabled if the enabled property is set to true, and a Menu is aggregated for which the visible property is set to visible.
Implementation Details
Runtime Class |
CL_WD_ICON_BUTTON |
Name |
Type |
Initial Value |
Bindable |
|---|---|---|---|
STRING |
(automatic) |
No |
|
WDUI_CONTEXT_MENU_BEHAVIOUR |
inherit |
No |
|
WDY_MD_UI_ELEMENT_REFERENCE |
No |
||
WDY_BOOLEAN |
true |
Yes |
|
WDUI_HOTKEY |
none |
No |
|
STRING |
Yes |
||
Translatable text |
Yes |
||
WDUI_ICON_BUTTON_TYPE |
none |
Yes |
|
WDUI_VISIBILITY |
visible |
Yes |
Name |
|---|
Other properties that can be inherited are defined in the related higher-level classes. The related UI elements are:
Dynamic Programming
For dynamic programming, the same properties, events and aggregations are available as in the View Designer. But note that the spelling format and use of upper/lower case is different.
View Designer Name |
Runtime Name |
Type |
|---|---|---|
CONTEXT_MENU_BEHAVIOUR |
WDUI_CONTEXT_MENU_BEHAVIOUR |
|
contextMenuBehaviour: inherit |
CL_WD_ICON_BUTTON=>E_CONTEXT_MENU_BEHAVIOUR-INHERIT |
|
contextMenuBehaviour: provide |
CL_WD_ICON_BUTTON=>E_CONTEXT_MENU_BEHAVIOUR-PROVIDE |
|
contextMenuBehaviour: suppress |
CL_WD_ICON_BUTTON=>E_CONTEXT_MENU_BEHAVIOUR-SUPPRESS |
|
CONTEXT_MENU_ID |
WDY_MD_UI_ELEMENT_REFERENCE |
|
ENABLED |
WDY_BOOLEAN |
|
HOTKEY |
WDUI_HOTKEY |
|
hotkey: alt_arrow_down |
CL_WD_ICON_BUTTON=>E_HOTKEY-ALT_ARROW_DOWN |
|
hotkey: alt_arrow_left |
CL_WD_ICON_BUTTON=>E_HOTKEY-ALT_ARROW_LEFT |
|
hotkey: alt_arrow_right |
CL_WD_ICON_BUTTON=>E_HOTKEY-ALT_ARROW_RIGHT |
|
hotkey: alt_arrow_up |
CL_WD_ICON_BUTTON=>E_HOTKEY-ALT_ARROW_UP |
|
hotkey: ctrl_0 |
CL_WD_ICON_BUTTON=>E_HOTKEY-CTRL_0 |
|
hotkey: ctrl_1 |
CL_WD_ICON_BUTTON=>E_HOTKEY-CTRL_1 |
|
hotkey: ctrl_2 |
CL_WD_ICON_BUTTON=>E_HOTKEY-CTRL_2 |
|
hotkey: ctrl_3 |
CL_WD_ICON_BUTTON=>E_HOTKEY-CTRL_3 |
|
hotkey: ctrl_4 |
CL_WD_ICON_BUTTON=>E_HOTKEY-CTRL_4 |
|
hotkey: ctrl_5 |
CL_WD_ICON_BUTTON=>E_HOTKEY-CTRL_5 |
|
hotkey: ctrl_6 |
CL_WD_ICON_BUTTON=>E_HOTKEY-CTRL_6 |
|
hotkey: ctrl_7 |
CL_WD_ICON_BUTTON=>E_HOTKEY-CTRL_7 |
|
hotkey: ctrl_8 |
CL_WD_ICON_BUTTON=>E_HOTKEY-CTRL_8 |
|
hotkey: ctrl_9 |
CL_WD_ICON_BUTTON=>E_HOTKEY-CTRL_9 |
|
hotkey: ctrl_a |
CL_WD_ICON_BUTTON=>E_HOTKEY-CTRL_A |
|
hotkey: ctrl_b |
CL_WD_ICON_BUTTON=>E_HOTKEY-CTRL_B |
|
hotkey: ctrl_c |
CL_WD_ICON_BUTTON=>E_HOTKEY-CTRL_C |
|
hotkey: ctrl_comma |
CL_WD_ICON_BUTTON=>E_HOTKEY-CTRL_COMMA |
|
hotkey: ctrl_d |
CL_WD_ICON_BUTTON=>E_HOTKEY-CTRL_D |
|
hotkey: ctrl_dot |
CL_WD_ICON_BUTTON=>E_HOTKEY-CTRL_DOT |
|
hotkey: ctrl_e |
CL_WD_ICON_BUTTON=>E_HOTKEY-CTRL_E |
|
hotkey: ctrl_f |
CL_WD_ICON_BUTTON=>E_HOTKEY-CTRL_F |
|
hotkey: ctrl_f10 |
CL_WD_ICON_BUTTON=>E_HOTKEY-CTRL_F10 |
|
hotkey: ctrl_f11 |
CL_WD_ICON_BUTTON=>E_HOTKEY-CTRL_F11 |
|
hotkey: ctrl_f12 |
CL_WD_ICON_BUTTON=>E_HOTKEY-CTRL_F12 |
|
hotkey: ctrl_f2 |
CL_WD_ICON_BUTTON=>E_HOTKEY-CTRL_F2 |
|
hotkey: ctrl_f3 |
CL_WD_ICON_BUTTON=>E_HOTKEY-CTRL_F3 |
|
hotkey: ctrl_f4 |
CL_WD_ICON_BUTTON=>E_HOTKEY-CTRL_F4 |
|
hotkey: ctrl_f5 |
CL_WD_ICON_BUTTON=>E_HOTKEY-CTRL_F5 |
|
hotkey: ctrl_f6 |
CL_WD_ICON_BUTTON=>E_HOTKEY-CTRL_F6 |
|
hotkey: ctrl_f7 |
CL_WD_ICON_BUTTON=>E_HOTKEY-CTRL_F7 |
|
hotkey: ctrl_f8 |
CL_WD_ICON_BUTTON=>E_HOTKEY-CTRL_F8 |
|
hotkey: ctrl_f9 |
CL_WD_ICON_BUTTON=>E_HOTKEY-CTRL_F9 |
|
hotkey: ctrl_g |
CL_WD_ICON_BUTTON=>E_HOTKEY-CTRL_G |
|
hotkey: ctrl_h |
CL_WD_ICON_BUTTON=>E_HOTKEY-CTRL_H |
|
hotkey: ctrl_i |
CL_WD_ICON_BUTTON=>E_HOTKEY-CTRL_I |
|
hotkey: ctrl_j |
CL_WD_ICON_BUTTON=>E_HOTKEY-CTRL_J |
|
hotkey: ctrl_k |
CL_WD_ICON_BUTTON=>E_HOTKEY-CTRL_K |
|
hotkey: ctrl_l |
CL_WD_ICON_BUTTON=>E_HOTKEY-CTRL_L |
|
hotkey: ctrl_m |
CL_WD_ICON_BUTTON=>E_HOTKEY-CTRL_M |
|
hotkey: ctrl_n |
CL_WD_ICON_BUTTON=>E_HOTKEY-CTRL_N |
|
hotkey: ctrl_o |
CL_WD_ICON_BUTTON=>E_HOTKEY-CTRL_O |
|
hotkey: ctrl_p |
CL_WD_ICON_BUTTON=>E_HOTKEY-CTRL_P |
|
hotkey: ctrl_q |
CL_WD_ICON_BUTTON=>E_HOTKEY-CTRL_Q |
|
hotkey: ctrl_r |
CL_WD_ICON_BUTTON=>E_HOTKEY-CTRL_R |
|
hotkey: ctrl_s |
CL_WD_ICON_BUTTON=>E_HOTKEY-CTRL_S |
|
hotkey: ctrl_shift_f1 |
CL_WD_ICON_BUTTON=>E_HOTKEY-CTRL_SHIFT_F1 |
|
hotkey: ctrl_shift_f10 |
CL_WD_ICON_BUTTON=>E_HOTKEY-CTRL_SHIFT_F10 |
|
hotkey: ctrl_shift_f11 |
CL_WD_ICON_BUTTON=>E_HOTKEY-CTRL_SHIFT_F11 |
|
hotkey: ctrl_shift_f12 |
CL_WD_ICON_BUTTON=>E_HOTKEY-CTRL_SHIFT_F12 |
|
hotkey: ctrl_shift_f2 |
CL_WD_ICON_BUTTON=>E_HOTKEY-CTRL_SHIFT_F2 |
|
hotkey: ctrl_shift_f3 |
CL_WD_ICON_BUTTON=>E_HOTKEY-CTRL_SHIFT_F3 |
|
hotkey: ctrl_shift_f4 |
CL_WD_ICON_BUTTON=>E_HOTKEY-CTRL_SHIFT_F4 |
|
hotkey: ctrl_shift_f5 |
CL_WD_ICON_BUTTON=>E_HOTKEY-CTRL_SHIFT_F5 |
|
hotkey: ctrl_shift_f6 |
CL_WD_ICON_BUTTON=>E_HOTKEY-CTRL_SHIFT_F6 |
|
hotkey: ctrl_shift_f7 |
CL_WD_ICON_BUTTON=>E_HOTKEY-CTRL_SHIFT_F7 |
|
hotkey: ctrl_shift_f8 |
CL_WD_ICON_BUTTON=>E_HOTKEY-CTRL_SHIFT_F8 |
|
hotkey: ctrl_shift_f9 |
CL_WD_ICON_BUTTON=>E_HOTKEY-CTRL_SHIFT_F9 |
|
hotkey: ctrl_t |
CL_WD_ICON_BUTTON=>E_HOTKEY-CTRL_T |
|
hotkey: ctrl_u |
CL_WD_ICON_BUTTON=>E_HOTKEY-CTRL_U |
|
hotkey: ctrl_v |
CL_WD_ICON_BUTTON=>E_HOTKEY-CTRL_V |
|
hotkey: ctrl_w |
CL_WD_ICON_BUTTON=>E_HOTKEY-CTRL_W |
|
hotkey: ctrl_x |
CL_WD_ICON_BUTTON=>E_HOTKEY-CTRL_X |
|
hotkey: ctrl_y |
CL_WD_ICON_BUTTON=>E_HOTKEY-CTRL_Y |
|
hotkey: ctrl_z |
CL_WD_ICON_BUTTON=>E_HOTKEY-CTRL_Z |
|
hotkey: delete |
CL_WD_ICON_BUTTON=>E_HOTKEY-DELETE |
|
hotkey: escape |
CL_WD_ICON_BUTTON=>E_HOTKEY-ESCAPE |
|
hotkey: insert |
CL_WD_ICON_BUTTON=>E_HOTKEY-INSERT |
|
hotkey: none |
CL_WD_ICON_BUTTON=>E_HOTKEY-NONE |
|
IMAGE_SOURCE |
STRING |
|
TOOLTIP |
WDY_MD_TRANSLATABLE_TEXT |
|
TYPE |
WDUI_ICON_BUTTON_TYPE |
|
type: close |
CL_WD_ICON_BUTTON=>E_TYPE-CLOSE |
|
type: help |
CL_WD_ICON_BUTTON=>E_TYPE-HELP |
|
type: menu |
CL_WD_ICON_BUTTON=>E_TYPE-MENU |
|
type: none |
CL_WD_ICON_BUTTON=>E_TYPE-NONE |
|
type: personalize |
CL_WD_ICON_BUTTON=>E_TYPE-PERSONALIZE |
|
type: scrollTop |
CL_WD_ICON_BUTTON=>E_TYPE-SCROLL_TOP |
|
VISIBLE |
WDUI_VISIBILITY |
|
visible: none |
CL_WD_ICON_BUTTON=>E_VISIBLE-NONE |
|
visible: visible |
CL_WD_ICON_BUTTON=>E_VISIBLE-VISIBLE |
View Designer Name |
Runtime Name |
Cardinality |
|---|---|---|
MENU |
0..1 |
View Designer Name |
Runtime Name |
|---|---|
ON_ACTION |
This UI element is not available to SAP NetWeaver Business Client .
You can find an example for testing in the system in components WDR_TEST_UI_ELEMENTS and WDR_TEST_PANEL.