The Caption UI element is used by a series of UI elements, for example, Group , Tab , Table , TableColumn and Tray , to provide a heading or a title.
Tab Captions cannot be used as a drag handle. See also Drag&Drop .
The Caption UI element must not be used in a normal Layout. It can only be aggregated as a Header for Tables, TableColumns, Trays, Groups, and so on.
To enable the development of accessible applications, the tooltip property is checked during the syntax check if the property text is not set.
A tooltip does not necessarily have to be set for this UI element, but it could make sense to set it if it contains detailed semantic information.
Examples of the Display
|
|
Runtime Class |
CL_WD_CAPTION |
Properties in the View Designer
Name | Type | Initial Value | Bindable |
---|---|---|---|
STRING |
(automatic) |
No |
|
WDUI_CONTEXT_MENU_BEHAVIOUR |
inherit |
No |
|
WDY_MD_UI_ELEMENT_REFERENCE |
No |
||
WDY_BOOLEAN |
true |
Yes |
|
WDY_BOOLEAN |
true |
Yes |
|
STRING |
Yes |
||
WDY_BOOLEAN |
false |
No |
|
Translatable text |
Yes |
||
WDUI_TEXT_DIRECTION |
inherit |
Yes |
|
Translatable text |
Yes |
||
WDUI_VISIBILITY |
visible |
Yes |
Other properties that can be inherited are defined in the associated higher-level classes. The associated UI elements are:
For dynamic programming, the same properties, events, and aggregations as in the View Designer are available. Bear in mind the different spellings.
Dynamic Programming of Properties
View Designer Name | Runtime Name | Type |
---|---|---|
CONTEXT_MENU_BEHAVIOUR |
WDUI_CONTEXT_MENU_BEHAVIOUR |
|
contextMenuBehaviour: inherit |
CL_WD_CAPTION=>E_CONTEXT_MENU_BEHAVIOUR-INHERIT |
|
contextMenuBehaviour: provide |
CL_WD_CAPTION=>E_CONTEXT_MENU_BEHAVIOUR-PROVIDE |
|
contextMenuBehaviour: suppress |
CL_WD_CAPTION=>E_CONTEXT_MENU_BEHAVIOUR-SUPPRESS |
|
CONTEXT_MENU_ID |
WDY_MD_UI_ELEMENT_REFERENCE |
|
ENABLED |
WDY_BOOLEAN |
|
IMAGE_FIRST |
WDY_BOOLEAN |
|
IMAGE_SOURCE |
STRING |
|
IS_DRAG_HANDLE |
WDY_BOOLEAN |
|
TEXT |
WDY_MD_TRANSLATABLE_TEXT |
|
TEXT_DIRECTION |
WDUI_TEXT_DIRECTION |
|
textDirection inherit |
CL_WD_CAPTION=>E_TEXT_DIRECTION-INHERIT |
|
textDirection ltr |
CL_WD_CAPTION=>E_TEXT_DIRECTION-LTR |
|
textDirection rtl |
CL_WD_CAPTION=>E_TEXT_DIRECTION-RTL |
|
TOOLTIP |
WDY_MD_TRANSLATABLE_TEXT |
|
VISIBLE |
WDUI_VISIBILITY |
|
visible: none |
CL_WD_CAPTION=>E_VISIBLE-NONE |
|
visible: visible |
CL_WD_CAPTION=>E_VISIBLE-VISIBLE |
You can find examples of this interface element in the system in the Web Dynpro application WDR_TEST_UI_ELEMENTS, and in the component WDR_TEST_EVENTS in the Button view.