Package | com.vmware.widgets.controls.wizardclasses |
Class | public class WizardUtil |
Inheritance | WizardUtil ![]() |
Wizard
utilities.
Method | Defined By | ||
---|---|---|---|
addPagesInfoEventListener(pagesInfo:ArrayCollection, handler:Function):void [static]
Adds the given function as a CollectionEvent.COLLECTION_CHANGE
event handler of the given ArrayCollection and all nested sub
pages collections. | WizardUtil | ||
applyPageStatesDefaultPolicy(wizard:IWizard):void [static]
Updates page states starting from first to last visible page taking into account
the guidelines for Wizard navigation behavior. | WizardUtil | ||
getAllPagesInfo(pagesInfo:ArrayCollection):Array [static]
Returns the PageInfo objects in the given
collection as well as in the nested sub pages. | WizardUtil | ||
getPageInfoById(pagesInfo:ArrayCollection, id:String):PageInfo [static]
Finds a PageInfo object for a particular page, based on the page id. | WizardUtil | ||
removePagesInfoEventListener(pagesInfo:ArrayCollection, handler:Function):void [static]
Removes the given function as a CollectionEvent.COLLECTION_CHANGE
event handler of the given ArrayCollection and all nested sub
pages collections. | WizardUtil |
Constant | Defined By | ||
---|---|---|---|
BUTTON_GROUP_CENTER : int = 1 [static]
Indicates that the button is in the Wizard's buttons' center
group. | WizardUtil | ||
BUTTON_GROUP_LEFT : int = 0 [static]
Indicates that the button is in the Wizard's buttons' left
group. | WizardUtil | ||
BUTTON_GROUP_RIGHT : int = 2 [static]
Indicates that the button is in the Wizard's buttons' right
group. | WizardUtil |
addPagesInfoEventListener | () | method |
public static function addPagesInfoEventListener(pagesInfo:ArrayCollection, handler:Function):void
Adds the given function as a CollectionEvent.COLLECTION_CHANGE
event handler of the given ArrayCollection and all nested sub
pages collections.
Parameters
pagesInfo:ArrayCollection | |
handler:Function |
applyPageStatesDefaultPolicy | () | method |
public static function applyPageStatesDefaultPolicy(wizard:IWizard):void
Updates page states starting from first to last visible page taking into account
the guidelines for Wizard
navigation behavior.
The algorithm iterates through the pages starting from the first one and sets the
state of each subsequent page based on its precursor and what the currentPageInfo
of the Wizard
is.
The method should be called in two places to handle the states correctly:
- in the Wizard
on handling WizardEvent.PAGE_CHANGED
.
- in the Wizard
on changing the state of any of the pages.
Parameters
wizard:IWizard — The IWizard instance.
|
getAllPagesInfo | () | method |
public static function getAllPagesInfo(pagesInfo:ArrayCollection):Array
Returns the PageInfo
objects in the given
collection as well as in the nested sub pages.
Parameters
pagesInfo:ArrayCollection |
Array |
getPageInfoById | () | method |
public static function getPageInfoById(pagesInfo:ArrayCollection, id:String):PageInfo
Finds a PageInfo object for a particular page, based on the page id.
In order for this method to work, you need to have id
property
of you page correctly assigned.
Parameters
pagesInfo:ArrayCollection — A pagesInfo array to search. You can get it from IWizard.pagesInfo
| |
id:String — The id of the page.
|
PageInfo —
PageInfo object which contains the page with the specified id .
null if no match was found.
|
removePagesInfoEventListener | () | method |
public static function removePagesInfoEventListener(pagesInfo:ArrayCollection, handler:Function):void
Removes the given function as a CollectionEvent.COLLECTION_CHANGE
event handler of the given ArrayCollection and all nested sub
pages collections.
Parameters
pagesInfo:ArrayCollection | |
handler:Function |
BUTTON_GROUP_CENTER | Constant |
public static const BUTTON_GROUP_CENTER:int = 1
Indicates that the button is in the Wizard
's buttons' center
group.
BUTTON_GROUP_LEFT | Constant |
public static const BUTTON_GROUP_LEFT:int = 0
Indicates that the button is in the Wizard
's buttons' left
group.
BUTTON_GROUP_RIGHT | Constant |
public static const BUTTON_GROUP_RIGHT:int = 2
Indicates that the button is in the Wizard
's buttons' right
group.