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.tracking 

ProcessInstanceDataGridModel  - AS3 ADEP Workspace

Packagelc.procmgmt.ui.tracking
Classpublic class ProcessInstanceDataGridModel
InheritanceProcessInstanceDataGridModel Inheritance PresentationModel Inheritance EventDispatcher Inheritance Object

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

The ProcessInstanceDataGridModel class obtains the ProcessInstance objects for the selected Process object.

The model provides support for the ProcessInstanceDataGrid component, by filtering the collection of process instances using the start time and end time of a process instance.

Related API Elements



Public Properties
 PropertyDefined By
  collatedProcesses : CollatedProcesses
[read-only] CollatedProcesses is a Collection of Process objects sharing the same processTitle, each one containing its list of ProcessInstance objects.
ProcessInstanceDataGridModel
  columns : Array
The array of columns definitions used by the datagrid.
ProcessInstanceDataGridModel
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  endDate : Date
The date and time to use for filtering a collection of ProcessInstance objects.
ProcessInstanceDataGridModel
  filterPanelModel : FilterPanelModel
A FilterPanelModel object provides support for the FilterPanel component.
ProcessInstanceDataGridModel
  process : Process
[read-only] A collection of ProcessInstance objects.
ProcessInstanceDataGridModel
  processInstanceDetailsSelectorModel : ProcessInstanceDetailsSelectorModel
A ProcessInstanceDetailsSelectorModel object provides support for the ProcessInstanceDetailsSelector component.
ProcessInstanceDataGridModel
  processInstances : ListCollectionView
The list of ProcessInstances displayed in the datagrid.
ProcessInstanceDataGridModel
  selectedProcessInstance : ProcessInstance
[read-only] The process instance that is identifed as the selected ProcessInstance object that is loaded into the ProcessInstanceDetailSelectorModel object.
ProcessInstanceDataGridModel
  session : SessionMap
[override] A SessionMap object that stores infomation relating to the server session.
ProcessInstanceDataGridModel
  startDate : Date
The date and time to use for filtering a collection of ProcessInstance objects.
ProcessInstanceDataGridModel
 Inheritedstate : String
[read-only] The name of the state the current view is in.
PresentationModel
Public Methods
 MethodDefined By
  
Constructor.
ProcessInstanceDataGridModel
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.
EventDispatcher
 Inherited
bindProperty(destination:Object, destinationProperty:String, source:Object, sourceChain:Object, commitOnly:Boolean = false):ChangeWatcher
Binds a public property on the destination object from a property or property chain on the source object.
PresentationModel
 Inherited
Dispatches an event into the event flow.
EventDispatcher
  
Changes the model into the ProcessInstanceDataGridModel.STATE_PROCESS_INSTANCE_DETAILS state using the provided ProcessInstance object.
ProcessInstanceDataGridModel
 Inherited
getCSSStyle(declaration:String, styleProperty:String, defaultValue:Object = null):Object
Returns the corresponding cascading style sheet (CSS) property to use based on the specified parameters.
PresentationModel
 Inherited
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Initializes the presentation model after the view bindings are processed to prevent view bindings from overriding the initial model state.
PresentationModel
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
  
Rebuild the columns for the datagrid.
ProcessInstanceDataGridModel
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
  
Reinitializes the model to an empty state, without an process instances in the datagrid.
ProcessInstanceDataGridModel
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
 Inherited
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
EventDispatcher
Protected Methods
 MethodDefined By
 Inherited
setState(newState:String):void
Sets the state property to a new value and causes a PropertyChangeEvent event.
PresentationModel
Events
 Event Summary Defined By
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.EventDispatcher
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.EventDispatcher
Public Constants
 ConstantDefined By
  STATE_DATA : String = "dataState"
[static] A special value that specifies that the datagrid is being displayed, and one or more items exist.
ProcessInstanceDataGridModel
  STATE_EMPTY : String = "emptyState"
