Class sap.ui.commons.RoadMapModule: sap/ui/commons/RoadMap

extends Control

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

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

Constructor Summary
new sap.ui.commons.RoadMap(sId?, mSettings?)Constructor for a new RoadMap.
Event Summary
stepExpanded(oControlEvent)Event is fired when a given step is expanded or collapsed by user.
stepSelected(oControlEvent)Event is fired when the user selects a step.
Events borrowed from class sap.ui.core.Control
validateFieldGroup
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.ui.commons.RoadMap.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.commons.RoadMap with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.commons.RoadMap.getMetadata()Returns a metadata object for class sap.ui.commons.RoadMap.
addStep(oStep)Adds some step to the aggregation steps.
attachStepExpanded(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the stepExpanded event of this sap.ui.commons.RoadMap.
attachStepSelected(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the stepSelected event of this sap.ui.commons.RoadMap.
destroySteps()Destroys all the steps in the aggregation steps.
detachStepExpanded(fnFunction, oListener)Detaches event handler fnFunction from the stepExpanded event of this sap.ui.commons.RoadMap.
detachStepSelected(fnFunction, oListener)Detaches event handler fnFunction from the stepSelected event of this sap.ui.commons.RoadMap.
fireStepExpanded(mArguments?)Fires event stepExpanded to attached listeners.
fireStepSelected(mArguments?)Fires event stepSelected to attached listeners.
getFirstVisibleStep()Gets current value of property firstVisibleStep.
getNumberOfVisibleSteps()Gets current value of property numberOfVisibleSteps.
getSelectedStep()Gets current value of property selectedStep.
getSteps()Gets content of aggregation steps.
getWidth()Gets current value of property width.
indexOfStep(oStep)Checks for the provided sap.ui.commons.RoadMapStep in the aggregation steps.
insertStep(oStep, iIndex)Inserts a step into the aggregation steps.
removeAllSteps()Removes all the controls from the aggregation steps.
removeStep(vStep)Removes a step from the aggregation steps.
setFirstVisibleStep(sFirstVisibleStep)Sets a new value for property firstVisibleStep.
setNumberOfVisibleSteps(iNumberOfVisibleSteps)Sets a new value for property numberOfVisibleSteps.
setSelectedStep(sSelectedStep)Sets a new value for property selectedStep.
setWidth(sWidth)Sets a new value for property width.
Methods borrowed from class sap.ui.core.Control
addStyleClass, allowTextSelection, attachBrowserEvent, attachValidateFieldGroup, checkFieldGroupIds, clone, detachBrowserEvent, detachValidateFieldGroup, fireValidateFieldGroup, getAccessibilityInfo, getBusy, getBusyIndicatorDelay, getControlsByFieldGroupId, getFieldGroupIds, getIdForLabel, getRenderer, getVisible, hasStyleClass, invalidate, isBusy, onBeforeRendering, placeAt, removeStyleClass, rerender, setBusy, setBusyIndicatorDelay, setFieldGroupIds, setVisible, toggleStyleClass, triggerValidateFieldGroup
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, data, destroy, destroyCustomData, destroyDependents, destroyLayoutData, destroyTooltip, enhanceAccessibilityState, findElements, fireEvent, focus, getCustomData, getDependents, getDomRef, getElementBinding, getFocusDomRef, getFocusInfo, getInterface, getLayoutData, getMetadata, getTooltip, getTooltip_AsString, getTooltip_Text, indexOfCustomData, indexOfDependent, insertCustomData, insertDependent, prop, removeAllCustomData, removeAllDependents, removeCustomData, removeDependent, removeEventDelegate, 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, 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.RoadMap(sId?, mSettings?)
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 for a general description of the syntax of the settings object.

The supported settings are:

  • Properties
  • Aggregations
    • steps : sap.ui.commons.RoadMapStep[] (default)
  • Events
    • stepSelected : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • stepExpanded : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]

In addition, all settings applicable to the base type sap.ui.core.Control 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.
Event Detail
stepExpanded(oControlEvent)
Event is fired when a given step is expanded or collapsed by user.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{string}oControlEvent.getParameters.stepId ID of the expanded/collapsed step
stepSelected(oControlEvent)
Event is fired when the user selects a step.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{string}oControlEvent.getParameters.stepId ID of the selected step
Method Detail
sap.ui.commons.RoadMap.extend(sClassName, oClassInfo?, FNMetaImpl?): function
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.

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.RoadMap.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.commons.RoadMap.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
addStep(oStep): sap.ui.commons.RoadMap
Adds some step to the aggregation steps.
Parameters:
{sap.ui.commons.RoadMapStep}oStep the step to add; if empty, nothing is inserted
Returns:
{sap.ui.commons.RoadMap} Reference to this in order to allow method chaining
attachStepExpanded(oData?, fnFunction, oListener?): sap.ui.commons.RoadMap
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.

Parameters:
{object}oData? An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}fnFunction The function to be called when the event occurs
{object}oListener? Context object to call the event handler with. Defaults to this sap.ui.commons.RoadMap itself
Returns:
{sap.ui.commons.RoadMap} Reference to this in order to allow method chaining
attachStepSelected(oData?, fnFunction, oListener?): sap.ui.commons.RoadMap
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.

