Packagecom.vmware.widgets.controls
Classpublic class Wizard
InheritanceWizard Inheritance flash.events.EventDispatcher
Implements IWizard
Subclasses AppWizard

An implementation of the IWizard interface.



Public Properties
 PropertyDefined 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
Public Methods
 MethodDefined 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
  
Shows the next page in the wizard.
Wizard
Events
 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
Property Detail
busyproperty
busy:Boolean

The current busy state of the wizard.

This property can be used as the source for data binding.


Implementation
    public function get busy():Boolean
    public function set busy(value:Boolean):void
busyMessageproperty 
busyMessage:String

The message that appears when the wizard is in busy state.


Implementation
    public function get busyMessage():String
    public function set busyMessage(value:String):void
containerproperty 
container:IWizardContainer

The wizard container. By default a WizardContainer instance is assigned.


Implementation
    public function get container():IWizardContainer
    public function set container(value:IWizardContainer):void
currentPageInfoproperty 
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.


Implementation
    public function get currentPageInfo():PageInfo
    public function set currentPageInfo(value:PageInfo):void
firstPageInfoproperty 
firstPageInfo:PageInfo  [read-only]

Returns the PageInfo corresponding to the first non-skipped page, or null if none.


Implementation
    public function get firstPageInfo():PageInfo
forwardButtonAlwaysEnabledproperty 
forwardButtonAlwaysEnabled:Boolean

Specifies the behavior of the next and finish buttons in the wizard:


Implementation
    public function get forwardButtonAlwaysEnabled():Boolean
    public function set forwardButtonAlwaysEnabled(value:Boolean):void
hasNextPageproperty 
hasNextPage:Boolean  [read-only]

Indicates whether a next page exists. The next page have to be navigatable, e.g. not SKIPPED or DISABLED


Implementation
    public function get hasNextPage():Boolean
hasPreviousPageproperty 
hasPreviousPage:Boolean  [read-only]

Indicates whether a previous page exists.


Implementation
    public function get hasPreviousPage():Boolean
includePageNavigatorproperty 
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.


Implementation
    public function get includePageNavigator():Boolean
    public function set includePageNavigator(value:Boolean):void
isFinishButtonEnabledproperty 
isFinishButtonEnabled:Boolean  [read-only]

Tests whether the wizard can be finished. By default this is true if all pages have PageState.COMPLETE state.


Implementation
    public function get isFinishButtonEnabled():Boolean
nextPageInfoproperty 
nextPageInfo:PageInfo  [read-only]

Returns the next PageInfo (i.e the one you will go if you call showNextPage), or null if none.


Implementation
    public function get nextPageInfo():PageInfo
pagesInfoproperty 
pagesInfo:ArrayCollection

The PageInfo objects of this wizard's pages. The wizard object tracks the changes to this collection, and updates its state accordingly.


Implementation
    public function get pagesInfo():ArrayCollection
    public function set pagesInfo(value:ArrayCollection):void
previousPageInfoproperty 
previousPageInfo:PageInfo  [read-only]

Returns the previous PageInfo, or null if none.


Implementation
    public function get previousPageInfo():PageInfo
validationOnForwardOnlyproperty 
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.


Implementation
    public function get validationOnForwardOnly():Boolean
    public function set validationOnForwardOnly(value:Boolean):void
Constructor Detail
Wizard()Constructor
public function Wizard(wizardContainer:IWizardContainer = null)

Creates a new wizard instance.

Parameters
wizardContainer:IWizardContainer (default = null) — The IWizardContainer implementation to be used within in this wizard
Method Detail
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

Returns
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.

Event Detail
close Event
Event Object Type: mx.events.CloseEvent
CloseEvent.type property = mx.events.CloseEvent.CLOSE

The event for the Close button.

minimize Event  
Event Object Type: com.vmware.widgets.events.DialogEvent
DialogEvent.type property = com.vmware.widgets.events.DialogEvent.MINIMIZE

The event for the Minimize button.

Defines the value of the type propertyEvent for a dialog's minimize event.
ok Event  
Event Object Type: com.vmware.widgets.events.DialogEvent
DialogEvent.type property = com.vmware.widgets.events.DialogEvent.OK

The event for the Finish button.

Defines the value of the type propertyEvent for a dialog's OK or confirmation event.
wizardEventNavigatorChanged Event  
Event Object Type: com.vmware.widgets.events.WizardEvent
WizardEvent.type property = com.vmware.widgets.events.WizardEvent.NAVIGATOR_CHANGED

The event dispatched when the current wizard navigator changes.

Defines the value of the type property for a wizardEventNavigatorChanged event, which indicates that the wizard navigator has changed.
wizardEventPageChanged Event  
Event Object Type: com.vmware.widgets.events.WizardEvent
WizardEvent.type property = com.vmware.widgets.events.WizardEvent.PAGE_CHANGED

The event dispatched when the current wizard page changes.

Defines the value of the type property for a pageChanged event, which indicates that a page has changed using the Next/Previous buttons, or the page navigator.