Start of Content Area

Background documentation RoadMap Locate the document in its SAP Library structure

The RoadMap UI element displays the steps followed in a wizard. Each step is represented by a separate Structure linkRoadMapStep Object or Structure linkMultipleRoadMapStep. You can use various symbols to mark the start points and the end points of this UI element. If you assign the value more to the property startPointDesign or endPointDesign, this indicates to the user that there are other steps before the first visible step, or after the last visible step.

The RoadMap UI element is used to display step by step workflows. This enables an application development team to display small steps of a clearly defined work process.

Example of the Visual Display

This graphic is explained in the accompanying text

Note

To enable the development of Structure linkaccessible applications, the accessibilityDescription property is checked during the syntax check if the tooltip property is not set.

 

Runtime Class

CL_WD_ROAD_MAP

 

Properties in View Designer

Name

Type

Initial Value

Bindable

ID

STRING

(automatic)

no

Structure linkaccessibilityDescription

Translatable text

 

yes

Structure linkenabled

WDY_BOOLEAN

true

yes

Structure linkendPointDesign

WDUI_ROAD_MAP_EDGE_DESIGN

standard

yes

Structure linkselectedStep

STRING

 

yes

Structure linkstartPointDesign

WDUI_ROAD_MAP_EDGE_DESIGN

standard

yes

Structure linktooltip

Translatable text

 

yes

Structure linkvisible

WDUI_VISIBILITY

visible

yes

 

Aggregations in View Designer

Name

Cardinality

Type

Structure linkStep

0..n

Structure linkRoadMapStep

 

Events in View Designer

Name

Structure linkonLoadSteps

Structure linkonSelect

Note

Other properties that can be inherited are defined in the associated higher-level classes. The associated UI elements are:

      Structure linkUIElement

      Structure linkViewElement

 

Dynamic Programming

For dynamic programming, the same properties, events and aggregations as in the view designer are available . Bear in mind the different spellings.

Dynamic Programming of Properties

View Designer Name

Runtime Name

Type

Structure linkaccessibilityDescription

ACCESSIBILITY_DESCR

WDY_MD_TRANSLATABLE_TEXT

Structure linkenabled

ENABLED

WDY_BOOLEAN

Structure linkendPointDesign

END_POINT_DESIGN

WDUI_ROAD_MAP_EDGE_DESIGN

 endPointDesign: disabled

CL_WD_ROAD_MAP=>E_END_POINT_DESIGN-DISABLED

 endPointDesign: more

CL_WD_ROAD_MAP=>E_END_POINT_DESIGN-MORE

 endPointDesign: moreDisabled

CL_WD_ROAD_MAP=>E_END_POINT_DESIGN-MORE_DISABLED

 endPointDesign: selected

CL_WD_ROAD_MAP=>E_END_POINT_DESIGN-SELECTED

 endPointDesign: standard

CL_WD_ROAD_MAP=>E_END_POINT_DESIGN-STANDARD

Structure linkselectedStep

SELECTED_STEP

STRING

Structure linkstartPointDesign

START_POINT_DESIGN

WDUI_ROAD_MAP_EDGE_DESIGN

 startPointDesign: disabled

CL_WD_ROAD_MAP=>E_START_POINT_DESIGN-DISABLED

 startPointDesign: more

CL_WD_ROAD_MAP=>E_START_POINT_DESIGN-MORE

 startPointDesign: moreDisabled

CL_WD_ROAD_MAP=>E_START_POINT_DESIGN-MORE_DISABLED

 startPointDesign: selected

CL_WD_ROAD_MAP=>E_START_POINT_DESIGN-SELECTED

 startPointDesign: standard

CL_WD_ROAD_MAP=>E_START_POINT_DESIGN-STANDARD

Structure linktooltip

TOOLTIP

WDY_MD_TRANSLATABLE_TEXT

Structure linkvisible

VISIBLE

WDUI_VISIBILITY

visible: none

CL_WD_ROAD_MAP=>E_VISIBLE-NONE

visible: visible

CL_WD_ROAD_MAP=>E_VISIBLE-VISIBLE

 

Dynamic Programming of Events

View Designer Name

Runtime Name

Structure linkonLoadSteps

ON_LOAD_STEPS

Structure linkonSelect

ON_SELECT

 

Dynamic Programming of Aggregations

View Designer Name

Runtime Name

Cardinality

Structure linkStep

STEPS

0..n

Example

You can find examples of this interface element in the system in the Web Dynpro application WDR_TEST_UI_ELEMENTS, and in the component WDR_TEST_EVENTS in the view ROADMAP. You can find simple example in the system in the Web Dynpro application, DEMO_ROADMAP.

 

 

End of Content Area