ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
lc.procmgmt.ui.startpoint 

StartProcessModel  - AS3 ADEP Workspace
Packagelc.procmgmt.ui.startpoint
Classpublic class StartProcessModel
InheritanceStartProcessModel Inheritance NavigationSupervisorModel

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 10
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

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 Document 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 Startpoint object.

Related API Elements

lc.procmgmt.domain.FavoriteCategory
lc.procmgmt.domain.Category
lc.procmgmt.domain.Startpoint
lc.procmgmt.ui.startpoint.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
[override] Retrieves an instance of the current session map.
StartProcessModel
  startpointFromUrl : Startpoint
The URL for starting a process.
StartProcessModel
  startpointSelectorModel : StartpointSelectorModel
The model for the StartpointSelector.
StartProcessModel
Public Methods
 MethodDefined By
  
StartProcessModel()
Constructor.
StartProcessModel
  
initialize():void
[override] Initialize the model.
StartProcessModel
  
selectStartpoint(startpoint:Startpoint):void
Setting the selected task causes the QueueEntryData object that contains the selected task to have its details property set to true, and requests the QueueEntryData object to change to the selected task.
StartProcessModel
Protected Methods
 MethodDefined By
  
loadCategories():lc.foundation.util:Token
Loads the categories from the SessionMap object and adds them to the listData property.
StartProcessModel
Public Constants
 ConstantDefined By
  STATE_INITIAL : String = "initialState"
[static] A special value that indicates that initialization is occurring and the categories have not been loaded.
StartProcessModel
  STATE_LOAD_ERROR : String = "loadErrorState"
[static] A special value that indicates that an error occurred while loading the categories.
StartProcessModel
  STATE_LOADING : String = "loadingState"
[static] A special value that indicates that categories are being loading.
StartProcessModel
  STATE_READY : String = "loadReadyState"
[static] A special value that indicates the process of loading categories is complete.
StartProcessModel
Property Detail

iconSource

property
iconSource:Class

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 10
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

The icon source.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.



Implementation
    public function get iconSource():Class
    public function set iconSource(value:Class):void

listData

property 
listData:AggregatingCollection

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 10
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

A collection of Category objects and FavoriteCategory objects.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.



Implementation
    public function get listData():AggregatingCollection
    public function set listData(value:AggregatingCollection):void

selectedListItem

property 
selectedListItem:Object

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 10
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

The currently selected item in the listData property.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.



Implementation
    public function get selectedListItem():Object
    public function set selectedListItem(value:Object):void

session

property 
session:SessionMap[override]

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 10
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

Retrieves an instance of the current session map.



Implementation
    override public function get session():SessionMap
    override public function set session(value:SessionMap):void

startpointFromUrl

property 
startpointFromUrl:Startpoint

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 10
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

The URL for starting a process.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.



Implementation
    public function get startpointFromUrl():Startpoint
    public function set startpointFromUrl(value:Startpoint):void

startpointSelectorModel

property 
startpointSelectorModel:StartpointSelectorModel

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 10
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

The model for the StartpointSelector.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.



Implementation
    public function get startpointSelectorModel():StartpointSelectorModel
    public function set startpointSelectorModel(value:StartpointSelectorModel):void
Constructor Detail

StartProcessModel

()Constructor
public function StartProcessModel()

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 10
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

Constructor.

Method Detail

initialize

()method
override public function initialize():void

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 10
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

Initialize the model.

loadCategories

()method 
protected function loadCategories():lc.foundation.util:Token

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 10
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

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

Returns
lc.foundation.util:Token — A Token object that identifies whether the operation was successful.

selectStartpoint

()method 
public function selectStartpoint(startpoint:Startpoint):void

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 10
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

Setting the selected task causes the QueueEntryData object that contains the selected task to have its details property set to true, and requests the QueueEntryData object to change to the selected task.

Parameters

startpoint:Startpoint — Specifies the task to be selected.
Constant Detail

STATE_INITIAL

Constant
public static const STATE_INITIAL:String = "initialState"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 10
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

A special value that indicates that initialization is occurring and the categories have not been loaded.

STATE_LOAD_ERROR

Constant 
public static const STATE_LOAD_ERROR:String = "loadErrorState"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 10
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

A special value that indicates that an error occurred while loading the categories.

STATE_LOADING

Constant 
public static const STATE_LOADING:String = "loadingState"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 10
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

A special value that indicates that categories are being loading.

STATE_READY

Constant 
public static const STATE_READY:String = "loadReadyState"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 10
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

A special value that indicates the process of loading categories is complete.




© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy