Class sap.ui.commons.RoadMapStepModule: sap/ui/commons/RoadMapStep

extends Element

Step used within a RoadMap Control.

Deprecated API:Since version 1.38. Instead, use the sap.m.Wizard control.

Constructor Summary
new sap.ui.commons.RoadMapStep(sId?, mSettings?)Constructor for a new RoadMapStep.
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.ui.commons.RoadMapStep.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.commons.RoadMapStep with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.commons.RoadMapStep.getMetadata()Returns a metadata object for class sap.ui.commons.RoadMapStep.
getEnabled()Gets current value of property enabled.
getLabel()Gets current value of property label.
getVisible()Gets current value of property visible.
setEnabled(bEnabled)Sets a new value for property enabled.
setLabel(sLabel)Sets a new value for property label.
setVisible(bVisible)Sets a new value for property visible.
addSubStep(oSubStep)Adds some subStep to the aggregation subSteps.
destroySubSteps()Destroys all the subSteps in the aggregation subSteps.
getExpanded()Gets current value of property expanded.
getSubSteps()Gets content of aggregation subSteps.
indexOfSubStep(oSubStep)Checks for the provided sap.ui.commons.RoadMapStep in the aggregation subSteps.
insertSubStep(oSubStep, iIndex)Inserts a subStep into the aggregation subSteps.
removeAllSubSteps()Removes all the controls from the aggregation subSteps.
removeSubStep(vSubStep)Removes a subStep from the aggregation subSteps.
setExpanded(bExpanded)Sets a new value for property expanded.
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, clone, data, destroy, destroyCustomData, destroyDependents, destroyLayoutData, destroyTooltip, enhanceAccessibilityState, exit, findElements, fireEvent, focus, getCustomData, getDependents, getDomRef, getElementBinding, getInterface, getLayoutData, getMetadata, getTooltip, getTooltip_AsString, getTooltip_Text, indexOfCustomData, indexOfDependent, init, insertCustomData, insertDependent, prop, removeAllCustomData, removeAllDependents, removeCustomData, removeDependent, removeEventDelegate, rerender, setLayoutData, setTooltip, toString, unbindElement
Methods borrowed from class sap.ui.base.ManagedObject
addAggregation, addAssociation, applySettings, attachFormatError, attachModelContextChange, attachParseError, attachValidationError, attachValidationSuccess, bindAggregation, bindContext, bindObject, bindProperty, destroyAggregation, detachFormatError, detachModelContextChange, detachParseError, detachValidationError, detachValidationSuccess, findAggregatedObjects, fireFormatError, fireModelContextChange, fireParseError, fireValidationError, fireValidationSuccess, getAggregation, getAssociation, getBinding, getBindingContext, getBindingInfo, getBindingPath, getEventingParent, getId, getModel, getObjectBinding, getOriginInfo, getParent, getProperty, hasModel, indexOfAggregation, insertAggregation, invalidate, isBound, isInvalidateSuppressed, isTreeBinding, propagateMessages, removeAggregation, removeAllAggregation, removeAllAssociation, removeAssociation, setAggregation, setAssociation, setBindingContext, setModel, setProperty, unbindAggregation, unbindContext, unbindObject, unbindProperty, validateAggregation, validateProperty
Methods borrowed from class sap.ui.base.EventProvider
attachEvent, attachEventOnce, detachEvent, hasListeners
Constructor Detail
new sap.ui.commons.RoadMapStep(sId?, mSettings?)
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 for a general description of the syntax of the settings object.

The supported settings are:

  • Properties
  • Aggregations
    • subSteps : sap.ui.commons.RoadMapStep[] (default)

In addition, all settings applicable to the base type sap.ui.core.Element can be used as well.

Parameters:
{string}sId? id for the new control, generated automatically if no id is given
{object}mSettings? initial settings for the new control
Deprecated:
Since version 1.38. Instead, use the sap.m.Wizard control.
Method Detail
sap.ui.commons.RoadMapStep.extend(sClassName, oClassInfo?, FNMetaImpl?): function
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.

Parameters:
{string}sClassName Name of the class being created
{object}oClassInfo? Object literal with information about the class
{function}FNMetaImpl? Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
Returns:
{function} Created class / constructor function
sap.ui.commons.RoadMapStep.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.commons.RoadMapStep.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
getEnabled(): boolean
Gets current value of property enabled.

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

Default value is true.

