Caption (SAP Library - Web Dynpro ABAP)

Caption

The Caption UI element is used by a row of UI elements, for example, Group, Tab, Table, TableColumn and Tray, to provide a heading or a title.

Note

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

This graphic is explained in the accompanying text

Runtime Class

CL_WD_CAPTION

Properties in View Designer

Name	Type	Initial Value	Bindable
ID	STRING	(automatic)	No
contextMenuBehaviour	WDUI_CONTEXT_MENU_BEHAVIOUR	inherit	No
contextMenuId	WDY_MD_UI_ELEMENT_REFERENCE		No
enabled	WDY_BOOLEAN	true	Yes
imageFirst	WDY_BOOLEAN	true	Yes
imageSource	STRING		Yes
isDragHandle	WDY_BOOLEAN	false	No
text	Translatable text		Yes
textDirection	WDUI_TEXT_DIRECTION	inherit	Yes
tooltip	Translatable text		Yes
visible	WDUI_VISIBILITY	visible	Yes

Note

Other properties that can be inherited are defined in the associated higher-level classes. The associated UI elements are:

● AbstractCaption

● UIElement

● ContextMenuProvider

● ViewElement

Dynamic Programming

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
contextMenuBehaviour	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
contextMenuId	CONTEXT_MENU_ID	WDY_MD_UI_ELEMENT_REFERENCE
enabled	ENABLED	WDY_BOOLEAN
imageFirst	IMAGE_FIRST	WDY_BOOLEAN
imageSource	IMAGE_SOURCE	STRING
isDragHandle	IS_DRAG_HANDLE	WDY_BOOLEAN
text	TEXT	WDY_MD_TRANSLATABLE_TEXT
textDirection	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	TOOLTIP	WDY_MD_TRANSLATABLE_TEXT
visible	VISIBLE	WDUI_VISIBILITY
visible: none	CL_WD_CAPTION=>E_VISIBLE-NONE
visible: visible	CL_WD_CAPTION=>E_VISIBLE-VISIBLE

Example

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 view Button.