Caption API 

Definition

The Caption class, which implements the IWDCaption interface, is a concrete subclass of the IWDAbstractCaption class. The UI element can be used by several UI elements – such as Group, Tab, Table, TableColumn, and Tray – to provide a header or an icon for them.

The enabled property which is inherited by the superclas UIElement, does not affect the display.

Description of UI Element Properties

·        imageAlt
This property is deprecated and can no longer be used.

·        imageFirst
Defines the position of the icon in relation to the corresponding text. If the value of this property is true, the icon is displayed to the left of the text.

·        imageSource
Specifies the Web address (URL) of the icon to be displayed. You can assign an absolute Web address – http:// … to this property.
If you store the icons in the directory mimes/Components/<component class> of the Web Dynpro project in the Navigator using the menu item Import, you must only enter the icon name - for example, icon.gif. The URL Generation Service automatically determines the URL of the icon (see also URL Generation Service).
You can also store the icons in the directory mimes/Applications/<application class>. In this case, you must manually create the URL using the URL Generation Service.
If you use the SAP icons and want to refer to them, you use the alias ~sapicons. If you assign the alias ~sapicons/<name>.gif to the imageSourceproperty, you refer to an icon called <name>.gif of the SAP icons. For a description and a listing of all possible SAP icons, see the SAP Design Guild under http://www.sapdesignguild.org/. Select the following path:
Sitemap → Resources  → Visual Design & Icons → SAP R/3 Icons → R/3 Icon Lists. 
The filename of the icon consists of the bitmap name entered in the table and the prefix “s_”. If the bitmap name in the table is F_CUTO, you must enter the value ~sapicons/s_f_cuto.gif to reference to the SAP icon .

·        readOnly
Specifies whether or not the user can check the checkbox.

·        state
Describes the error status of the UI element. The data type of this property corresponds to the enumeration type WDState. You can use the following values in the application:

normal	Describes the default state of the UI element.
required	Specifies whether the entered value is required.

·        text
Specifies the text.

·        textDirection
Specifies the text direction and allows you to use subordinated UI elements for texts in languages which require a specific text direction. The textDirection property can be filled with the following values and is represented by the enumeration type WDTextDirection.

inherit	The text direction is inherited from the parent element. Therefore, the text direction is identical to the one of the parent element.
ltr	The text runs from left to right.
rtl	The text runs from right to left.

The default value for this property is inherit.

Overview of Inherited and Additional Properties

Name	Interface	Type	Initial Value	Bindable	Value Required
enabled	IWDUIElement	boolean	true	bindable	No
imageFirst	IWDAbstractCaption	boolean	true	bindable	No
imageSource	IWDAbstractCaption	String		bindable	No
textDirection	IWDAbstractCaption	WDTextDirection	inherit	bindable	No
tooltip	IWDUIElement	String		bindable	No
visible	IWDUIElement	WDVisibility	visible	bindable	No