Packageorg.springextensions.actionscript.core.operation
SVN browsingAbstractProgressOperation.as
FisheyeAbstractProgressOperation.as
Classpublic class AbstractProgressOperation
InheritanceAbstractProgressOperation Inheritance AbstractOperation Inheritance flash.events.EventDispatcher
ImplementsIProgressOperation
SubclassesCompositeCommand, GenericOperationCommand, LoadModuleOperation, LoadResourceModuleOperation, LoadStyleModuleOperation, LoadURLOperation, LoadURLStreamOperation, OperationQueue

Abstract base class for IProgressOperation implementations.


Documentation reference: operations

Public Properties
 PropertyDefined by
 Inheritederror : *
The error of this operation or null if no error occurred during this operation.
AbstractOperation
  progress : uint
The progress of this operation.
AbstractProgressOperation
 Inheritedresult : *
The result of this operation or null if the operation does not have a result.
AbstractOperation
 Inheritedtimeout : int
The timeout in milliseconds.
AbstractOperation
  total : uint
The total amount of progress this operation should make before being done.
AbstractProgressOperation
Public Methods
 MethodDefined by
  
AbstractProgressOperation(timeoutInMilliseconds:uint = 0, autoStartTimeout:Boolean = true)
Creates a new AbstractProgressOperation instance.
AbstractProgressOperation
 Inherited
addCompleteListener(listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Convenience method for adding a listener to the OperationEvent.COMPLETE event.
AbstractOperation
 Inherited
addErrorListener(listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Convenience method for adding a listener to the OperationEvent.ERROR event.
AbstractOperation
  
addProgressListener(listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Convenience method for adding a listener to the OperationEvent.PROGRESS event.
AbstractProgressOperation
 Inherited
addTimeoutListener(listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Convenience method for adding a listener to the OperationEvent.TIMEOUT event.
AbstractOperation
 Inherited
dispatchCompleteEvent(result:* = null):Boolean
Convenience method for dispatching a OperationEvent.COMPLETE event.
AbstractOperation
 Inherited
dispatchErrorEvent(error:* = null):Boolean
Convenience method for dispatching a OperationEvent.ERROR event.
AbstractOperation
 Inherited
dispatchTimeoutEvent():Boolean
Convenience method for dispatching a OperationEvent.TIMEOUT event.
AbstractOperation
 Inherited
removeCompleteListener(listener:Function, useCapture:Boolean = false):void
Convenience method for removing a listener from the OperationEvent.COMPLETE event.
AbstractOperation
 Inherited
removeErrorListener(listener:Function, useCapture:Boolean = false):void
Convenience method for removing a listener from the OperationEvent.ERROR event.
AbstractOperation
  
removeProgressListener(listener:Function, useCapture:Boolean = false):void
Convenience method for removing a listener from the OperationEvent.PROGRESS event.
AbstractProgressOperation
 Inherited
removeTimeoutListener(listener:Function, useCapture:Boolean = false):void
Convenience method for removing a listener from the OperationEvent.TIMEOUT event.
AbstractOperation
Protected Methods
 MethodDefined by
  
dispatchProgressEvent():void
Convenience method for dispatching a OperationEvent.PROGRESS event.
AbstractProgressOperation
 Inherited
startTimeout():void
AbstractOperation
Events
 EventSummaryDefined by
  
operationComplete
Dispatched when the current AbstractOperation has new progress information to report.AbstractProgressOperation
 Inherited
operationComplete
Dispatched when the current AbstractOperation has completed its functionality successfully.AbstractOperation
 Inherited
operationError
Dispatched when the current AbstractOperation encountered an error.AbstractOperation
 Inherited
operationTimeout
Dispatched when the current AbstractOperation timed out.AbstractOperation
Property detail
progressproperty
progress:uint  [read-write]

The progress of this operation.

Implementation
    public function get progress():uint
    public function set progress(value:uint):void
totalproperty 
total:uint  [read-write]

The total amount of progress this operation should make before being done.

Implementation
    public function get total():uint
    public function set total(value:uint):void
Constructor detail
AbstractProgressOperation()constructor
public function AbstractProgressOperation(timeoutInMilliseconds:uint = 0, autoStartTimeout:Boolean = true)

Creates a new AbstractProgressOperation instance.

Parameters
timeoutInMilliseconds:uint (default = 0)
 
autoStartTimeout:Boolean (default = true)
Method detail
addProgressListener()method
public function addProgressListener(listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void

Convenience method for adding a listener to the OperationEvent.PROGRESS event.

Parameters
listener:Function — the event handler function
 
useCapture:Boolean (default = false)
 
priority:int (default = 0)
 
useWeakReference:Boolean (default = false)
dispatchProgressEvent()method 
protected function dispatchProgressEvent():void

Convenience method for dispatching a OperationEvent.PROGRESS event.

removeProgressListener()method 
public function removeProgressListener(listener:Function, useCapture:Boolean = false):void

Convenience method for removing a listener from the OperationEvent.PROGRESS event.

Parameters
listener:Function — the event handler function
 
useCapture:Boolean (default = false)
Event detail
operationCompleteevent 
Event object type: org.springextensions.actionscript.core.operation.OperationEvent

Dispatched when the current AbstractOperation has new progress information to report.




Copyright 2007-2010 Spring Actionscript.