Web Dynpro PhaseIndicator API –
IWDPhaseIndicator 
Definition
Similar to the RoadMap UI element, the PhaseIndicator UI element displays the steps in a wizard. Each step is represented by a separate phase object. The following graphic shows how the UI element is displayed:
Use
As opposed to using the RoadMap UI element, the application development can display larger steps using the PhaseIndicator UI element which may require more time by the user.
Description of UI Element Properties
·
accessibililtyDescription
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.
·
backgroundDesign
Specifies the background
color. The backgroundDesignproperty can be filled with the following values and
is represented by the enumeration type WDPhaseIndicatorBackgroundDesign.
emphasized |
The background is colored. |
transparent |
The background is transparent. |
·
firstVisiblePhase
Contains the ID of the first visible phase.
·
selectedPhase
Contains the ID of the
selected phase.
Overview of Inherited and Additional Properties
Name |
Interface |
Type |
Initial Value |
Bindable |
Value Required |
accessibilityDescription |
IWDPhaseIndicator |
String |
|
bindable |
No |
backgroundDesign |
IWDPhaseIndicator |
WDPhaseIndicatorBackgroundDesign |
emphasized |
bindable |
No |
IWDUIElement |
boolean |
true |
bindable |
No |
|
firstVisiblePhase |
IWDPhaseIndicator |
String |
|
bindable |
No |
selectedPhase |
IWDPhaseIndicator |
String |
|
bindable |
No |
IWDUIElement |
String |
|
bindable |
No |
|
IWDUIElement |
WDVisibility |
visible |
bindable |
No |
Events
·
onSelect
The property contains the
action that is executed when the phase is selected. The event parameter is the
ID of the selected phase.
Event Parameter |
Type |
phase |
String |
See 
Parameter
Mapping.
Methods in the Web Dynpro IWDPhaseIndicator API
Method Name |
Parameter |
Return Value |
Description |
addPhase |
(IWDPhase phase) |
|
Adds a phase element at the end of the phase elements list. |
addPhase |
(IWDPhase phase, int index) |
|
Adds a phase element at the specified index position of the phase elements list. |
bindAccessibilityDescription |
(String path) |
|
Binds the accessibilityDescription property to the context node specified by a path. |
bindBackgroundDesign |
(String path) |
|
Binds the backgroundDesign property to the context node specified by a path. |
bindFirstVisiblePhase |
(String path) |
|
Binds the firstVisiblePhase property to the context node specified by a path. |
bindingOfAccessibilityDescription |
|
String |
Returns the path of the context element to which the accessibilityDescription property is bound. Returns NULL if no binding exists. |
bindingOfBackgroundDesign |
|
String |
Returns the path of the context element to which the backgroundDesign property is bound. Returns NULL if no binding exists. |
bindingOfFirstVisiblePhase |
|
String |
Returns the path of the context element to which the firstVisiblePhase property is bound. Returns NULL if no binding exists. |
bindingOfSelectedPhase |
|
String |
Returns the path of the context element to which the selectedPhase property is bound. Returns NULL if no binding exists. |
bindSelectedPhase |
(String path) |
|
Binds the selectedPhase property to the context node specified by a path. |
destroyAllPhases |
|
|
Removes all phase elements. They are destroyed, which means that their IDs can be used for new elements. |
getAccessibilityDescription |
|
String |
Returns the value of the accessibilityDescription property. |
getBackgroundDesign |
|
WDPhaseIndicatorBackgroundDesign |
Returns the value of the backgroundDesign property. |
getFirstVisiblePhase |
|
String |
Returns the value of the firstVisiblePhase property. |
getOnSelect |
|
IWDAction |
Returns the action that is executed when the onSelect event is triggered. |
getPhases |
|
IWDPhase[] |
Returns an array of the phase elements. |
getSelectedPhase |
|
String |
Returns the value of the selectedPhase property. |
hasPhases |
|
boolean |
Checks whether or not phase elements exist in this phase element. |
iteratePhases |
|
Iterator |
Returns an iterator over all the phase elements in this phase element. |
mappingOfOnSelect |
|
IWDParameterMapping |
Returns the parameter mapping for the onSelect action. |
numberOfPhases |
|
int |
Returns the number of the phase elements. |
removeAllPhases |
|
|
Removes all phase elements. They remain and can be added to this PhaseIndicator element. |
removePhase |
(int index) |
IWDPhase |
Removes the phase element at the specified index position. |
removePhase |
(String id) |
IWDPhase |
Removes the phase element with the specified ID. |
setAccessibilityDescription |
(String accessibilityDescription) |
|
Sets the value of the accessibilityDescription property. |
setBackgroundDesign |
(WDPhaseIndicatorBackgroundDesign backgroundDesign) |
|
Sets the value of the backgroundDesign property. |
setFirstVisiblePhase |
(String firstVisiblePhase) |
|
Sets the value of the firstVisiblePhase property. |
setOnSelect |
(IWDAction action) |
|
Sets the action that is executed when the onSelect event is triggered. |
setSelectedPhase |
(String selectedPhase) |
|
Sets the value of the selectedPhase property. |
Additional methods described in the following APIs are available using inheritance: IWDUIElement, IWDViewElement.