Parameters:
{object}oData? An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}fnFunction The function to be called when the event occurs
{object}oListener? Context object to call the event handler with. Defaults to this sap.ui.commons.RoadMap itself
Returns:
{sap.ui.commons.RoadMap} Reference to this in order to allow method chaining
destroySteps(): sap.ui.commons.RoadMap
Destroys all the steps in the aggregation steps.
Returns:
{sap.ui.commons.RoadMap} Reference to this in order to allow method chaining
detachStepExpanded(fnFunction, oListener): sap.ui.commons.RoadMap
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.

Parameters:
{function}fnFunction The function to be called, when the event occurs
{object}oListener Context object on which the given function had to be called
Returns:
{sap.ui.commons.RoadMap} Reference to this in order to allow method chaining
detachStepSelected(fnFunction, oListener): sap.ui.commons.RoadMap
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.

Parameters:
{function}fnFunction The function to be called, when the event occurs
{object}oListener Context object on which the given function had to be called
Returns:
{sap.ui.commons.RoadMap} Reference to this in order to allow method chaining
fireStepExpanded(mArguments?): sap.ui.commons.RoadMap
Fires event stepExpanded to attached listeners.

Expects the following event parameters:

  • stepId of type stringID of the expanded/collapsed step
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.ui.commons.RoadMap} Reference to this in order to allow method chaining
fireStepSelected(mArguments?): sap.ui.commons.RoadMap
Fires event stepSelected to attached listeners.

Expects the following event parameters:

  • stepId of type stringID of the selected step
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.ui.commons.RoadMap} Reference to this in order to allow method chaining
getFirstVisibleStep(): string
Gets current value of property firstVisibleStep.

ID of the first step to be displayed

Returns:
{string} Value of property firstVisibleStep
getNumberOfVisibleSteps(): int
Gets current value of property numberOfVisibleSteps.

Total number of steps to be displayed at once

Returns:
{int} Value of property numberOfVisibleSteps
getSelectedStep(): string
Gets current value of property selectedStep.

ID of the step which is currently selected

Returns:
{string} Value of property selectedStep
getSteps(): sap.ui.commons.RoadMapStep[]
Gets content of aggregation steps.

Steps that are composing the RoadMap

Returns:
{sap.ui.commons.RoadMapStep[]}
getWidth(): sap.ui.core.CSSSize
Gets current value of property width.

Determines the control width in CSS size

Default value is 100%.

Returns:
{sap.ui.core.CSSSize} Value of property width
indexOfStep(oStep): int
Checks for the provided sap.ui.commons.RoadMapStep in the aggregation steps. and returns its index if found or -1 otherwise.
Parameters:
{sap.ui.commons.RoadMapStep}oStep The step whose index is looked for
Returns:
{int} The index of the provided control in the aggregation if found, or -1 otherwise
insertStep(oStep, iIndex): sap.ui.commons.RoadMap
Inserts a step into the aggregation steps.
Parameters:
{sap.ui.commons.RoadMapStep}oStep the step to insert; if empty, nothing is inserted
{int}iIndex 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
Returns:
{sap.ui.commons.RoadMap} Reference to this in order to allow method chaining
removeAllSteps(): sap.ui.commons.RoadMapStep[]
Removes all the controls from the aggregation steps.

Additionally, it unregisters them from the hosting UIArea.

Returns:
{sap.ui.commons.RoadMapStep[]} An array of the removed elements (might be empty)
removeStep(vStep): sap.ui.commons.RoadMapStep
Removes a step from the aggregation steps.
Parameters:
{int|string|sap.ui.commons.RoadMapStep}vStep The stepto remove or its index or id
Returns:
{sap.ui.commons.RoadMapStep} The removed step or null
setFirstVisibleStep(sFirstVisibleStep): sap.ui.commons.RoadMap
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.

Parameters:
{string}sFirstVisibleStep New value for property firstVisibleStep
Returns:
{sap.ui.commons.RoadMap} Reference to this in order to allow method chaining
setNumberOfVisibleSteps(iNumberOfVisibleSteps): sap.ui.commons.RoadMap
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.

Parameters:
{int}iNumberOfVisibleSteps New value for property numberOfVisibleSteps
Returns:
{sap.ui.commons.RoadMap} Reference to this in order to allow method chaining
setSelectedStep(sSelectedStep): sap.ui.commons.RoadMap
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.

Parameters:
{string}sSelectedStep New value for property selectedStep
Returns:
{sap.ui.commons.RoadMap} Reference to this in order to allow method chaining
setWidth(sWidth): sap.ui.commons.RoadMap
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%.

Parameters:
{sap.ui.core.CSSSize}sWidth New value for property width
Returns:
{sap.ui.commons.RoadMap} Reference to this in order to allow method chaining