Web Dynpro RoadMapStep –
IWDRoadMapStep 
Definition
The RoadMapStep element represents a step in a RoadMap UI element. The following graphic shows how the UI element is displayed:
Description of the UI Element Properties
·
description
Allows you to display a text between two RoadMap steps.
·
design
Specifies the design of the RoadMap step.
The design property can be filled with the following values
and is represented by the enumeration type WDRoadMapStepDesign.
disabled |
The RoadMapStep element is displayed in gray. |
roundtrip |
The RoadMapStep element is displayed in yellow with arrow symbols to indicate a round trip. |
selected |
The RoadMapStep element is highlighted in orange. |
standard |
The RoadMapStep element is displayed in blue. |
·
name
Allows you to specify a label for the RoadMapStep, which is displayed
in the RoadMapStep itself.
·
tooltip
Describes a note for the
RoadMapStep. The note is displayed when the user places the cursor on the UI
element.
Overview of Inherited and Additional Properties
Name |
Interface |
Type |
Initial Value |
Bindable |
Value Required |
description |
IWDRoadMapStep |
String (TranslatableText) |
|
bindable |
No |
design |
IWDRoadMapStep |
WDRoadMapStepDesign |
standard |
bindable |
No |
name |
IWDRoadMapStep |
String (TranslatableText) |
|
bindable |
No |
tooltip |
IWDRoadMapStep |
String (TranslatableText) |
|
bindable |
No |
Web Dynpro IWDRoadMapStep API Methods
Method Name |
Parameter |
Return Value |
Short Description |
bindDescription |
(String path) |
|
Binds the value of the description property to the context element specified by the path. |
bindDesign |
(String path) |
|
Binds the value of the design property to the context element specified by the path. |
bindingOfDescription |
|
String |
Returns the path of the context element to which the description 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. |
bindingOfName |
|
String |
Returns the path of the context element to which the name property is bound. Returns NULL if no binding exists. |
bindingOfTooltip |
|
String |
Returns the path of the context element to which the tooltip property is bound. Returns NULL if no binding exists. |
bindName |
(String path) |
|
Binds the value of the name property to the context element specified by the path. |
bindTooltip |
(String path) |
|
Binds the value of the tooltip property to the context element specified by the path. |
getDescription |
|
String |
Returns the value of the description property. |
getDesign |
|
WDRoadMapStepDesign |
Returns the value of the design property. |
getName |
|
String |
Returns the value of the name property. |
getTooltip |
|
String |
Returns the value of the tooltip property. |
setDescription |
(String value) |
|
Sets the value of the description property. |
setDesign |
(WDRoadMapStepDesign value) |
|
Sets the value of the design property. |
setName |
(String value) |
|
Sets the value of the name property. |
setTooltip |
(String tooltip) |
|
Sets the value of the tooltip 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.