Packagecom.vmware.widgets.interfaces
Interfacepublic interface IWizard extends flash.events.IEventDispatcher
Implementors Wizard

Interface for a wizard. The Wizard class implements the details for standard wizard behavior. The primary responsibilities of the wizard user include:



Public Properties
 PropertyDefined By
  busy : Boolean
The current busy state of the wizard.
IWizard
  busyMessage : String
The message that appears when the wizard is in busy state.
IWizard
  container : IWizardContainer
The wizard container.
IWizard
  currentPageInfo : PageInfo
The PageInfo for the current front page, or null if the wizard has no pages.
IWizard
  includePageNavigator : Boolean
Whether to include a page navigation control that can be used to activate individual pages.
IWizard
  pagesInfo : ArrayCollection
The PageInfo objects of this wizard's pages.
IWizard
Public Methods
 MethodDefined By
  
getPageInfo(page:UIComponent):PageInfo
Returns the PageInfo for the given page component.
IWizard
  
Shows the next page in the wizard.
IWizard
Property Detail
busyproperty
busy:Boolean

The current busy state of the wizard.


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.


Implementation
    public function get currentPageInfo():PageInfo
    public function set currentPageInfo(value:PageInfo):void
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
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
Method Detail
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.