Web Dynpro UIElement API –
IWDUIElement 
Definition
Along with the ViewElement class, the UIElement class is one of the abstract base classes of all UI elements. All UI elements that can be used within Web Dynpro have three generic properties that the UIElement object passes on to the UI element subclasses. This abstract UI element also allows you to access the LayoutData object that can be used to describe the alignment of one UI element with another UI element.
The term UI element stands for a stand-alone user interface element that can be stored in a general container. Whereas view element also stands for subelements of composite UI elements. TabStrip, for example, is a UI element. The subelement Tab is a view element because it cannot be used independently. It is only used to build up a TabStrip UI element. Therefore, the subelement Tab is not a UI element.
Description of UI Element Properties
·
enabled
Specifies whether or not an
event can be triggered by a user interaction.
·
tooltip
Describes a note for the UI
element that is displayed when the user places the cursor on the UI
element.
·
visible
Specifies the visibility of
the UI element. The default value of this property is visible.
Overview of Inherited and Additional Properties
Name |
Interface |
Type |
Initial Value |
Bindable |
Value Required |
enabled |
IWDUIElement |
boolean |
true |
bindable |
No |
tooltip |
IWDUIElement |
String (TranslatableText) |
|
bindable |
No |
visible |
IWDUIElement |
WDVisibility |
visible |
bindable |
No |
Methods in the Web Dynpro IWDUIElement API
Method Name |
Parameter |
Return Value |
Short Description |
bindEnabled |
(String path) |
|
Binds the value of the enabled property to the context element specified by the path. |
bindingOfEnabled |
|
String |
Returns the path of the context element to which the enabled property is bound. Returns NULL if no binding exists. |
bindingOfTooltip |
|
String |
Returns the path of the context element to which the tooltip property is bound. Returns NULL if no binding exists. |
bindingOfVisible |
|
String |
Returns the path of the context element to which the visible property is bound. Returns NULL if no binding exists. |
bindTooltip |
(String path) |
|
Binds the value of the tooltip property to the context element specified by the path. |
bindVisible |
(String path) |
|
Binds the value of the visible property to the context element specified by the path. |
createLayoutData |
(Class layoutDataInterface) |
IWDLayoutData |
Creates a LayoutData element of the specified type and sets it for this UI element. |
getContainer |
|
IWDUIElementContainer |
Returns the container element in which this UI element is contained. |
getEnabled |
|
boolean |
Returns the value of the enabled property. |
getLayoutData |
|
IWDLayoutData |
Returns a LayoutData element for this UI element. |
getTooltip |
|
String |
Returns the value of the tooltip property. |
getVisible |
|
WDVisibility |
Returns the value of the visible property. |
setEnabled |
(boolean value) |
|
Sets the value of the enabled property. |
setTooltip |
(String value) |
|
Sets the value of the tooltip property. |
setVisible |
(WDVisibility value) |
|
Sets the value of the visible property. |
Additional methods are available using inheritance: IWDViewElement.