Returns:
{boolean} Value of property enabled
getLabel(): string
Gets current value of property label.

Label of the step

Returns:
{string} Value of property label
getVisible(): boolean
Gets current value of property visible.

Step is visible

Default value is true.

Returns:
{boolean} Value of property visible
setEnabled(bEnabled): sap.ui.commons.RoadMapStep
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.

Parameters:
{boolean}bEnabled New value for property enabled
Returns:
{sap.ui.commons.RoadMapStep} Reference to this in order to allow method chaining
setLabel(sLabel): sap.ui.commons.RoadMapStep
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.

Parameters:
{string}sLabel New value for property label
Returns:
{sap.ui.commons.RoadMapStep} Reference to this in order to allow method chaining
setVisible(bVisible): sap.ui.commons.RoadMapStep
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.

Parameters:
{boolean}bVisible New value for property visible
Returns:
{sap.ui.commons.RoadMapStep} Reference to this in order to allow method chaining
addSubStep(oSubStep): sap.ui.commons.RoadMapStep
Adds some subStep to the aggregation subSteps.
Parameters:
{sap.ui.commons.RoadMapStep}oSubStep the subStep to add; if empty, nothing is inserted
Deprecated:
Since version 1.10.5. Sub steps will not be supported in future. This feature might be removed in one of the next releases.
Returns:
{sap.ui.commons.RoadMapStep} Reference to this in order to allow method chaining
destroySubSteps(): sap.ui.commons.RoadMapStep
Destroys all the subSteps in the aggregation subSteps.
Deprecated:
Since version 1.10.5. Sub steps will not be supported in future. This feature might be removed in one of the next releases.
Returns:
{sap.ui.commons.RoadMapStep} Reference to this in order to allow method chaining
getExpanded(): boolean
Gets current value of property expanded.

This property is only relevant when using sub steps.

Default value is false.

Deprecated:
Since version 1.10.5. Note that sub steps will not be supported in future. This feature might be removed in one of the next releases.
Returns:
{boolean} Value of property expanded
getSubSteps(): 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.

Deprecated:
Since version 1.10.5. Sub steps will not be supported in future. This feature might be removed in one of the next releases.
Returns:
{sap.ui.commons.RoadMapStep[]}
indexOfSubStep(oSubStep): int
Checks for the provided sap.ui.commons.RoadMapStep in the aggregation subSteps. and returns its index if found or -1 otherwise.
Parameters:
{sap.ui.commons.RoadMapStep}oSubStep The subStep whose index is looked for
Deprecated:
Since version 1.10.5. Sub steps will not be supported in future. This feature might be removed in one of the next releases.
Returns:
{int} The index of the provided control in the aggregation if found, or -1 otherwise
insertSubStep(oSubStep, iIndex): sap.ui.commons.RoadMapStep
Inserts a subStep into the aggregation subSteps.
Parameters:
{sap.ui.commons.RoadMapStep}oSubStep the subStep to insert; if empty, nothing is inserted
{int}iIndex 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
Deprecated:
Since version 1.10.5. Sub steps will not be supported in future. This feature might be removed in one of the next releases.
Returns:
{sap.ui.commons.RoadMapStep} Reference to this in order to allow method chaining
removeAllSubSteps(): sap.ui.commons.RoadMapStep[]
Removes all the controls from the aggregation subSteps.

Additionally, it unregisters them from the hosting UIArea.

Deprecated:
Since version 1.10.5. Sub steps will not be supported in future. This feature might be removed in one of the next releases.
Returns:
{sap.ui.commons.RoadMapStep[]} An array of the removed elements (might be empty)
removeSubStep(vSubStep): sap.ui.commons.RoadMapStep
Removes a subStep from the aggregation subSteps.
Parameters:
{int|string|sap.ui.commons.RoadMapStep}vSubStep The subStepto remove or its index or id
Deprecated:
Since version 1.10.5. Sub steps will not be supported in future. This feature might be removed in one of the next releases.
Returns:
{sap.ui.commons.RoadMapStep} The removed subStep or null
setExpanded(bExpanded): sap.ui.commons.RoadMapStep
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.

Parameters:
{boolean}bExpanded New value for property expanded
Deprecated:
Since version 1.10.5. Note that sub steps will not be supported in future. This feature might be removed in one of the next releases.
Returns:
{sap.ui.commons.RoadMapStep} Reference to this in order to allow method chaining