Packagecom.vmware.widgets.controls.wizardclasses
Classpublic class PageInfo
InheritancePageInfo Inheritance Object
Implements flash.events.IEventDispatcher

Contains the information about a Wizard page.


Public Properties
 PropertyDefined By
  busy : Boolean
Indicates whether the page is busy processing or retrieving its data.
PageInfo
  busyMessage : String
The message to display when the page is busy.
PageInfo
  commitFunction : Function
Optional function called before the user navigates away to a subsequent page, or finishes the wizard.
PageInfo
  contextHelpId : String
Context help id.
PageInfo
  description : String
The page description.
PageInfo
  disabled : Boolean
Indicates whether a page is disabled independent of the page state.
PageInfo
  enableLazyLoading : Boolean
The page support for lazy loading.
PageInfo
  id : String
For test automation
PageInfo
  initialized : Boolean
Indicates if the page is completely initialized and persisted user selection is applied.
PageInfo
  page : UIComponent
The page ui component.
PageInfo
  state : String
The page state.
PageInfo
  subPagesInfo : ArrayCollection
The PageInfo objects of this page sub pages.
PageInfo
  title : String
The page title.
PageInfo
Public Methods
 MethodDefined By
  
PageInfo(page:UIComponent, title:String, description:String = null, enableLazyLoading:Boolean = false)
Constructor for PageInfo.
PageInfo
  
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, weakRef:Boolean = false):void
PageInfo
  
dispatchEvent(event:Event):Boolean
PageInfo
  
hasEventListener(type:String):Boolean
PageInfo
  
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
PageInfo
  
willTrigger(type:String):Boolean
PageInfo
Public Constants
 ConstantDefined By
  BUSY_MESSAGE_PROPERTY : String = busyMessage
[static] The busyMessage property name.
PageInfo
  BUSY_PROPERTY : String = busy
[static] The busy property name.
PageInfo
  DISABLED_PROPERTY : String = disabled
[static] The disabled property name.
PageInfo
  STATE_PROPERTY : String = state
[static] The state property name.
PageInfo
  SUB_PAGES_INFO_PROPERTY : String = subPagesInfo
[static] The subPagesInfo property name.
PageInfo
  TITLE_PROPERTY : String = title
[static] The title property name.
PageInfo
Property Detail
busyproperty
busy:Boolean

Indicates whether the page is busy processing or retrieving its data. In this case, a progress indication is displayed, and the page content is disabled.

This property can be used as the source for data binding.


Implementation
    public function get busy():Boolean
    public function set busy(value:Boolean):void
busyMessageproperty 
busyMessage:String

The message to display when the page is busy. If null then no message is displayed.

This property can be used as the source for data binding.


Implementation
    public function get busyMessage():String
    public function set busyMessage(value:String):void
commitFunctionproperty 
commitFunction:Function

Optional function called before the user navigates away to a subsequent page, or finishes the wizard. If the wizard property forwardButtonAlwaysEnabled is set to true then commit function should control if the user is able to leave the page. The function signature is: function(pageInfo:PageInfo, callback:Function, callContext:Object):void, where callback is function(pageInfo:PageInfo, allowToLeaveThePage:Boolean, callContext:Object):void.

This property can be used as the source for data binding.


Implementation
    public function get commitFunction():Function
    public function set commitFunction(value:Function):void
contextHelpIdproperty 
contextHelpId:String

Context help id.

This property can be used as the source for data binding.


Implementation
    public function get contextHelpId():String
    public function set contextHelpId(value:String):void
descriptionproperty 
description:String

The page description.

This property can be used as the source for data binding.


Implementation
    public function get description():String
    public function set description(value:String):void
disabledproperty 
disabled:Boolean

Indicates whether a page is disabled independent of the page state.

This property can be used as the source for data binding.


Implementation
    public function get disabled():Boolean
    public function set disabled(value:Boolean):void
enableLazyLoadingproperty 
enableLazyLoading:Boolean

The page support for lazy loading.

This property can be used as the source for data binding.


Implementation
    public function get enableLazyLoading():Boolean
    public function set enableLazyLoading(value:Boolean):void
idproperty 
id:String

For test automation

This property can be used as the source for data binding.


Implementation
    public function get id():String
    public function set id(value:String):void
initializedproperty 
initialized:Boolean

Indicates if the page is completely initialized and persisted user selection is applied.

This property can be used as the source for data binding.


Implementation
    public function get initialized():Boolean
    public function set initialized(value:Boolean):void
pageproperty 
page:UIComponent

The page ui component.

This property can be used as the source for data binding.


Implementation
    public function get page():UIComponent
    public function set page(value:UIComponent):void
stateproperty 
state:String

The page state. Possible values are defined in PageState. The default value is PageState.INCOMPLETE. Note that if the page has sub-pages (i.e subPagesInfo is not null), then the page state is computed based on the sub-pages states.

This property can be used as the source for data binding.


Implementation
    public function get state():String
    public function set state(value:String):void
subPagesInfoproperty 
subPagesInfo:ArrayCollection

The PageInfo objects of this page sub pages. The wizard object tracks the changes to this collection, and updates its state accordingly.

This property can be used as the source for data binding.


Implementation
    public function get subPagesInfo():ArrayCollection
    public function set subPagesInfo(value:ArrayCollection):void
titleproperty 
title:String

The page title.

This property can be used as the source for data binding.


Implementation
    public function get title():String
    public function set title(value:String):void
Constructor Detail
PageInfo()Constructor
public function PageInfo(page:UIComponent, title:String, description:String = null, enableLazyLoading:Boolean = false)

Constructor for PageInfo.

Parameters
page:UIComponent — Visual component which makes up the page to be displayed.
 
title:String — Title of the page being created. Cannot be left null.
 
description:String (default = null) — Short description of the page being created.
 
enableLazyLoading:Boolean (default = false) — Default false. Boolean for if the page supports LazyLoading.
Method Detail
addEventListener()method
public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, weakRef:Boolean = false):void

Parameters

type:String
 
listener:Function
 
useCapture:Boolean (default = false)
 
priority:int (default = 0)
 
weakRef:Boolean (default = false)

dispatchEvent()method 
public function dispatchEvent(event:Event):Boolean

Parameters

event:Event

Returns
Boolean
hasEventListener()method 
public function hasEventListener(type:String):Boolean

Parameters

type:String

Returns
Boolean
removeEventListener()method 
public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void

Parameters

type:String
 
listener:Function
 
useCapture:Boolean (default = false)

willTrigger()method 
public function willTrigger(type:String):Boolean

Parameters

type:String

Returns
Boolean
Constant Detail
BUSY_MESSAGE_PROPERTYConstant
public static const BUSY_MESSAGE_PROPERTY:String = busyMessage

The busyMessage property name.

BUSY_PROPERTYConstant 
public static const BUSY_PROPERTY:String = busy

The busy property name.

DISABLED_PROPERTYConstant 
public static const DISABLED_PROPERTY:String = disabled

The disabled property name.

STATE_PROPERTYConstant 
public static const STATE_PROPERTY:String = state

The state property name.

SUB_PAGES_INFO_PROPERTYConstant 
public static const SUB_PAGES_INFO_PROPERTY:String = subPagesInfo

The subPagesInfo property name.

TITLE_PROPERTYConstant 
public static const TITLE_PROPERTY:String = title

The title property name.




Copyright @ 2012 VMware, Inc. All rights reserved.

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