RoadMap (SAP Library - Web Dynpro for ABAP)

RoadMap

The RoadMap UI element displays the steps in a wizard. Each step is represented by a separate RoadMapStep Object or MultipleRoadMapStep. You can use various symbols to mark the start points and the end points of this UI element. 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.

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.

Example of the Display

This graphic is explained in the accompanying text

Note

If the tooltip property has not been set, the property accessibilityDescription is checked during the design time to ensure Accessibility.

Runtime Class

CL_WD_ROAD_MAP

Properties in the View Designer

Name	Type	Initial Value	Bindable
ID	STRING	(automatic)	No
accessibilityDescription	Text		Yes
enabled	WDY_BOOLEAN	true	Yes
endPointDesign	WDUI_ROAD_MAP_EDGE_DESIGN	standard	Yes
selectedStep	STRING		Yes
startPointDesign	WDUI_ROAD_MAP_EDGE_DESIGN	standard	Yes
tooltip	Text		Yes
visible	WDUI_VISIBILITY	visible	Yes

Aggregations in the View Designer

Name	Cardinality	Type
Step	0..n	RoadMapStep

Events in the View Designer

Name

onLoadSteps

onSelect

Note

Further properties that can be inherited are defined in the associated higher-level class. The associated interface elements are:

● UIElement

● ViewElement

Dynamic Programming

For dynamic programming the same properties, events, and aggregations are provided in the View Designer. Bear in mind the different spellings.

Dynamic Programming of Properties

View Designer Name	Runtime Name	Type
accessibilityDescription	ACCESSIBILITY_DESCR	WDY_MD_TRANSLATABLE_TEXT
enabled	ENABLED	WDY_BOOLEAN
endPointDesign	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
selectedStep	SELECTED_STEP	STRING
startPointDesign	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
tooltip	TOOLTIP	WDY_MD_TRANSLATABLE_TEXT
visible	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
onLoadSteps	ON_LOAD_STEPS
onSelect	ON_SELECT

Dynamic Programming of Aggregations

View Designer Name	Runtime Name	Cardinality
Step	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.