| Package | org.springextensions.actionscript.core.operation |
| SVN browsing | IProgressOperation.as |
| Fisheye | IProgressOperation.as |
| Interface | public interface IProgressOperation extends IOperation, flash.events.IEventDispatcher |
| Implementors | AbstractProgressOperation |
IOperation that contains information about the progress of an operation.
Documentation reference: long running operations
| Property | Defined by | ||
|---|---|---|---|
 | error : *
The error of this operation or
null if no error occurred during this operation. | IOperation | |
| progress : uint [read-only]
The progress of this operation.
| IProgressOperation | ||
| result : *
The result of this operation or
null if the operation does not have a result. | IOperation | |
| timeout : int
The timeout in milliseconds.
| IOperation | |
| total : uint [read-only]
The total amount of progress this operation should make before being done.
| IProgressOperation | ||
| Method | Defined by | ||
|---|---|---|---|
|
addCompleteListener(listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Convenience method for adding a listener to the OperationEvent.COMPLETE event.
| IOperation | |
|
addErrorListener(listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Convenience method for adding a listener to the OperationEvent.ERROR event.
| IOperation | |
|
addProgressListener(listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Convenience method for adding a listener to the OperationEvent.PROGRESS event.
| IProgressOperation | ||
|
addTimeoutListener(listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Convenience method for adding a listener to the OperationEvent.TIMEOUT event.
| IOperation | |
|
removeCompleteListener(listener:Function, useCapture:Boolean = false):void
Convenience method for removing a listener from the OperationEvent.COMPLETE event.
| IOperation | |
|
removeErrorListener(listener:Function, useCapture:Boolean = false):void
Convenience method for removing a listener from the OperationEvent.ERROR event.
| IOperation | |
|
removeProgressListener(listener:Function, useCapture:Boolean = false):void
Convenience method for removing a listener from the OperationEvent.PROGRESS event.
| IProgressOperation | ||
|
removeTimeoutListener(listener:Function, useCapture:Boolean = false):void
Convenience method for removing a listener from the OperationEvent.TIMEOUT event.
| IOperation | |
| Event | Summary | Defined by | ||
|---|---|---|---|---|
|
Dispatched when the current IOperation completed successfully. | IOperation | ||
|
Dispatched when the current IOperation encountered an error. | IOperation | ||
Dispatched after the current IProgressOperation received a progress update. | IProgressOperation | |||
|
Dispatched when the current IOperation timed out. | IOperation | ||
| progress | property |
Hide Inherited Public Properties
Show Inherited Public Propertiesprogress:uint [read-only]The progress of this operation.
Implementation public function get progress():uint
| total | property |
total:uint [read-only]The total amount of progress this operation should make before being done.
Implementation public function get total():uint
| addProgressListener | () | method |
public function addProgressListener(listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):voidConvenience method for adding a listener to the OperationEvent.PROGRESS event.
Parameterslistener:Function — the event handler function
|
|
useCapture:Boolean (default = false) |
|
priority:int (default = 0) |
|
useWeakReference:Boolean (default = false) |
| removeProgressListener | () | method |
public function removeProgressListener(listener:Function, useCapture:Boolean = false):voidConvenience method for removing a listener from the OperationEvent.PROGRESS event.
Parameterslistener:Function — the event handler function
|
|
useCapture:Boolean (default = false) |
| operationProgress | event |
org.springextensions.actionscript.core.operation.OperationEvent
Dispatched after the current IProgressOperation received a progress update.