Package | com.vmware.widgets.controls |
Class | public class Wizard |
Inheritance | Wizard ![]() |
Implements | IWizard |
Subclasses | AppWizard |
IWizard
interface.
Property | Defined By | ||
---|---|---|---|
busy : Boolean
The current busy state of the wizard. | Wizard | ||
busyMessage : String
The message that appears when the wizard is in busy state. | Wizard | ||
container : IWizardContainer
The wizard container. | Wizard | ||
currentPageInfo : PageInfo
The PageInfo for the current front page,
or null if the wizard has no pages. | Wizard | ||
firstPageInfo : PageInfo [read-only]
Returns the PageInfo corresponding to the first
non-skipped page, or null if none. | Wizard | ||
forwardButtonAlwaysEnabled : Boolean
Specifies the behavior of the next and finish buttons in the wizard:
If the value is true then the next button will be always enabled. | Wizard | ||
hasNextPage : Boolean [read-only]
Indicates whether a next page exists. | Wizard | ||
hasPreviousPage : Boolean [read-only]
Indicates whether a previous page exists. | Wizard | ||
includePageNavigator : Boolean
Whether to include a page navigation control that
can be used to activate individual pages. | Wizard | ||
isFinishButtonEnabled : Boolean [read-only]
Tests whether the wizard can be finished. | Wizard | ||
nextPageInfo : PageInfo [read-only]
Returns the next PageInfo (i.e the one you will go if you
call showNextPage), or null if none. | Wizard | ||
pagesInfo : ArrayCollection
The PageInfo objects of this wizard's pages. | Wizard | ||
previousPageInfo : PageInfo [read-only]
Returns the previous PageInfo, or null if none. | Wizard | ||
validationOnForwardOnly : Boolean
Whether the Wizard is configured for validation on just forward navigation. | Wizard |
Method | Defined By | ||
---|---|---|---|
Wizard(wizardContainer:IWizardContainer = null)
Creates a new wizard instance. | Wizard | ||
dispose():void | Wizard | ||
getPageInfo(page:UIComponent):PageInfo
Returns the PageInfo for the given page
component. | Wizard | ||
showNextPage():void
Shows the next page in the wizard. | Wizard |
Event | Summary | Defined By | ||
---|---|---|---|---|
The event for the Close button. | Wizard | |||
The event for the Minimize button. | Wizard | |||
The event for the Finish button. | Wizard | |||
The event dispatched when the current wizard navigator changes. | Wizard | |||
The event dispatched when the current wizard page changes. | Wizard |
busy | property |
busy:Boolean
The current busy state of the wizard.
This property can be used as the source for data binding.
public function get busy():Boolean
public function set busy(value:Boolean):void
busyMessage | property |
busyMessage:String
The message that appears when the wizard is in busy state.
public function get busyMessage():String
public function set busyMessage(value:String):void
container | property |
container:IWizardContainer
The wizard container.
By default a WizardContainer
instance is
assigned.
public function get container():IWizardContainer
public function set container(value:IWizardContainer):void
currentPageInfo | property |
currentPageInfo:PageInfo
The PageInfo
for the current front page,
or null if the wizard has no pages.
This property can be used as the source for data binding.
public function get currentPageInfo():PageInfo
public function set currentPageInfo(value:PageInfo):void
firstPageInfo | property |
firstPageInfo:PageInfo
[read-only] Returns the PageInfo corresponding to the first non-skipped page, or null if none.
public function get firstPageInfo():PageInfo
forwardButtonAlwaysEnabled | property |
forwardButtonAlwaysEnabled:Boolean
Specifies the behavior of the next and finish buttons in the wizard:
public function get forwardButtonAlwaysEnabled():Boolean
public function set forwardButtonAlwaysEnabled(value:Boolean):void
hasNextPage | property |
hasNextPage:Boolean
[read-only]
Indicates whether a next page exists. The next page have to be navigatable, e.g.
not SKIPPED
or DISABLED
public function get hasNextPage():Boolean
hasPreviousPage | property |
hasPreviousPage:Boolean
[read-only] Indicates whether a previous page exists.
public function get hasPreviousPage():Boolean
includePageNavigator | property |
includePageNavigator:Boolean
Whether to include a page navigation control that can be used to activate individual pages. If navigation control is not shown then the wizard will only show the page label and description for the current page. The default value is true.
public function get includePageNavigator():Boolean
public function set includePageNavigator(value:Boolean):void
isFinishButtonEnabled | property |
isFinishButtonEnabled:Boolean
[read-only]
Tests whether the wizard can be finished.
By default this is true if all pages have PageState.COMPLETE
state.
public function get isFinishButtonEnabled():Boolean
nextPageInfo | property |
nextPageInfo:PageInfo
[read-only]
Returns the next PageInfo (i.e the one you will go if you
call showNextPage
), or null if none.
public function get nextPageInfo():PageInfo
pagesInfo | property |
pagesInfo:ArrayCollection
The PageInfo
objects of this wizard's pages.
The wizard object tracks the changes to this collection, and
updates its state accordingly.
public function get pagesInfo():ArrayCollection
public function set pagesInfo(value:ArrayCollection):void
previousPageInfo | property |
previousPageInfo:PageInfo
[read-only] Returns the previous PageInfo, or null if none.
public function get previousPageInfo():PageInfo
validationOnForwardOnly | property |
validationOnForwardOnly:Boolean
Whether the Wizard is configured for validation on just forward navigation. If
set to true
(which is the default value),
incomplete/invalid pages can be left without validation if the user goes backwards
to the previous pages. If set to false
, page validation is executed
no matter if the user navigates forward or backwards.
public function get validationOnForwardOnly():Boolean
public function set validationOnForwardOnly(value:Boolean):void
Wizard | () | Constructor |
public function Wizard(wizardContainer:IWizardContainer = null)
Creates a new wizard instance.
ParameterswizardContainer:IWizardContainer (default = null ) — The IWizardContainer implementation to be used within in this wizard
|
dispose | () | method |
public function dispose():void
getPageInfo | () | method |
public function getPageInfo(page:UIComponent):PageInfo
Returns the PageInfo
for the given page
component.
Parameters
page:UIComponent |
PageInfo |
showNextPage | () | method |
public function showNextPage():void
Shows the next page in the wizard. Note that the next page may not be displayed if the current page does not commit successfully.
close | Event |
mx.events.CloseEvent
mx.events.CloseEvent.CLOSE
The event for the Close button.
minimize | Event |
com.vmware.widgets.events.DialogEvent
com.vmware.widgets.events.DialogEvent.MINIMIZE
The event for the Minimize button.
Defines the value of thetype
propertyEvent for a dialog's
minimize event.
ok | Event |
com.vmware.widgets.events.DialogEvent
com.vmware.widgets.events.DialogEvent.OK
The event for the Finish button.
Defines the value of thetype
propertyEvent for a dialog's
OK or confirmation event.
wizardEventNavigatorChanged | Event |
com.vmware.widgets.events.WizardEvent
com.vmware.widgets.events.WizardEvent.NAVIGATOR_CHANGED
The event dispatched when the current wizard navigator changes.
Defines the value of thetype
property for a
wizardEventNavigatorChanged
event, which indicates that the wizard
navigator has changed.
wizardEventPageChanged | Event |
com.vmware.widgets.events.WizardEvent
com.vmware.widgets.events.WizardEvent.PAGE_CHANGED
The event dispatched when the current wizard page changes.
Defines the value of thetype
property for a
pageChanged
event, which indicates that a page
has changed using the Next/Previous buttons, or the page navigator.