| Package | com.vmware.widgets.controls.wizardclasses |
| Class | public class WizardContainerBase |
| Inheritance | WizardContainerBase  mx.containers.VBox |
| Implements | IWizardContainer |
| Subclasses | WizardContainer |
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.
| Property | Defined 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 | ||
| Method | Defined By | ||
|---|---|---|---|
addButton(button:UIComponent, group:int, isDefaultButton:Boolean = false):void
Adds a button in the given button group. | WizardContainerBase | ||
focusContainer():void | 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 | ||
| Method | Defined By | ||
|---|---|---|---|
commitProperties():void [override] | WizardContainerBase | ||
createChildren():void [override] | WizardContainerBase | ||
measure():void [override] | WizardContainerBase | ||
updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void [override] | WizardContainerBase | ||
| currentPageInfo | property |
currentPageInfo:PageInfoThe current (front) page info, or null if the wizard has no pages.
public function get currentPageInfo():PageInfo public function set currentPageInfo(value:PageInfo):void| focusedControl | property |
focusedControl:Object [read-only] The ui component that currently holds input focus.
public function get focusedControl():Object| headerComponent | property |
headerComponent:DisplayObjectThe ui component that appears on the top of the wizard container, for example a page navigator component.
public function get headerComponent():DisplayObject public function set headerComponent(value:DisplayObject):void| headerContainer | property |
public var headerContainer:ContainerContainer where the header of a page goes.
| layoutPolicy | property |
layoutPolicy:StringThe layout policy for this container.
public function get layoutPolicy():String public function set layoutPolicy(value:String):void| pagesInfo | property |
pagesInfo:ArrayCollectionThe pages info for this wizard container.
public function get pagesInfo():ArrayCollection public function set pagesInfo(value:ArrayCollection):void| pageStack | property |
public var pageStack:ViewStack
The ViewStack which has all the pages of the Wizard.
| wizardButtonsContainer | property |
public var wizardButtonsContainer:Container
A Detachable container which houses the Wizard's buttons.
| addButton | () | method |
public function addButton(button:UIComponent, group:int, isDefaultButton:Boolean = false):voidAdds 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):voidAdds/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):voidAdds/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)isBusy is true.
|
| updateDisplayList | () | method |
override protected function updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
Parameters
unscaledWidth:Number | |
unscaledHeight:Number |