Package | com.vmware.widgets.controls.wizardclasses |
Class | public class PageInfo |
Inheritance | PageInfo ![]() |
Implements | flash.events.IEventDispatcher |
Wizard
page.
Property | Defined 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 |
Method | Defined 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 |
Constant | Defined 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 |
busy | property |
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.
public function get busy():Boolean
public function set busy(value:Boolean):void
busyMessage | property |
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.
public function get busyMessage():String
public function set busyMessage(value:String):void
commitFunction | property |
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.
public function get commitFunction():Function
public function set commitFunction(value:Function):void
contextHelpId | property |
contextHelpId:String
Context help id.
This property can be used as the source for data binding.
public function get contextHelpId():String
public function set contextHelpId(value:String):void
description | property |
description:String
The page description.
This property can be used as the source for data binding.
public function get description():String
public function set description(value:String):void
disabled | property |
disabled:Boolean
Indicates whether a page is disabled independent of the page state.
This property can be used as the source for data binding.
public function get disabled():Boolean
public function set disabled(value:Boolean):void
enableLazyLoading | property |
enableLazyLoading:Boolean
The page support for lazy loading.
This property can be used as the source for data binding.
public function get enableLazyLoading():Boolean
public function set enableLazyLoading(value:Boolean):void
id | property |
id:String
For test automation
This property can be used as the source for data binding.
public function get id():String
public function set id(value:String):void
initialized | property |
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.
public function get initialized():Boolean
public function set initialized(value:Boolean):void
page | property |
page:UIComponent
The page ui component.
This property can be used as the source for data binding.
public function get page():UIComponent
public function set page(value:UIComponent):void
state | property |
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.
public function get state():String
public function set state(value:String):void
subPagesInfo | property |
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.
public function get subPagesInfo():ArrayCollection
public function set subPagesInfo(value:ArrayCollection):void
title | property |
title:String
The page title.
This property can be used as the source for data binding.
public function get title():String
public function set title(value:String):void
PageInfo | () | Constructor |
public function PageInfo(page:UIComponent, title:String, description:String = null, enableLazyLoading:Boolean = false)
Constructor for PageInfo.
Parameterspage: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.
|
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 |
Boolean |
hasEventListener | () | method |
public function hasEventListener(type:String):Boolean
Parameters
type:String |
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 |
Boolean |
BUSY_MESSAGE_PROPERTY | Constant |
public static const BUSY_MESSAGE_PROPERTY:String = busyMessage
The busyMessage
property name.
BUSY_PROPERTY | Constant |
public static const BUSY_PROPERTY:String = busy
The busy
property name.
DISABLED_PROPERTY | Constant |
public static const DISABLED_PROPERTY:String = disabled
The disabled
property name.
STATE_PROPERTY | Constant |
public static const STATE_PROPERTY:String = state
The state
property name.
SUB_PAGES_INFO_PROPERTY | Constant |
public static const SUB_PAGES_INFO_PROPERTY:String = subPagesInfo
The subPagesInfo
property name.
TITLE_PROPERTY | Constant |
public static const TITLE_PROPERTY:String = title
The title
property name.