A container control used to aggregate user input controls as part of an sap.m.Wizard.
WizardStep gives the developer the ability to validate, invalidate the step and define subsequent steps. 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.
validated
property. This action will trigger the rendering of the Next step button.subsequentSteps
aggregation.
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#constructor for a general description of the syntax of the settings object.
new sap.m.WizardStep(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 |
---|---|---|---|
icon | sap.ui.core.URI | empty string | 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. Visibility: public |
optional | boolean | false | Indicates whether or not the step is optional. When a step is optional an "(Optional)" label is displayed under the step's title. |
title | string | empty string | Determines the title of the step. The title is visualized in the Wizard control. Visibility: public |
validated | boolean | true | Indicates whether or not the step is validated. When a step is validated a Next button is visualized in the Wizard control. |
Default Aggregation: content
Name | Cardinality | Type | Description |
---|---|---|---|
_nextButton | 0..1 | sap.m.Button |
The next button of the Wizard Step. |
content (default) | 0..n | sap.ui.core.Control |
The content of the Wizard Step. |
Name | Cardinality | Type | Description |
---|---|---|---|
nextStep | 0..1 | sap.m.WizardStep |
The next step to be taken. It must be defined in order for the previous step to be completed. |
subsequentSteps | 0..n | sap.m.WizardStep |
This association is used only when the |
Method | Description |
---|---|
_getNumberInvisibleText |
Gets the invisible text, which describes the title and position of the step. |
_setNumberInvisibleText |
Sets the text, which describes the title and position of the step. |
addContent |
Adds some content to the aggregation content. |
addSubsequentStep |
Adds some subsequentStep into the association subsequentSteps. |
attachActivate |
Attaches event handler When called, the context of the event handler (its This event is fired on next step activation from the Wizard. |
attachComplete |
Attaches event handler When called, the context of the event handler (its This event is fired after the user presses the Next button in the Wizard, or on |
destroyContent |
Destroys all the content in the aggregation content. |
detachActivate |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachComplete |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
sap.m.WizardStep.extend |
Creates a new subclass of class sap.m.WizardStep with name
|
fireActivate |
Fires event activate to attached listeners. |
fireComplete |
Fires event complete to attached listeners. |
getContent |
Gets content of aggregation content. The content of the Wizard Step. |
getIcon |
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 |
sap.m.WizardStep.getMetadata |
Returns a metadata object for class sap.m.WizardStep. |
getNextStep |
ID of the element which is the current target of the association nextStep, or |
getOptional |
Gets current value of property optional. Indicates whether or not the step is optional. When a step is optional an "(Optional)" label is displayed under the step's title. Default value is |
getSubsequentSteps |
Returns array of IDs of the elements which are the current targets of the association subsequentSteps. |
getTitle |
Gets current value of property title. Determines the title of the step. The title is visualized in the Wizard control. Default value is |
getValidated |
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 |
indexOfContent |
Checks for the provided |
insertContent |
Inserts a content into the aggregation content. |
removeAllContent |
Removes all the controls from the aggregation content. Additionally, it unregisters them from the hosting UIArea. |
removeAllSubsequentSteps |
Removes all the controls in the association named subsequentSteps. |
removeContent |
Removes a content from the aggregation content. |
removeSubsequentStep |
Removes an subsequentStep from the association named subsequentSteps. |
setIcon |
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 Default value is |
setNextStep |
Sets the associated nextStep. |
setOptional |
Sets a new value for property optional. Indicates whether or not the step is optional. When a step is optional an "(Optional)" label is displayed under the step's title. When called with a value of Default value is |
setTitle |
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 Default value is |
setValidated |
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 Default value is |
setWizardContext |
Updates the step's properties in the current context of the wizard. |
Gets the invisible text, which describes the title and position of the step.
Sets the text, which describes the title and position of the step.
Param | Type | DefaultValue | Description |
---|---|---|---|
iNumber | number |
The position of the step inside the wizard |
Adds some content to the aggregation content.
Param | Type | DefaultValue | Description |
---|---|---|---|
oContent | sap.ui.core.Control |
The content to add; if empty, nothing is inserted |
Adds some subsequentStep into the association subsequentSteps.
Param | Type | DefaultValue | Description |
---|---|---|---|
vSubsequentStep | sap.ui.core.ID sap.m.WizardStep |
The subsequentSteps to add; if empty, nothing is inserted |
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
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.
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 |
Fires event activate to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
Fires event complete to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
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 empty string
.
Gets current value of property optional.
Indicates whether or not the step is optional. When a step is optional an "(Optional)" label is displayed under the step's title.
Default value is false
.
Returns array of IDs of the elements which are the current targets of the association subsequentSteps.
Gets current value of property title.
Determines the title of the step. The title is visualized in the Wizard control.
Default value is empty string
.
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
.
Checks for the provided sap.ui.core.Control
in the aggregation content. and returns its index if found or -1 otherwise.
Param | Type | DefaultValue | Description |
---|---|---|---|
oContent | sap.ui.core.Control |
The content whose index is looked for |
Inserts a content into the aggregation content.
Param | Type | DefaultValue | Description |
---|---|---|---|
oContent | sap.ui.core.Control |
The content to insert; if empty, nothing is inserted |
|
iIndex | int |
The |
Removes all the controls from the aggregation content.
Additionally, it unregisters them from the hosting UIArea.
Removes a content from the aggregation content.
Param | Type | DefaultValue | Description |
---|---|---|---|
vContent | int string sap.ui.core.Control |
The content to remove or its index or id |
Removes an subsequentStep from the association named subsequentSteps.
Param | Type | DefaultValue | Description |
---|---|---|---|
vSubsequentStep | int sap.ui.core.ID sap.m.WizardStep |
The subsequentStep to be removed or its index or ID |
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 empty string
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sIcon | sap.ui.core.URI | "" |
New value for property |
Sets the associated nextStep.
Param | Type | DefaultValue | Description |
---|---|---|---|
oNextStep | sap.ui.core.ID sap.m.WizardStep |
ID of an element which becomes the new target of this nextStep association; alternatively, an element instance may be given |
Sets a new value for property optional.
Indicates whether or not the step is optional. When a step is optional an "(Optional)" label is displayed under the step's title.
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 |
---|---|---|---|
bOptional | boolean | false |
New value for property |
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 empty string
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sTitle | string | "" |
New value for property |
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
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bValidated | boolean | true |
New value for property |