Web Dynpro Group API - IWDGroup 
Definition
The Group UI element is a UI element container and can be used to group multipe UI elements under one common title. The following diagram shows that the UI element resembles a display panel with a colored background.
The Group UI element with the default design primarycolor:
Description of the UI Element Property
·
design
Describes the appearance of
the Group UI element. The designproperty can be filled with the following values and
is represented by the enumeration type WDGroupDesign.
primarycolor |
The group panel has the same background color as the title bar (color of the primary group). |
sapcolor |
The title bar and the borders around the panel have the blue SAP color. The background color of the panel is white. |
secondarybox |
The panel does not have borders. |
secondaryboxcolor |
The background color of the panel is different from the background color of the title bar. |
secondarycolor |
The panel has the same background color as the title bar (color of the secondary group). You can use this value when you want to display subgroups within a group. |
·
hasContentPadding
Specifies whether or not it is possible to insert padding between content and
UI element borders.
Overview of Inherited and Additional Properties
Name |
Interface |
Type |
Initial Value |
Bindable |
Value Required |
IWDGroup |
WDGroupDesign |
primarycolor |
bindable |
No |
|
IWDUIElement |
boolean |
true |
bindable |
No |
|
hasContentPadding |
IWDGroup |
boolean |
true |
bindable |
No |
IWDUIElementContainer |
String (CSS size) |
|
bindable |
No |
|
IWDScrollContainer |
WDScrollingMode |
none |
bindable |
No |
|
IWDUIElement |
String (TranslatableText) |
|
bindable |
No |
|
IWDUIElement |
WDVisibility |
visible |
bindable |
No |
|
IWDUIElementContainer |
String (CSS size) |
|
bindable |
No |
The inherited enabled property is ignored and does not affect the browser. The label in the header of the Group UI element can be hidden by setting the value of the visible property for the header to none.
Mobile Characteristics
The UI element Group supports the development of mobile applications for pocket PCs and BlackBerry wireless handhelds (see Mobile Web Dynpro).
However, several properties supported in the desktop browser cannot be used. These include:
Variances of the properties
Properties |
Pocket PC |
BlackBerry wireless handheld |
design |
ignored |
ignored |
enabled |
ignored |
ignored |
hasContentPadding |
ignored |
ignored |
scrollingMode |
ignored |
ignored |
tooltip |
ignored |
ignored |
Methods in the Web Dynpro IWDGroup API
Method Name |
Parameter |
Return Value |
Short Description |
bindDesign |
(String path) |
|
Binds the value of the design property to the context element specified by the path. |
bindHasContentPadding |
(String path) |
|
Binds the value of the hasContentPadding property to the content element specified by the path. |
bindingOfDesign |
|
String |
Returns the path of the context element to which the design property is bound. Returns NULL if no binding exists. |
bindingOfHasContentPadding |
|
String |
Returns the path of the content element to which the hasContentPadding property is bound. Returns NULL if no binding exists. |
destroyHeader |
|
|
Removes and deletes the header for this Group element. |
destroyToolBar |
|
|
Removes and deletes the toolbar for this Group element. |
getDesign |
|
WDGroupDesign |
Returns the value of the design property. |
getHasContentPadding |
|
boolean |
Returns the value of the hasContentPadding property. |
getHeader |
|
IWDCaption |
Returns the header for this Group element. |
getToolBar |
|
IWDToolBar |
Returns the toolbar for this Group element. |
setDesign |
(WDGroupDesign value) |
|
Sets the value of the design property. |
setHasContentPadding |
(boolean value) |
|
Sets the value of the hasContentPadding property. |
setHeader |
(IWDCaption header) |
|
Sets the header for this Group element. |
setToolBar |
(IWDToolBar toolBar) |
|
Sets the toolbar for this Group element. |
Additional methods are available using inheritance:
IWDScrollContainer, IWDUIElement, IWDUIElementContainer, IWDViewElement.
For detailed documentation of all inherited methods, see the documentation for the relevant APIs.