The WizardStep is a container control which should be used mainly to aggregate user input controls. It gives the developer the ability to validate, invalidate the step and define subsequent steps. Note: The WizardStep control control is supposed to be used only as an aggregation of the Wizard control, and should not be used as a standalone one.
Since: 1.30.
Event Summary
activate(oControlEvent)This event is fired on next step activation from the Wizard. complete(oControlEvent)This event is fired after the user presses the Next button in the Wizard, or on nextStep method call from the app developer. Method Summary
sap.m.WizardStep.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.m.WizardStep with name sClassName and enriches it with the information contained in oClassInfo. addContent(oContent)Adds some content to the aggregation content. addSubsequentStep(vSubsequentStep)Adds some subsequentStep into the association subsequentSteps. attachActivate(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the activate event of this sap.m.WizardStep. attachComplete(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the complete event of this sap.m.WizardStep. detachActivate(fnFunction, oListener)Detaches event handler fnFunction from the activate event of this sap.m.WizardStep. detachComplete(fnFunction, oListener)Detaches event handler fnFunction from the complete event of this sap.m.WizardStep. fireActivate(mArguments?)Fires event activate to attached listeners. fireComplete(mArguments?)Fires event complete to attached listeners. getIcon()Gets current value of property icon. getNextStep()ID of the element which is the current target of the association nextStep, or null. getSubsequentSteps()Returns array of IDs of the elements which are the current targets of the association subsequentSteps. getTitle()Gets current value of property title. indexOfContent(oContent)Checks for the provided sap.ui.core.Control in the aggregation content. insertContent(oContent, iIndex)Inserts a content into the aggregation content. removeContent(vContent)Removes a content from the aggregation content. removeSubsequentStep(vSubsequentStep)Removes an subsequentStep from the association named subsequentSteps. setIcon(sIcon)Sets a new value for property icon. setTitle(sTitle)Sets a new value for property title. setValidated(bValidated)Sets a new value for property validated. addStyleClass,
allowTextSelection,
attachBrowserEvent,
attachValidateFieldGroup,
checkFieldGroupIds,
clone,
detachBrowserEvent,
detachValidateFieldGroup,
fireValidateFieldGroup,
getAccessibilityInfo,
getBusy,
getBusyIndicatorDelay,
getControlsByFieldGroupId,
getFieldGroupIds,
getIdForLabel,
getRenderer,
getVisible,
hasStyleClass,
invalidate,
isBusy,
onAfterRendering,
onBeforeRendering,
placeAt,
removeStyleClass,
rerender,
setBusy,
setBusyIndicatorDelay,
setFieldGroupIds,
setVisible,
toggleStyleClass,
triggerValidateFieldGroup $,
addCustomData,
addDependent,
addEventDelegate,
applyFocusInfo,
bindElement,
data,
destroy,
destroyCustomData,
destroyDependents,
destroyLayoutData,
destroyTooltip,
enhanceAccessibilityState,
exit,
findElements,
fireEvent,
focus,
getCustomData,
getDependents,
getDomRef,
getElementBinding,
getFocusDomRef,
getFocusInfo,
getInterface,
getLayoutData,
getMetadata,
getTooltip,
getTooltip_AsString,
getTooltip_Text,
indexOfCustomData,
indexOfDependent,
init,
insertCustomData,
insertDependent,
prop,
removeAllCustomData,
removeAllDependents,
removeCustomData,
removeDependent,
removeEventDelegate,
setLayoutData,
setTooltip,
toString,
unbindElement 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 Constructor Detail
new sap.m.WizardStep(sId?, mSettings?)
Constructor for a new WizardStep.
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
- title : string (default: )
- icon : sap.ui.core.URI (default: )
- validated : boolean (default: true)
- Aggregations
- content : sap.ui.core.Control[] (default)
- Events
- complete : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- activate : 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 |
Event Detail
activate(oControlEvent)
This event is fired on next step activation from the Wizard.
Parameters:
complete(oControlEvent)
This event is fired after the user presses the Next button in the Wizard, or on nextStep method call from the app developer.
Parameters:
Method Detail
sap.m.WizardStep.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.m.WizardStep 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 |
Returns a metadata object for class sap.m.WizardStep.
Returns:
Adds some content to the aggregation content.
Parameters:
Returns:
Adds some subsequentStep into the association subsequentSteps.
Parameters:
| {string|sap.m.WizardStep} | vSubsequentStep | the subsequentSteps to add; if empty, nothing is inserted |
Returns:
Attaches event handler
fnFunction to the
activate event of this
sap.m.WizardStep.
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.m.WizardStep itself.
This event is fired on next step activation from the Wizard.
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.m.WizardStep itself |
Returns:
Attaches event handler
fnFunction to the
complete event of this
sap.m.WizardStep.
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.m.WizardStep itself.
This event is fired after the user presses the Next button in the Wizard, or on nextStep method call from the app developer.
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.m.WizardStep itself |
Returns:
Destroys all the content in the aggregation content.
Returns:
Detaches event handler
fnFunction from the
activate event of this
sap.m.WizardStep.
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:
Detaches event handler
fnFunction from the
complete event of this
sap.m.WizardStep.
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:
Fires event activate to attached listeners.
Parameters:
| {Map} | mArguments? | The arguments to pass along with the event |
Returns:
Fires event complete to attached listeners.
Parameters:
| {Map} | mArguments? | The arguments to pass along with the event |
Returns:
Gets content of aggregation
content.
The content of the Wizard Step.
Returns:
Gets current value of property
icon.
Determines the icon that is displayed for this step. The icon is visualized in the progress navigation part of the Wizard control. Note: In order for the icon to be displayed, each step in the Wizard should have this property defined, otherwise the default numbering will be displayed.
Default value is
Returns:
ID of the element which is the current target of the association nextStep, or null.
Returns:
Returns array of IDs of the elements which are the current targets of the association subsequentSteps.
Returns:
getTitle(): string
Gets current value of property
title.
Determines the title of the step. The title is visualized in the Wizard control.
Default value is
Returns:
| {string} | Value of property title |
getValidated(): boolean
Gets current value of property
validated.
Indicates whether or not the step is validated. When a step is validated a Next button is visualized in the Wizard control.
Default value is true.
Returns:
| {boolean} | Value of property validated |
indexOfContent(oContent): int
Checks for the provided sap.ui.core.Control in the aggregation content. and returns its index if found or -1 otherwise.
Parameters:
Returns:
| {int} | The index of the provided control in the aggregation if found, or -1 otherwise |
Inserts a content into the aggregation content.
Parameters:
| {sap.ui.core.Control} | oContent | the content to insert; if empty, nothing is inserted |
| {int} | iIndex | the 0-based index the content should be inserted at; for a negative value of iIndex, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position |
Returns:
Removes all the controls from the aggregation
content.
Additionally, it unregisters them from the hosting UIArea.
Returns:
Removes all the controls in the association named subsequentSteps.
Returns:
Removes a content from the aggregation content.
Parameters:
Returns:
Removes an subsequentStep from the association named subsequentSteps.
Parameters:
| {int|string|sap.m.WizardStep} | vSubsequentStep | The subsequentStepto be removed or its index or ID |
Returns:
Sets a new value for property
icon.
Determines the icon that is displayed for this step. The icon is visualized in the progress navigation part of the Wizard control. Note: In order for the icon to be displayed, each step in the Wizard should have this property defined, otherwise the default numbering will be displayed.
When called with a value of null or undefined, the default value of the property will be restored.
Default value is
Parameters:
Returns:
Sets the associated nextStep.
Parameters:
| {sap.m.WizardStep} | oNextStep | Id of an element which becomes the new target of this nextStep association; alternatively, an element instance may be given |
Returns:
Sets a new value for property
title.
Determines the title of the step. The title is visualized in the Wizard control.
When called with a value of null or undefined, the default value of the property will be restored.
Default value is
Parameters:
| {string} | sTitle | New value for property title |
Returns:
Sets a new value for property
validated.
Indicates whether or not the step is validated. When a step is validated a Next button is visualized in the Wizard control.
When called with a value of null or undefined, the default value of the property will be restored.
Default value is true.
Parameters:
| {boolean} | bValidated | New value for property validated |
Returns: