Web Dynpro AbstractCaption API – IWDAbstractCaption 

Definition

The AbstractCaption class which implements the IWDAbstractCaption interface, provides an icon for the labeling of UI elements such as Button UI element, Caption UI element, LinkToAction UI element, LinkToURL UI element, or Table UI element.

Description of UI Element Properties

·        imageAlt
Defines an alternative text that is displayed when the corresponding icon is not available or cannot be loaded.

·        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 .

Additional properties are defined in the corresponding superior classes. Refer to IWDUIElement, IWDViewElement.

Overview of Inherited and Additional Properties

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

Subordinated Interfaces

IWDAbstractButton, IWDButton, IWDCaption, IWDFileDownload, IWDLink, IWDLinkToAction, IWDLinkToURL, IWDToolBarButton.

Methods in the Web Dynpro IWDAbstractCaption API

Method Name	Parameter	Return Value	Short Description
bindImageAlt	(String path)		Binds the value of the imageAlt property to the context element specified by the path.
bindImageFirst	(String path)		Binds the value of the imageFirst property to the context element specified by the path.
bindImageSource	(String path)		Binds the value of the imageSource property to the context element specified by the path.
bindingOfImageAlt		String	Returns the path of the context element to which the imageAlt property is bound. Returns NULL if no binding exists.
bindingOfImageFirst		String	Returns the path of the context element to which the imageFirst property is bound. Returns NULL if no binding exists.
bindingOfImageSource		String	Returns the path of the context element to which the imageSource property is bound. Returns NULL if no binding exists.
getImageAlt		String	Returns the value of the imageAlt property.
getImageFirst		boolean	Returns the value of the imageFirst property.
getImageSource		String	Returns the value of the imageSource property.
setImageAlt	(String value)		Sets the value of the imageAlt property.
setImageFirst	(boolean value)		Sets the value of the imageFirst property.
setImageSource	(String value)		Sets the value of the imageSource property.

Additional methods described in the following APIs are available using inheritance: IWDUIElement, IWDViewElement.

For further information about all inherited methods, refer to the documentation for the relevant APIs.