Packagecom.vmware.widgets.interfaces
Interfacepublic interface IWizardContainer extends flash.events.IEventDispatcher
Implementors WizardContainerBase

Interface for a wizard container. A wizard container is a ui component that provides containers for the wizard header, current page and buttons.


Public Properties
 PropertyDefined By
  currentPageInfo : PageInfo
The current (front) page info, or null if the wizard has no pages.
IWizardContainer
  focusedControl : Object
[read-only] The ui component that currently holds input focus.
IWizardContainer
  headerComponent : DisplayObject
The ui component that appears on the top of the wizard container, for example a page navigator component.
IWizardContainer
  layoutPolicy : String
The layout policy for this container.
IWizardContainer
  pagesInfo : ArrayCollection
The pages info for this wizard container.
IWizardContainer
Public Methods
 MethodDefined By
  
addButton(control:UIComponent, group:int, isDefaultButton:Boolean = false):void
Adds a button in the given button group.
IWizardContainer
  
focusContainer():void
Sets focus to be on the container
IWizardContainer
  
setPageBusy(pageInfo:PageInfo):void
Adds/Removes a busy indicator for the given page.
IWizardContainer
  
setWizardBusy(isBusy:Boolean, busyMessage:String = null):void
Adds/Removes a busy indicator for the wizard container view.
IWizardContainer
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
layoutPolicyproperty 
layoutPolicy:String

The layout policy for this container.

The default value is fitToScreen.


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

See also

com.vmware.widgets.controls.wizardclasses.WizardLayoutPolicy
pagesInfoproperty 
pagesInfo:ArrayCollection

The pages info for this wizard container.


Implementation
    public function get pagesInfo():ArrayCollection
    public function set pagesInfo(value:ArrayCollection):void
Method Detail
addButton()method
public function addButton(control:UIComponent, group:int, isDefaultButton:Boolean = false):void

Adds a button in the given button group.

Parameters

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

focusContainer()method 
public function focusContainer():void

Sets focus to be on the container

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.




Copyright @ 2012 VMware, Inc. All rights reserved.

Fri Nov 4 2016, 08:32 AM -07:00