class sap.ui.commons.RoadMapStep

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

Step used within a RoadMap Control.


Constructor

Constructor for a new RoadMapStep.

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.RoadMapStep(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
enabled boolean true

Specifies whether the user shall be allowed to click a step, or not

Visibility: public
expanded boolean false

This property is only relevant when using sub steps.

Visibility: public
label string

Label of the step

Visibility: public
visible boolean true

Step is visible

Visibility: public

Aggregations

Default Aggregation: subSteps

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

Sub steps for the current step. Will be displayed only in the case that the step is expanded. Otherwise, special arrows show the availability of sub steps. One level of sub steps supported.
Deprecated as of version 1.10.5. Sub steps will not be supported in future. This feature might be removed in one of the next releases.


Methods Overview

Method Description
addSubStep

Adds some subStep to the aggregation subSteps.

Since 1.10.5 Sub steps will not be supported in future. This feature might be removed in one of the next releases.
destroySubSteps

Destroys all the subSteps in the aggregation subSteps.

Since 1.10.5 Sub steps will not be supported in future. This feature might be removed in one of the next releases.
sap.ui.commons.RoadMapStep.extend

Creates a new subclass of class sap.ui.commons.RoadMapStep 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.Element.extend.

getEnabled

Gets current value of property enabled.

Specifies whether the user shall be allowed to click a step, or not

Default value is true.

getExpanded

Gets current value of property expanded.

This property is only relevant when using sub steps.

Default value is false.

Since 1.10.5 Note that sub steps will not be supported in future. This feature might be removed in one of the next releases.
getLabel

Gets current value of property label.

Label of the step

sap.ui.commons.RoadMapStep.getMetadata

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

getSubSteps

Gets content of aggregation subSteps.

Sub steps for the current step. Will be displayed only in the case that the step is expanded. Otherwise, special arrows show the availability of sub steps. One level of sub steps supported.

Since 1.10.5 Sub steps will not be supported in future. This feature might be removed in one of the next releases.
getVisible

Gets current value of property visible.

Step is visible

Default value is true.

indexOfSubStep

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

Since 1.10.5 Sub steps will not be supported in future. This feature might be removed in one of the next releases.
insertSubStep

Inserts a subStep into the aggregation subSteps.

Since 1.10.5 Sub steps will not be supported in future. This feature might be removed in one of the next releases.
removeAllSubSteps

Removes all the controls from the aggregation subSteps.

Additionally, it unregisters them from the hosting UIArea.

Since 1.10.5 Sub steps will not be supported in future. This feature might be removed in one of the next releases.
removeSubStep

Removes a subStep from the aggregation subSteps.

Since 1.10.5 Sub steps will not be supported in future. This feature might be removed in one of the next releases.
setEnabled

Sets a new value for property enabled.

Specifies whether the user shall be allowed to click a step, or not

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

Default value is true.

setExpanded

Sets a new value for property expanded.

This property is only relevant when using sub steps.

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

Default value is false.

Since 1.10.5 Note that sub steps will not be supported in future. This feature might be removed in one of the next releases.
setLabel

Sets a new value for property label.

Label of the step

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

setVisible

Sets a new value for property visible.

Step is visible

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

Default value is true.

addSubStep

Adds some subStep to the aggregation subSteps.

Since 1.10.5 Sub steps will not be supported in future. This feature might be removed in one of the next releases.
Param Type DefaultValue Description
oSubStep sap.ui.commons.RoadMapStep

The subStep to add; if empty, nothing is inserted

destroySubSteps

Destroys all the subSteps in the aggregation subSteps.

Since 1.10.5 Sub steps will not be supported in future. This feature might be removed in one of the next releases.

sap.ui.commons.RoadMapStep.extend

Creates a new subclass of class sap.ui.commons.RoadMapStep 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.Element.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

getEnabled

Gets current value of property enabled.

Specifies whether the user shall be allowed to click a step, or not

Default value is true.

getExpanded

Gets current value of property expanded.

This property is only relevant when using sub steps.

Default value is false.

Since 1.10.5 Note that sub steps will not be supported in future. This feature might be removed in one of the next releases.

getLabel

Gets current value of property label.

Label of the step

sap.ui.commons.RoadMapStep.getMetadata

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

getSubSteps

Gets content of aggregation subSteps.

Sub steps for the current step. Will be displayed only in the case that the step is expanded. Otherwise, special arrows show the availability of sub steps. One level of sub steps supported.

Since 1.10.5 Sub steps will not be supported in future. This feature might be removed in one of the next releases.

getVisible

Gets current value of property visible.

Step is visible

Default value is true.

indexOfSubStep

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

Since 1.10.5 Sub steps will not be supported in future. This feature might be removed in one of the next releases.
Param Type DefaultValue Description
oSubStep sap.ui.commons.RoadMapStep

The subStep whose index is looked for

insertSubStep

Inserts a subStep into the aggregation subSteps.

Since 1.10.5 Sub steps will not be supported in future. This feature might be removed in one of the next releases.
Param Type DefaultValue Description
oSubStep sap.ui.commons.RoadMapStep

The subStep to insert; if empty, nothing is inserted

iIndex int

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

removeAllSubSteps

Removes all the controls from the aggregation subSteps.

Additionally, it unregisters them from the hosting UIArea.

Since 1.10.5 Sub steps will not be supported in future. This feature might be removed in one of the next releases.

removeSubStep

Removes a subStep from the aggregation subSteps.

Since 1.10.5 Sub steps will not be supported in future. This feature might be removed in one of the next releases.
Param Type DefaultValue Description
vSubStep int string sap.ui.commons.RoadMapStep

The subStep to remove or its index or id

setEnabled

Sets a new value for property enabled.

Specifies whether the user shall be allowed to click a step, or not

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

Default value is true.

Param Type DefaultValue Description
bEnabled boolean true

New value for property enabled

setExpanded

Sets a new value for property expanded.

This property is only relevant when using sub steps.

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

Default value is false.

Since 1.10.5 Note that sub steps will not be supported in future. This feature might be removed in one of the next releases.
Param Type DefaultValue Description
bExpanded boolean false

New value for property expanded

setLabel

Sets a new value for property label.

Label of the step

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

Param Type DefaultValue Description
sLabel string

New value for property label

setVisible

Sets a new value for property visible.

Step is visible

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

Default value is true.

Param Type DefaultValue Description
bVisible boolean true

New value for property visible