Web
Dynpro UIElementContainer API - IWDUIElementContainer 
Definition
The UIElementContainer UI element is the abstract base class of a container that can contain any number of UI elements known as children of the container. The size of a container is specified using the properties width and heigth whose values can be specified in CSS units (px, em, or percentage).
The display of the container children within the container is specified by the layout object.
In addition, the Web Dynpro LayoutData API provides the UI element with layout data that belongs to the layout. Layout data defines the layout properties of the child element.
Description of UI Element Properties
·
height
Describes the height of the
container in CSS units like em, ex, or percentage.
·
width
Describes the width of the
container in CSS units like em, ex, or percentage.
Overview of Inherited and Additional Properties
Name |
Interface |
Type |
Initial Value |
Bindable |
Value Required |
IWDUIElement |
boolean |
true |
bindable |
No |
|
height |
IWDUIElementContainer |
String (CSS size) |
|
bindable |
No |
IWDUIElement |
String (TranslatableText) |
|
bindable |
No |
|
IWDUIElement |
WDVisibility |
visible |
bindable |
No |
|
width |
IWDUIElementContainer |
String (CSS size) |
|
bindable |
No |
Methods in the Web Dynpro IWDUIElementContainer API
Method Name |
Parameter |
Return Value |
Short Description |
addChild |
(IWDUIElement child) |
|
Adds a child element at the end of the child elements list. |
addChild |
(IWDUIElement child, int index) |
|
Adds a child element at the specified index position of the child elements list. |
bindHeight |
(String path) |
|
Binds the value of the height property to the context element specified by the path. |
bindingOfHeight |
|
String |
Returns the path of the context element to which the height property is bound. Returns NULL if no binding exists. |
bindingOfWidth |
|
String |
Returns the path of the context element to which the width property is bound. Returns NULL if no binding exists. |
bindWidth |
(String path) |
|
Binds the value of the width property to the context element specified by the path. |
createLayout |
(Class layoutInterface) |
IWDLayout |
Creates a layout element of the specified type and sets it for this container. |
destroyAllChildren |
|
|
Removes all child elements. They are destroyed, which means that their IDs can be used for new elements. |
getChildren |
|
IWDUIElement[] |
Returns an array of the child elements. |
getHeight |
|
String |
Returns the value of the height property. |
getLayout |
|
IWDLayout |
Returns the layout for this UIElementContainer element. |
getWidth |
|
String |
Returns the value of the width property. |
hasChildren |
|
boolean |
Checks whether or not child elements exist in this UIElementContainer element. |
iterateChildren |
|
Iterator |
Returns an iterator about all child elements in this UIElementContainer element. |
numberOfChildren |
|
int |
Returns the number of the child elements. |
removeAllChildren |
|
|
Removes all child elements. They remain and can be added to this UIElementContainer element. |
removeChild |
int index |
IWDUIElement |
Removes the child element at the specified index position. |
removeChild |
String id |
IWDUIElement |
Removes the child element with the specified ID. |
setHeight |
(String value) |
|
Sets the value of the height property. |
setWidth |
(String value) |
|
Sets the value of the width 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.