Step used within a RoadMap Control.
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 |
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 |
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. |
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
|
getEnabled |
Gets current value of property enabled. Specifies whether the user shall be allowed to click a step, or not Default value is |
getExpanded |
Gets current value of property expanded. This property is only relevant when using sub steps. Default value is
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 |
indexOfSubStep |
Checks for the provided
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 Default value is |
setExpanded |
Sets a new value for property expanded. This property is only relevant when using sub steps. When called with a value of Default value is
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 |
setVisible |
Sets a new value for property visible. Step is visible When called with a value of Default value is |
Adds some subStep to the aggregation subSteps.
Param | Type | DefaultValue | Description |
---|---|---|---|
oSubStep | sap.ui.commons.RoadMapStep |
The subStep to add; if empty, nothing is inserted |
Destroys all the subSteps in the aggregation subSteps.
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 |
Gets current value of property enabled.
Specifies whether the user shall be allowed to click a step, or not
Default value is true
.
Gets current value of property expanded.
This property is only relevant when using sub steps.
Default value is false
.
Returns a metadata object for class sap.ui.commons.RoadMapStep.
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.
Checks for the provided sap.ui.commons.RoadMapStep
in the aggregation subSteps. and returns its index if found or -1 otherwise.
Param | Type | DefaultValue | Description |
---|---|---|---|
oSubStep | sap.ui.commons.RoadMapStep |
The subStep whose index is looked for |
Inserts a subStep into the aggregation subSteps.
Param | Type | DefaultValue | Description |
---|---|---|---|
oSubStep | sap.ui.commons.RoadMapStep |
The subStep to insert; if empty, nothing is inserted |
|
iIndex | int |
The |
Removes all the controls from the aggregation subSteps.
Additionally, it unregisters them from the hosting UIArea.
Removes a subStep from the aggregation subSteps.
Param | Type | DefaultValue | Description |
---|---|---|---|
vSubStep | int string sap.ui.commons.RoadMapStep |
The subStep to remove or its index or id |
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 |
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
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bExpanded | boolean | false |
New value for property |
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 |
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 |