class sap.ui.commons.RoadMap

Control sample: sap.ui.commons.RoadMap
Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/commons/RoadMap
Application Component: CA-UI5-CTR

RoadMap is used to display step-by-step work flows of a clearly defined work process.


Constructor

Constructor for a new RoadMap.

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject#constructor for a general description of the syntax of the settings object.

new sap.ui.commons.RoadMap(sId?, mSettings?)
Param Type Default Value Description
sId? string

ID for the new control, generated automatically if no ID is given

mSettings? object

Initial settings for the new control


Properties

Name Type Default Value Description
firstVisibleStep string

ID of the first step to be displayed

Visibility: public
numberOfVisibleSteps int

Total number of steps to be displayed at once

Visibility: public
selectedStep string

ID of the step which is currently selected

Visibility: public
width sap.ui.core.CSSSize 100%

Determines the control width in CSS size

Visibility: public

Aggregations

Default Aggregation: steps

Name Cardinality Type Description
steps (default) 0..n sap.ui.commons.RoadMapStep

Steps that are composing the RoadMap


Events Overview

Event Description
stepExpanded

Event is fired when a given step is expanded or collapsed by user.

stepSelected

Event is fired when the user selects a step.

stepExpanded

Event is fired when a given step is expanded or collapsed by user.

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
stepId string

ID of the expanded/collapsed step

stepSelected

Event is fired when the user selects a step.

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
stepId string

ID of the selected step


Methods Overview

Method Description
addStep

Adds some step to the aggregation steps.

attachStepExpanded

Attaches event handler fnFunction to the stepExpanded event of this sap.ui.commons.RoadMap.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.commons.RoadMap itself.

Event is fired when a given step is expanded or collapsed by user.

attachStepSelected

Attaches event handler fnFunction to the stepSelected event of this sap.ui.commons.RoadMap.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.commons.RoadMap itself.

Event is fired when the user selects a step.

destroySteps

Destroys all the steps in the aggregation steps.

detachStepExpanded

Detaches event handler fnFunction from the stepExpanded event of this sap.ui.commons.RoadMap.

The passed function and listener object must match the ones used for event registration.

detachStepSelected

Detaches event handler fnFunction from the stepSelected event of this sap.ui.commons.RoadMap.

The passed function and listener object must match the ones used for event registration.

sap.ui.commons.RoadMap.extend

Creates a new subclass of class sap.ui.commons.RoadMap with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.core.Control.extend.

fireStepExpanded

Fires event stepExpanded to attached listeners.

fireStepSelected

Fires event stepSelected to attached listeners.

getFirstVisibleStep

Gets current value of property firstVisibleStep.

ID of the first step to be displayed

sap.ui.commons.RoadMap.getMetadata

Returns a metadata object for class sap.ui.commons.RoadMap.

getNumberOfVisibleSteps

Gets current value of property numberOfVisibleSteps.

Total number of steps to be displayed at once

getSelectedStep

Gets current value of property selectedStep.

ID of the step which is currently selected

getSteps

Gets content of aggregation steps.

Steps that are composing the RoadMap

getWidth

Gets current value of property width.

Determines the control width in CSS size

Default value is '100%'.

indexOfStep

Checks for the provided sap.ui.commons.RoadMapStep in the aggregation steps. and returns its index if found or -1 otherwise.

insertStep

Inserts a step into the aggregation steps.

removeAllSteps

Removes all the controls from the aggregation steps.

Additionally, it unregisters them from the hosting UIArea.

removeStep

Removes a step from the aggregation steps.

setFirstVisibleStep

Sets a new value for property firstVisibleStep.

ID of the first step to be displayed

When called with a value of null or undefined, the default value of the property will be restored.

setNumberOfVisibleSteps

Sets a new value for property numberOfVisibleSteps.

Total number of steps to be displayed at once

When called with a value of null or undefined, the default value of the property will be restored.

setSelectedStep

Sets a new value for property selectedStep.

ID of the step which is currently selected

When called with a value of null or undefined, the default value of the property will be restored.

setWidth

Sets a new value for property width.

Determines the control width in CSS size