[static] A special value that specifies thatthere are no process instances in the datagrid.
ProcessInstanceDataGridModel
  STATE_PROCESS_INSTANCE_DETAILS : String = "processInstanceDetailState"
[static] A special value that specifies that the process details and audit information are being displayed.
ProcessInstanceDataGridModel
Property Detail

collatedProcesses

property
collatedProcesses:CollatedProcesses  [read-only]

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

CollatedProcesses is a Collection of Process objects sharing the same processTitle, each one containing its list of ProcessInstance 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 collatedProcesses():CollatedProcesses

columns

property 
columns:Array

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

The array of columns definitions used by the datagrid.



Implementation
    public function get columns():Array
    public function set columns(value:Array):void

endDate

property 
endDate:Date

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

The date and time to use for filtering a collection of ProcessInstance objects. Process instances after the date and time specified by this property are filtered out.



Implementation
    public function get endDate():Date
    public function set endDate(value:Date):void

filterPanelModel

property 
filterPanelModel:FilterPanelModel

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

A FilterPanelModel object provides support for the FilterPanel component.

The FilterPanel component provides client side filtering.



Implementation
    public function get filterPanelModel():FilterPanelModel
    public function set filterPanelModel(value:FilterPanelModel):void

process

property 
process:Process  [read-only]

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

A collection of ProcessInstance objects. Setting the process property loads the associated ProcessInstance 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 process():Process

processInstanceDetailsSelectorModel

property 
processInstanceDetailsSelectorModel:ProcessInstanceDetailsSelectorModel

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

A ProcessInstanceDetailsSelectorModel object provides support for the ProcessInstanceDetailsSelector component.

The ProcessInstanceDetailsSelector component provides details about the selected ProcessInstance object.



Implementation
    public function get processInstanceDetailsSelectorModel():ProcessInstanceDetailsSelectorModel
    public function set processInstanceDetailsSelectorModel(value:ProcessInstanceDetailsSelectorModel):void

processInstances

property 
processInstances:ListCollectionView

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

The list of ProcessInstances displayed in the datagrid.



Implementation
    public function get processInstances():ListCollectionView
    public function set processInstances(value:ListCollectionView):void

selectedProcessInstance

property 
selectedProcessInstance:ProcessInstance  [read-only]

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

The process instance that is identifed as the selected ProcessInstance object that is loaded into the ProcessInstanceDetailSelectorModel object.

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 selectedProcessInstance():ProcessInstance

session

property 
session:SessionMap[override]

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

A SessionMap object that stores infomation relating to the server session.

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



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

startDate

property 
startDate:Date

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

The date and time to use for filtering a collection of ProcessInstance objects. Process instances before the date and time specified by this property are filtered out.



Implementation
    public function get startDate():Date
    public function set startDate(value:Date):void
Constructor Detail

ProcessInstanceDataGridModel

()Constructor
public function ProcessInstanceDataGridModel()

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

Constructor.

Method Detail

displayProcessInstanceDetails

()method
public function displayProcessInstanceDetails(value:ProcessInstance):void

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

Changes the model into the ProcessInstanceDataGridModel.STATE_PROCESS_INSTANCE_DETAILS state using the provided ProcessInstance object.

Parameters

value:ProcessInstance — Specifies the ProcessInstance object for which to display the details.

reloadColumns

()method 
public function reloadColumns():void

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

Rebuild the columns for the datagrid.

reset

()method 
public function reset():void

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

Reinitializes the model to an empty state, without an process instances in the datagrid.

Constant Detail

STATE_DATA

Constant
public static const STATE_DATA:String = "dataState"

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

A special value that specifies that the datagrid is being displayed, and one or more items exist.

STATE_EMPTY

Constant 
public static const STATE_EMPTY:String = "emptyState"

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

A special value that specifies thatthere are no process instances in the datagrid.

STATE_PROCESS_INSTANCE_DETAILS

Constant 
public static const STATE_PROCESS_INSTANCE_DETAILS:String = "processInstanceDetailState"

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

A special value that specifies that the process details and audit information are being displayed.