lc.procmgmt.ui.task

# ToDoModel - AS3 ADEP Workspace

Package | lc.procmgmt.ui.task
Class | public class ToDoModel
Inheritance | ToDoModel NavigationSupervisorModel

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 `ToDoModel` class provides the model implementation for the the `ToDo` component.

Related API Elements

lc.procmgmt.ui.task.ToDo

Public Properties

| Property | Defined By
--- | --- | ---
|  | defaultQueueSize : int The number of tasks that exist in the user's default queue. | ToDoModel
|  | iconSource : Class The icon associated with the CSS style name ToDo. | ToDoModel
|  | listData : AggregatingCollection A collection of QueueEntryData objects and a SearchTemplateDescriptors component. | ToDoModel
|  | queuesInitialized : Boolean For internal use only. | ToDoModel
|  | queuesManager : QueuesManager The collection of different queues, which is represented by a Queues object, that the user has access to. | ToDoModel
|  | selectedListItem : Object The selected entry from the listData property. | ToDoModel
|  | session : SessionMap [override] [write-only] A SessionMap object that stores infomation relating to the server session. | ToDoModel
|  | toDoSelectorModel : lc.procmgmt.ui.task:ToDoSelectorModel For internal use only. | ToDoModel

Public Methods

| Method | Defined By
--- | --- | ---
|  | ToDoModel() Constructor. | ToDoModel
|  | refresh():void Refreshes the state of the container. | ToDoModel
|  | selectTask(task:lc.procmgmt.domain:Task):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. | ToDoModel

Public Constants

| Constant | Defined By
--- | --- | ---
|  | STATE_INITIAL : String = "initialState" [static] A specifical value that specifies that the model is set an initial state when it is created. | ToDoModel

Property Detail

### defaultQueueSize

property

`defaultQueueSize:int`

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 number of tasks that exist in the user's default queue.

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 defaultQueueSize():int`
`public function set defaultQueueSize(value:int):void`

### iconSource

property

`iconSource:Class`

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 icon associated with the CSS style name ToDo.

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 9

Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10

A collection of `QueueEntryData` objects and a `SearchTemplateDescriptors` component.

The collection of `QueueEntryData` objects contain the default queues, user queues, and group queues that a user has access to.

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`

### queuesInitialized

property

`queuesInitialized:Boolean`

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

For internal use only. Do not use. The model for the `ToDoSelector` 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 queuesInitialized():Boolean`
`public function set queuesInitialized(value:Boolean):void`

### queuesManager

property

`queuesManager:QueuesManager`

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 collection of different queues, which is represented by a `Queues` object, that the user has access to.

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 queuesManager():QueuesManager`
`public function set queuesManager(value:QueuesManager):void`

Related API Elements

lc.domain.Queue

### selectedListItem

property

`selectedListItem: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 selected entry from the `listData` property.

The default behavior for the model is to identify the user's default queue when it is first created. The model also uses this property to select the correct queue if a `Task` object is accessed directly.

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` [write-only] [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 set session(value:SessionMap):void`

### toDoSelectorModel

property

`toDoSelectorModel:lc.procmgmt.ui.task:ToDoSelectorModel`

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

For internal use only. Do not use. The model for the `ToDoSelector` 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 toDoSelectorModel():lc.procmgmt.ui.task:ToDoSelectorModel`
`public function set toDoSelectorModel(value:lc.procmgmt.ui.task:ToDoSelectorModel):void`
Constructor Detail

### ToDoModel

()
Constructor

`public function ToDoModel()`

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

### refresh

()
method

`public function refresh():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

Refreshes the state of the container. This method is typically invoked by the view when it is reentered and reshown.

### selectTask

()
method

`public function selectTask(task:lc.procmgmt.domain:Task):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

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

| `task:lc.procmgmt.domain:Task` — 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 9

Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10

A specifical value that specifies that the model is set an initial state when it is created.

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00