When called with a value of null or undefined, the default value of the property will be restored.

Default value is '100%'.

addStep

Adds some step to the aggregation steps.

Param Type DefaultValue Description
oStep sap.ui.commons.RoadMapStep

The step to add; if empty, nothing is inserted

attachStepExpanded

Attaches event handler fnFunction to the stepExpanded event of this sap.ui.commons.RoadMap.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.commons.RoadMap itself.

Event is fired when a given step is expanded or collapsed by user.

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.ui.commons.RoadMap itself

attachStepSelected

Attaches event handler fnFunction to the stepSelected event of this sap.ui.commons.RoadMap.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.commons.RoadMap itself.

Event is fired when the user selects a step.

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.ui.commons.RoadMap itself

destroySteps

Destroys all the steps in the aggregation steps.

detachStepExpanded

Detaches event handler fnFunction from the stepExpanded event of this sap.ui.commons.RoadMap.

The passed function and listener object must match the ones used for event registration.

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

detachStepSelected

Detaches event handler fnFunction from the stepSelected event of this sap.ui.commons.RoadMap.

The passed function and listener object must match the ones used for event registration.

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

sap.ui.commons.RoadMap.extend

Creates a new subclass of class sap.ui.commons.RoadMap with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.core.Control.extend.

Param Type DefaultValue Description
sClassName string

Name of the class being created

oClassInfo object

Object literal with information about the class

FNMetaImpl function

Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class

fireStepExpanded

Fires event stepExpanded to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

stepId string

ID of the expanded/collapsed step

fireStepSelected

Fires event stepSelected to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

stepId string

ID of the selected step

getFirstVisibleStep

Gets current value of property firstVisibleStep.

ID of the first step to be displayed

sap.ui.commons.RoadMap.getMetadata

Returns a metadata object for class sap.ui.commons.RoadMap.

getNumberOfVisibleSteps

Gets current value of property numberOfVisibleSteps.

Total number of steps to be displayed at once

getSelectedStep

Gets current value of property selectedStep.

ID of the step which is currently selected

getSteps

Gets content of aggregation steps.

Steps that are composing the RoadMap

getWidth

Gets current value of property width.

Determines the control width in CSS size

Default value is '100%'.

indexOfStep

Checks for the provided sap.ui.commons.RoadMapStep in the aggregation steps. and returns its index if found or -1 otherwise.

Param Type DefaultValue Description
oStep sap.ui.commons.RoadMapStep

The step whose index is looked for

insertStep

Inserts a step into the aggregation steps.

Param Type DefaultValue Description
oStep sap.ui.commons.RoadMapStep

The step to insert; if empty, nothing is inserted

iIndex int

The 0-based index the step should be inserted at; for a negative value of iIndex, the step is inserted at position 0; for a value greater than the current size of the aggregation, the step is inserted at the last position

removeAllSteps

Removes all the controls from the aggregation steps.

Additionally, it unregisters them from the hosting UIArea.

removeStep

Removes a step from the aggregation steps.

Param Type DefaultValue Description
vStep int string sap.ui.commons.RoadMapStep

The step to remove or its index or id

setFirstVisibleStep

Sets a new value for property firstVisibleStep.

ID of the first step to be displayed

When called with a value of null or undefined, the default value of the property will be restored.

Param Type DefaultValue Description
sFirstVisibleStep string

New value for property firstVisibleStep

setNumberOfVisibleSteps

Sets a new value for property numberOfVisibleSteps.

Total number of steps to be displayed at once

When called with a value of null or undefined, the default value of the property will be restored.

Param Type DefaultValue Description
iNumberOfVisibleSteps int

New value for property numberOfVisibleSteps

setSelectedStep

Sets a new value for property selectedStep.

ID of the step which is currently selected

When called with a value of null or undefined, the default value of the property will be restored.

Param Type DefaultValue Description
sSelectedStep string

New value for property selectedStep

setWidth

Sets a new value for property width.

Determines the control width in CSS size

When called with a value of null or undefined, the default value of the property will be restored.

Default value is '100%'.

Param Type DefaultValue Description
sWidth sap.ui.core.CSSSize '100%'

New value for property width