GODPAPER | All Packages | All Classes | Index | Frames No Frames |
TaskEvent

Package | com.adobe.cairngorm.task
Class | public class TaskEvent
Inheritance | TaskEvent flash.events.Event

An event that occurs while processing a task.

Public Properties

| Property | Defined By
--- | --- | ---
|  | message : String [read-only] The message desribing the cause of a taskFault event. | TaskEvent
|  | processed : uint [read-only] | TaskEvent
|  | size : uint [read-only] | TaskEvent
|  | task : ITask [read-only] The task that the event applies to. | TaskEvent

Public Methods

| Method | Defined By
--- | --- | ---
|  | TaskEvent(type:String, task:ITask) | TaskEvent
|  | clone():Event [override] | TaskEvent
|  | createChildCompleteEvent(task:ITask):TaskEvent [static] | TaskEvent
|  | createChildFaultEvent(task:ITask, message:String = null):TaskEvent [static] | TaskEvent
|  | createChildStartEvent(task:ITask):TaskEvent [static] | TaskEvent
|  | createCompleteEvent(task:ITask):TaskEvent [static] | TaskEvent
|  | createFaultEvent(task:ITask, message:String = null):TaskEvent [static] | TaskEvent
|  | createProgressEvent(task:ITask, processed:uint, size:uint):TaskEvent [static] | TaskEvent
|  | createStartEvent(task:ITask):TaskEvent [static] | TaskEvent

Public Constants

| Constant | Defined By
--- | --- | ---
|  | CHILD_COMPLETE : String = childComplete [static] | TaskEvent
|  | CHILD_FAULT : String = childFault [static] | TaskEvent
|  | CHILD_START : String = childStart [static] | TaskEvent
|  | TASK_COMPLETE : String = taskComplete [static] | TaskEvent
|  | TASK_FAULT : String = taskFault [static] | TaskEvent
|  | TASK_PROGRESS : String = taskProgress [static] | TaskEvent
|  | TASK_START : String = taskStart [static] | TaskEvent

Property Detail

message | property

`message:String` [read-only]

The message desribing the cause of a taskFault event.

Implementation
`public function get message():String`

processed | property |

`processed:uint` [read-only]

Implementation
`public function get processed():uint`

size | property |

`size:uint` [read-only]

Implementation
`public function get size():uint`

task | property |

`task:ITask` [read-only]

The task that the event applies to.

Implementation
`public function get task():ITask`
Constructor Detail

TaskEvent | () | Constructor

`public function TaskEvent(type:String, task:ITask)`

Parameters

| `type:String`
| `task:ITask`

Method Detail

clone | () | method

`override public function clone():Event`

Returns

| `Event`

createChildCompleteEvent | () | method |

`public static function createChildCompleteEvent(task:ITask):TaskEvent`

Parameters

| `task:ITask`

Returns

| `TaskEvent`

createChildFaultEvent | () | method |

`public static function createChildFaultEvent(task:ITask, message:String = null):TaskEvent`

Parameters

| `task:ITask`
| `message:String` (default = `null`)``

Returns

| `TaskEvent`

createChildStartEvent | () | method |

`public static function createChildStartEvent(task:ITask):TaskEvent`

Parameters

| `task:ITask`

Returns

| `TaskEvent`

createCompleteEvent | () | method |

`public static function createCompleteEvent(task:ITask):TaskEvent`

Parameters

| `task:ITask`

Returns

| `TaskEvent`

createFaultEvent | () | method |

`public static function createFaultEvent(task:ITask, message:String = null):TaskEvent`

Parameters

| `task:ITask`
| `message:String` (default = `null`)``

Returns

| `TaskEvent`

createProgressEvent | () | method |

`public static function createProgressEvent(task:ITask, processed:uint, size:uint):TaskEvent`

Parameters

| `task:ITask`
| `processed:uint`
| `size:uint`

Returns

| `TaskEvent`

createStartEvent | () | method |

`public static function createStartEvent(task:ITask):TaskEvent`

Parameters

| `task:ITask`

Returns

| `TaskEvent`

Constant Detail

CHILD_COMPLETE | Constant

`public static const CHILD_COMPLETE:String = childComplete`

CHILD_FAULT | Constant |

`public static const CHILD_FAULT:String = childFault`

CHILD_START | Constant |

`public static const CHILD_START:String = childStart`

TASK_COMPLETE | Constant |

`public static const TASK_COMPLETE:String = taskComplete`

TASK_FAULT | Constant |

`public static const TASK_FAULT:String = taskFault`

TASK_PROGRESS | Constant |

`public static const TASK_PROGRESS:String = taskProgress`

TASK_START | Constant |

`public static const TASK_START:String = taskStart`

Thu Jan 16 2014, 01:11 PM +08:00