Packagecom.vmware.widgets.controls.wizardclasses
Classpublic class WizardContainerBase
InheritanceWizardContainerBase Inheritance mx.containers.VBox
Implements IWizardContainer
Subclasses WizardContainer

The code behind the WizardContainer component. This class extends VBox and ensures that a standard width and height is used for the content of Wizard. The container also handles the ViewStack for the multiple pages of the Wizard.



Public Properties
 PropertyDefined By
  currentPageInfo : PageInfo
The current (front) page info, or null if the wizard has no pages.
WizardContainerBase
  focusedControl : Object
[read-only] The ui component that currently holds input focus.
WizardContainerBase
  headerComponent : DisplayObject
The ui component that appears on the top of the wizard container, for example a page navigator component.
WizardContainerBase
  headerContainer : Container
Container where the header of a page goes.
WizardContainerBase
  layoutPolicy : String
The layout policy for this container.
WizardContainerBase
  pagesInfo : ArrayCollection
The pages info for this wizard container.
WizardContainerBase
  pageStack : ViewStack
The ViewStack which has all the pages of the Wizard.
WizardContainerBase
  wizardButtonsContainer : Container
A Detachable container which houses the Wizard's buttons.
WizardContainerBase
Public Methods
 MethodDefined By
  
addButton(button:UIComponent, group:int, isDefaultButton:Boolean = false):void
Adds a button in the given button group.
WizardContainerBase
  
WizardContainerBase
  
setPageBusy(pageInfo:PageInfo):void
Adds/Removes a busy indicator for the given page.
WizardContainerBase
  
setWizardBusy(isBusy:Boolean, busyMessage:String = null):void
Adds/Removes a busy indicator for the wizard container view.
WizardContainerBase
Protected Methods
 MethodDefined By
  
[override]
WizardContainerBase
  
[override]
WizardContainerBase
  
measure():void
[override]
WizardContainerBase
  
updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
[override]
WizardContainerBase
Property Detail
currentPageInfoproperty
currentPageInfo:PageInfo

The current (front) page info, or null if the wizard has no pages.


Implementation
    public function get currentPageInfo():PageInfo
    public function set currentPageInfo(value:PageInfo):void
focusedControlproperty 
focusedControl:Object  [read-only]

The ui component that currently holds input focus.


Implementation
    public function get focusedControl():Object
headerComponentproperty 
headerComponent:DisplayObject

The ui component that appears on the top of the wizard container, for example a page navigator component.


Implementation
    public function get headerComponent():DisplayObject
    public function set headerComponent(value:DisplayObject):void
headerContainerproperty 
public var headerContainer:Container

Container where the header of a page goes.

layoutPolicyproperty 
layoutPolicy:String

The layout policy for this container.


Implementation
    public function get layoutPolicy():String
    public function set layoutPolicy(value:String):void
pagesInfoproperty 
pagesInfo:ArrayCollection

The pages info for this wizard container.


Implementation
    public function get pagesInfo():ArrayCollection
    public function set pagesInfo(value:ArrayCollection):void
pageStackproperty 
public var pageStack:ViewStack

The ViewStack which has all the pages of the Wizard.

wizardButtonsContainerproperty 
public var wizardButtonsContainer:Container

A Detachable container which houses the Wizard's buttons.

Method Detail
addButton()method
public function addButton(button:UIComponent, group:int, isDefaultButton:Boolean = false):void

Adds a button in the given button group.

Parameters

button:UIComponent — The button's control.
 
group:int — The button group; valid values are defined in ButtonGroup.
 
isDefaultButton:Boolean (default = false)

commitProperties()method 
override protected function commitProperties():void

createChildren()method 
override protected function createChildren():void

focusContainer()method 
public function focusContainer():void

measure()method 
override protected function measure():void

setPageBusy()method 
public function setPageBusy(pageInfo:PageInfo):void

Adds/Removes a busy indicator for the given page. When a page is busy, the user cannot interact with its content.

Parameters

pageInfo:PageInfo — The changed page info.

setWizardBusy()method 
public function setWizardBusy(isBusy:Boolean, busyMessage:String = null):void

Adds/Removes a busy indicator for the wizard container view. When a wizard is busy, the user cannot interact with its content. Only the minimize and cancel buttons should be enabled.

Parameters

isBusy:Boolean — Whether to add or remove the busy indicator.
 
busyMessage:String (default = null) — The message to display when the wizard is busy. Used only when isBusy is true.

updateDisplayList()method 
override protected function updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void

Parameters

unscaledWidth:Number
 
unscaledHeight:Number