Web
Dynpro TabStrip API - IWDTabStrip 
Definition
The TabStrip UI element allows the display of a tab. The user can toggle between several tab pages by selecting a specific tab title. The same window is shared by all tab pages and used for displaying the content. The user can display the content of a tab by selecting a tab title.
The following graphic shows how the UI element is displayed visually:
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.
·
height
Specifies the height of the
tab and its tab pages. You can specify the height in CSS units like em, ex,
pixels, or percentage.
·
selectedTab
The ID of the selected tab
page.
·
width
Specifies the width of the register and its tab pages. You can specify the
width in CSS units like em, ex, pixels, or percentage.
Overview of Inherited and Additional Properties
Name |
Interface |
Type |
Initial Value |
Bindable |
Value Required |
accessibilityDescription |
IWDTabStrip |
String (Translatable Text) |
|
bindable |
No |
IWDUIElement |
boolean |
true |
bindable |
No |
|
height |
IWDTabStrip |
String (CSS size) |
|
bindable |
No |
selectedTab |
IWDTabStrip |
String |
|
bindable |
No |
IWDUIElement |
String (TranslatableText) |
|
bindable |
No |
|
IWDUIEelement |
WDVisibility |
visible |
bindable |
No |
|
width |
IWDTabStrip |
String (CSS size) |
|
bindable |
No |
The tooltip property is ignored and does not affect the browser.
Events
·
onSelect
Describes the action that is
executed when the user selects a tab page.
Event Parameter |
Type |
tab |
String |
See 
Parameter
Mapping.
Mobile Characteristics
The UI element TabStrip 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 |
enabled |
ignored |
height |
ignored‑{}‑ |
tooltip |
ignored |
width |
ignored |
Methods in the Web Dynpro IWDTabStrip API
Method Name |
Parameter |
Return Value |
Description |
addTab |
(IWDTab tab) |
|
Adds a tab element at the end of the tab elements list. |
addTab |
(IWDTab tab, int index) |
|
Adds a tab element at the specified index position of the tab elements list. |
bindAccessibilityDescription |
(String path) |
|
Binds the accessibilityDescription property to the context node specified by a path. |
bindHeight |
(String path) |
|
Binds the value of the height property to the context 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. |
bindingOfHeight |
|
String |
Returns the path of the content element to which the height property is bound. Returns NULL if no binding exists. |
bindingOfSelectedTab |
|
String |
Returns the path of the context element to which the selectedTab 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. |
bindSelectedTab |
(String path) |
|
Binds the value of the selectedTab property to the context element specified by the path. |
bindWidth |
(String path) |
|
Binds the value of the width property to the context element specified by the path. |
destroyAllTabs |
|
|
Removes all tab elements. These are destroyed and no longer exist, so that the associated IDs can be used for new elements. |
getAccessibilityDescription |
|
String |
Returns the value of the accessibilityDescription property. |
getHeight |
|
String |
Returns the value of the height property. |
getOnSelect |
|
IWDAction |
Returns the action that is executed when the onSelect event is triggered. |
getSelectedTab |
|
String |
Returns the value of the selectedTab property. |
getTabs |
|
IWDTab [] |
Returns an array of the tab elements. |
getWidth |
|
String |
Returns the value of the width property. |
hasTabs |
|
boolean |
Checks whether or not tab elements exist in this TabStrip element. |
iterateTabs |
|
Iterator |
Returns an iterator about all tab elements in this TabStrip element. |
mappingOfOnSelect |
|
IWDParameterMapping |
Returns the parameter mapping for the onSelect action. |
numberOfTabs |
|
int |
Returns the number of the tab elements. |
removeAllTabs |
|
|
Removes all tab elements. They remain and can be added to this TabStrip element. |
removeTab |
(int index) |
IWDTab |
Removes the tab element at the specified index position. |
removeTab |
(String id) |
IWDTab |
Removes the tab element with the specified ID. |
setAccessibilityDescription |
(String accessibilityDescription) |
|
Sets the value of the accessibilityDescription property. |
setHeight |
(String height) |
|
Sets the value of the height property. |
setOnSelect |
(IWDAction action) |
|
Sets the action that is executed when the onSelect event is triggered. |
setSelectedTab |
(String selectedTab) |
|
Sets the value of the selectedTab property. |
setWidth |
(String width) |
|
Sets the value of the width property. |
Additional methods described in the following APIs are available using inheritance:
For detailed documentation of all inherited methods, see the documentation for the relevant APIs.