Web Dynpro Tray API - IWDTray 
Definition
The Tray UI element is a UI element container like the group UI element container and can be used to group a set of UI elements under one common title. Unlike the group UI element it provides additional functions. For example, the tray UI element can be displayed or hidden.
A tray may have an optional menu represented by the Menu-Element.
The following graphic shows how the UI element is displayed when a Menu UI element is used within the Tray UI element.
Description of the UI Element Properties
·
accessibilityDescription
When accessibility is activated, the assigned text is added to the tooltip.
This description provides semantic details of the UI element and is only read
by the screen reader if the user focuses the complete Ul element.
·
design
Describes the appearance of
the Tray UI element. The designproperty can be filled with the following values and
is represented by the enumeration type WDTrayDesign.
fill |
The content area appears with a background color. |
plain |
The content area appears with a white background and a frame. |
transparent |
The background is transparent; the content area appears without a frame. |
·
expanded
Specifies whether the Tray UI
element is expanded. If the Boolean value is false, only the tray
heading with an expand button is displayed. The toolbar and content area are
invisible in this state. Pressing the button expands the Tray UI element and
the expand button and the expand button changes to a collapse
button.
· Specifies whether there is a padding between the content area and the tray border.
Overview of Inherited and Additional Properties
Name |
Interface |
Type |
Initial Value |
Bindable |
Value Required |
IWDTray |
String (Translatable Text) |
|
bindable |
No |
|
IWDTray |
WDTrayDesign |
transparent |
bindable |
No |
|
IWDUIElement |
boolean |
true |
bindable |
No |
|
expanded |
IWDTray |
boolean |
true |
bindable |
No |
hasContentPadding |
IWDTray |
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 |
Events
· The action that is executed when the user expands or collapses the tray. The event parameter is the new state. The value true means that the tray has been expanded.
Event Parameter |
Type |
expanded |
boolean |
See 
Parameter
Mapping.
Mobile Characteristics
The UI element Tray supports the development of mobile applications for pocket PCs (see Mobile Web Dynpro).
However, several properties supported in the desktop browser cannot be used. These include:
Variances of the properties
Properties |
Pocket PC |
design |
ignored |
enabled |
ignored |
hasContentPadding |
ignored |
height |
ignored |
scrollingMode |
ignored |
tooltip |
ignored |
Methods in the Web Dynpro IWDTray API
Method Name |
Parameter |
Return Value |
Description |
bindAccessibilityDescription |
(String path) |
|
Binds the accessibilityDescription property to the context node specified by a path. |
bindDesign |
(String path) |
|
Binds the value of the design property to the context element specified by the path. |
bindExpanded |
(String path) |
|
Binds the expanded property to the context node specified by a path. |
bindHasContentPadding |
(String path) |
|
Binds the value of the hasContentPadding property to the content element specified by the path. |
bindingOfAccessibilityDescription |
|
String |
Returns the path of the context element to which the accessibilityDescription property is bound. Returns NULL if no binding exists. |
bindingOfDesign |
|
String |
Returns the path of the context element to which the design property is bound. Returns NULL if no binding exists. |
bindingOfExpanded |
|
String |
Returns the path of the context element to which the expanded 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 |
|
|
Destroys and deletes the header of this tray element. |
destroyPopupMenu |
|
|
Destroys and deletes PopupMenu for this tray element. |
destroyToolBar |
|
|
Removes and deletes the toolbar for this Tray element. |
getAccessibilityDescription |
|
String |
Returns the value of the accessibilityDescription property. |
getDesign |
|
WDTrayDesign |
Returns the value of the design property. |
getExpanded |
|
boolean |
Returns the value of the expanded property. |
getHasContentPadding |
|
boolean |
Returns the value of the hasContentPadding property. |
getHeader |
|
IWDCaption |
Returns the header for this Tray element. |
getOnToggle |
|
IWDAction |
Returns the action that is executed when the onToggle event is triggered. |
getPopupMenu |
|
IWDMenu |
Returns the PopupMenu for this Tray element. |
getToolBar |
|
IWDToolBar |
Returns the toolbar for this Tray element. |
mappingOfOnToggle |
|
IWDParameterMapping |
Returns the parameter mapping for the onToggle action. |
setAccessibilityDescription |
(String accessibilityDescription) |
|
Sets the value of the accessibilityDescription property. |
setDesign |
(WDTrayDesign design) |
|
Sets the value of the design property. |
setExpanded |
(boolean expanded) |
|
Sets the value of the expanded property. |
setHasContentPadding |
(boolean hasContentPadding) |
|
Sets the value of the hasContentPadding property. |
setHeader |
(IWDCaption header) |
|
Sets the header for this Tray element. |
setOnToggle |
(IWDAction action) |
|
Sets the action that is executed when the onToggle event is triggered. |
setPopupMenu |
(IWDMenu popupMenu) |
|
Sets the PopupMenu for this Tray element. |
setToolBar |
(IWDToolBar toolBar) |
|
Sets the ToolBar for this Tray 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.