Web
Dynpro ToolBar API - IWDToolBar 
Definition
The Toolbar UI element is a collection of tools that can be accessed using UI elements. A toolbar can contain the following elements:
These toolbar elements are horizontally arranged in one row of the toolbar. The size and position of the individual UI elements are automatically calculated.
The following graphic shows the toolbar within a Tray UI element.
Therefore, toolbars provide are an additional way of grouping UI elements functionally. UI elements can be wrapped automatically if the toolbar space is too small for the display in one line.
The toolbar is not an independent UI element. It can only be used in specific UI elements such as Group, Tab, Table, and Tray.
Use
The toolbar should be used if you want to provide a set of actions that belong together logically.
Description of the UI Element Properties
·
design
Specifies the display style of the toolbar on the screen. The design property is represented by the enumeration
type WDToolBarDesign and has the values:
emphasized |
Highlights the toolbar. |
Standard |
Displays the toolbar in the standard design. |
·
enabled
Specifies whether or not the
toolbar is activated. If you deactivate the toolbar, all elements of the
toolbar are deactivated. Some renderer implementations
can ignore this behavior.
·
visible
Specifies whether or not the
toolbar is displayed on the screen.
blank |
The UI element is not visible on the screen. This value has the same visibility effect for the UI element on the screen as the value none. |
none |
The UI element is not visible on the screen. |
visible |
The UI element is visible on the screen. |
·
wrapping
Specifies whether or not the
ToolBar elements can be wrapped.
Overview of Inherited and Additional Properties
Name |
Interface |
Type |
Initial Value |
Bindable |
Value Required |
design |
IWDToolBar |
WDToolBarDesign |
Standard |
bindable |
No |
enabled |
IWDToolBar |
boolean |
true |
bindable |
No |
visible |
IWDToolBar |
WDVisibility |
visible |
bindable |
No |
wrapping |
IWDToolBar |
boolean |
true |
bindable |
No |
Methods in the Web Dynpro IWDToolBar API
Method Name |
Parameter |
Return Value |
Description |
addToolBarItem |
(IWDToolBarItem toolBarItem) |
|
Adds a ToolBarItem element at the end of the ToolBarItem elements list. |
addToolBarItem |
(IWDToolBarItem toolBarItem, int index) |
|
Adds a ToolBarItem element at the specified index position of the ToolBarItem elements list. |
addToolBarRightItem |
(IWDToolBarItem toolBarRightItem) |
|
Adds a ToolBarRightItem element at the end of the ToolBarRightItem elements list. |
addToolBarRightItem |
(IWDToolBarItem toolBarRightItem, int index) |
|
Adds a ToolBarRightItem element at the specified index position of the ToolBarRightItem elements list. |
bindDesign |
(String path) |
|
Binds the value of the design property to the context element specified by the path. |
bindEnabled |
(String path) |
|
Binds the value of the enabled property to the context 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. |
bindingOfEnabled |
|
String |
Returns the path of the context element to which the enabled 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. |
bindingOfWrapping |
|
String |
Returns the path of the context element to which the wrapping property is bound. Returns NULL if no binding exists. |
bindVisible |
(String path) |
|
Binds the value of the visible property to the context element specified by the path. |
bindWrapping |
(String path) |
|
Binds the wrapping property to the context node specified by a path. |
destroyAllToolBarItems |
|
|
Removes all ToolBarItem elements. These are destroyed and no longer exist, so that the associated IDs can be used for new elements. |
destroyAllToolBarRightItems |
|
|
Removes all ToolBarRightItem elements. These are destroyed and no longer exist, so that the associated IDs can be used for new elements. |
getDesign |
|
WDToolBarDesign |
Returns the value of the design property. |
getEnabled |
|
boolean |
Returns the value of the enabled property. |
getToolBarItems |
|
IWDToolBarItem[] |
Returns an array of the ToolBarItem elements. |
getToolBarRightItems |
|
IWDToolBarItem[] |
Returns an array of the ToolBarRightItem elements. |
getVisible |
|
WDVisibility |
Returns the value of the visible property. |
getWrapping |
|
boolean |
Returns the value of the wrapping property. |
hasToolBarItems |
|
boolean |
Checks whether or not ToolBarItem elements exist in this ToolBar element. |
hasToolBarRightItems |
|
boolean |
Checks whether or not ToolBarRightItem elements exist in this ToolBar element. |
iterateToolBarItems |
|
Iterator |
Returns an iterator about all ToolBarItem elements in this ToolBar element. |
iterateToolBarRightItems |
|
Iterator |
Returns an iterator about all ToolBarRightItem elements in this ToolBar element. |
numberOfToolBarItems |
|
int |
Returns the number of the ToolBarItem elements. |
numberOfToolBarRightItems |
|
int |
Returns the number of the ToolBarRightItem elements. |
removeAllToolBarItems |
|
|
Removes all ToolBarItem elements. They remain and can be added to this ToolBar element. |
removeAllToolBarRightItems |
|
|
Removes all ToolBarRightItem elements. They remain and can be added to this ToolBar element. |
removeToolBarItem |
(int index) |
IWDToolBarItem |
Removes the ToolBarItem element at the specified index position. |
removeToolBarItem |
(String id) |
IWDToolBarItem |
Removes the ToolBarItem element with the specified ID. |
removeToolBarRightItem |
(int index) |
IWDToolBarItem |
Removes the ToolBarRightItem element at the specified index position. |
removeToolBarRightItem |
(String id) |
IWDToolBarItem |
Removes the ToolBarRightItem element with the specified ID. |
setDesign |
(WDToolBarDesign design) |
|
Sets the value of the design property. |
setEnabled |
(Boolean enabled) |
|
Sets the value of the enabled property. |
setVisible |
(WDVisibility visible) |
|
Sets the value of the visible property. |
setWrapping |
(boolean wrapping) |
|
Sets the value of the wrapping property. |
Additional methods described in the following APIs are available using inheritance: IWDViewElement.