Web
Dynpro RoadMap API – IWDRoadMap 
Definition
The RoadMap UI element displays the steps in a wizard. Each step is represented by a separate RoadMapStep Object. You can tag the starting point and endpoint of this UI element using different symbols, which are defined by the enumeration typeWDRoadMapEdgeDesign. Assigning the value more to the property startPointDesign or endPointDesign indicates to the user that there are other steps before the first visible step, or after the last visible step.
Use
The RoadMap UI element is used to display step by step workflows. This enables the application development to display small steps of a clearly defined work process.
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.
·
endPointDesign
Specifies the design of the last step of the RoadMap element.
The endPointDesign property can be filled with the following values
and is represented by the enumeration type WDRoadMapEdgeDesign that specifies the display of the borders of a
RoadMap UI element – that is, its starting points and end points.
more |
|
Indicates that there are more steps still to come in the process. |
selected |
|
You can highlight the end point in a different color (that is, as if it were selected) – for example, to show that there is an informative text attached to it. |
standard |
|
The default display for the end point of a RoadMap UI element. |
·
startPointDesign
Specifies the design of the first step of the RoadMap UI element.
The startPointDesign property can be filled with the following values
and is represented by the enumeration type WDRoadMapEdgeDesign.
more |
|
Indicates that more steps preceded this step. |
selected |
|
You can highlight the end point in a different color – that is as if it were selected), to show that there is an informative text attached to it. |
standard |
|
The default display for the starting point of a RoadMap UI element. |
Overview of Inherited and Additional Properties
Name |
Interface |
Type |
Initial Value |
Bindable |
Value Required |
accessibilityDescription |
IWDRoadMap |
String (Translatable Text) |
|
bindable |
No |
IWDUIElement |
boolean |
true |
bindable |
No |
|
endPointDesign |
IWDRoadMap |
WDRoadMapEdgeDesign |
|
bindable |
No |
startPointDesign |
IWDRoadMap |
WDRoadMapEdgeDesign |
|
bindable |
No |
IWDUIElement |
String (TranslatableText) |
|
bindable |
No |
|
IWDUIElement |
WDVisibility |
visible |
bindable |
No |
Methods in the Web Dynpro IWDRoadMap API
Method Name |
Parameter |
Return Value |
Description |
addStep |
(IWDRoadMapStep step) |
|
Adds a step element to the end of the step elements list. |
addStep |
(IWDRoadMapStep step, int index) |
|
Adds a step element to the step elements list at the specified index position. |
bindAccessibilityDescription |
(String path) |
|
Binds the accessibilityDescription property to the context node specified by a path. |
bindEndPointDesign |
(String path) |
|
Binds the value of the endPointDesign 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. |
bindingOfEndPointDesign |
|
String |
Returns the path of the context element to which the endPointDesign property is bound. Returns NULL if no binding exists. |
bindingOfStartPointDesign |
|
String |
Returns the path of the context element to which the startPointDesign property is bound. Returns NULL if no binding exists. |
bindStartPointDesign |
(String path) |
|
Binds the value of the startPointDesign property to the context element specified by the path. |
destroyAllSteps |
|
|
Removes all step 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. |
getEndPointDesign |
|
WDRoadMapEdgeDesign |
Returns the value of the endPointDesign property. |
getStartPointDesign |
|
WDRoadMapEdgeDesign |
Returns the value of the startPointDesign property. |
getSteps |
|
IWDRoadMapStep[] |
Returns an array of step elements. |
hasSteps |
|
boolean |
Checks whether stepelement ments exist in this RoadMap element. |
iterateSteps |
|
Iterator |
Returns an iterator over all the step elements in this RoadMap element. |
numberOfSteps |
|
int |
Returns the number of the step elements. |
removeAllSteps |
|
|
Removes all step elements. These are retained, and can later be added to this RoadMap element. |
removeStep |
(int index) |
IWDRoadMapStep |
Removes the step element at the specified index position. |
removeStep |
(String id) |
IWDRoadMapStep |
Removes the step element with the specified ID. |
setAccessibilityDescription |
(String accessibilityDescription) |
|
Sets the value of the accessibilityDescription property. |
setEndPointDesign |
(WDRoadMapEdgeDesign endPointDesign) |
|
Sets the value of the endPointDesign property. |
setStartPointDesign |
(WDRoadMapEdgeDesign startPointDesign) |
|
Sets the value of the startPointDesign 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.