| Package | com.vmware.widgets.interfaces |
| Interface | public interface IWizard extends flash.events.IEventDispatcher |
| Implementors | Wizard |
PageInfo objects to the wizard.
The IWizard object listens to modifications in the PageInfo
array you pass and updates its controls accordingly.WizardEvent to perform the wizard
action, and close the dialog.| Property | Defined 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 | ||
| Method | Defined By | ||
|---|---|---|---|
getPageInfo(page:UIComponent):PageInfo
Returns the PageInfo for the given page
component. | IWizard | ||
showNextPage():void
Shows the next page in the wizard. | IWizard | ||
| busy | property |
busy:BooleanThe current busy state of the wizard.
public function get busy():Boolean public function set busy(value:Boolean):void| busyMessage | property |
busyMessage:StringThe 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.
public function get currentPageInfo():PageInfo public function set currentPageInfo(value:PageInfo):void| includePageNavigator | property |
includePageNavigator:BooleanWhether 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| 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| 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():voidShows the next page in the wizard. Note that the next page may not be displayed if the current page does not commit successfully.