Packagelc.endpoint
Classpublic class StartProcessModel

The StartProcessModel class acts as the model for the StartProcess component.

The StartProcessModel class loads the contents of the list data into the navigation area in the StartProcess component. The list data contains favorites and the available categories configured on a LiveCycle ES server. Depending on the selection of a Category or FavoriteCategory object, the appropriate set of forms to start a process are loaded into the content area of the component. Each form that starts a process is represented as an Endpoint object.

See also

lc.domain.FavoriteCategory
lc.domain.Category
lc.domain.Endpoint
lc.endpoint.StartProcessModel


Public Properties
 PropertyDefined By
  iconSource : Class
The icon source.
StartProcessModel
  listData : AggregatingCollection
A collection of Category objects and FavoriteCategory objects.
StartProcessModel
  selectedListItem : Object
The currently selected item in the listData property.
StartProcessModel
  session : SessionMap
An instance of the current session map.
StartProcessModel
Public Methods
 MethodDefined By
  
Constructor.
StartProcessModel
  
Initializes the component.
StartProcessModel
Protected Methods
 MethodDefined By
  
Loads the categories from the SessionMap object and adds them to the listData property.
StartProcessModel
Public Constants
 ConstantDefined By
  STATE_INITIAL : String = "initialState"
[static] The model is set into this state upon construction.
StartProcessModel
  STATE_LOAD_ERROR : String = "loadErrorState"
[static] The model is set into this state if an error occurs while loading the categories.
StartProcessModel
  STATE_LOADING : String = "loadingState"
[static] The model is set into this state when loading the categories.
StartProcessModel
  STATE_READY : String = "loadReadyState"
[static] The model is set into this state after successfully loading the categories.
StartProcessModel
Property Detail
iconSourceproperty
public var iconSource:Class

The icon source.

listDataproperty 
public var listData:AggregatingCollection

A collection of Category objects and FavoriteCategory objects.

selectedListItemproperty 
public var selectedListItem:Object

The currently selected item in the listData property.

sessionproperty 
session:SessionMap  [read-write]

An instance of the current session map.


Implementation
    public function get session():SessionMap
    public function set session(value:SessionMap):void
Constructor Detail
StartProcessModel()Constructor
public function StartProcessModel()

Constructor.

Method Detail
initialize()method
public override function initialize():void

Initializes the component. The following items are intialized:

loadCategories()method 
protected function loadCategories():Token

Loads the categories from the SessionMap object and adds them to the listData property.

Returns
Token — A Token object that identifies whether the operation was successful.
Constant Detail
STATE_INITIALConstant
public static const STATE_INITIAL:String = "initialState"

The model is set into this state upon construction.

STATE_LOAD_ERRORConstant 
public static const STATE_LOAD_ERROR:String = "loadErrorState"

The model is set into this state if an error occurs while loading the categories.

STATE_LOADINGConstant 
public static const STATE_LOADING:String = "loadingState"

The model is set into this state when loading the categories.

STATE_READYConstant 
public static const STATE_READY:String = "loadReadyState"

The model is set into this state after successfully loading the categories.





 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/livecycle/es/sdkHelp/common/langref/lc/endpoint/StartProcessModel.html