ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
com.adobe.gravity.service.progress 

IProgressTracker  - AS3 ADEP Client Component

Packagecom.adobe.gravity.service.progress
Interfacepublic interface IProgressTracker

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10
Runtime Versions: AIR 1.1, Flash Player 9

A service for receiving progress events for asynchronous operations. Implement this service to receive progress events for asynchronous operations.



Public Methods
 MethodDefined By
  
Called when an asynchronous operation ends.
IProgressTracker
  
progress(operation:IProgressOperation, current:Number, total:Number, description:String = null):void
Called to indicate progress on the operation.
IProgressTracker
  
Called when an asynchronous operation starts.
IProgressTracker
Method Detail

end

()method
public function end(operation:IProgressOperation):void

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10
Runtime Versions: AIR 1.1, Flash Player 9

Called when an asynchronous operation ends.

Parameters

operation:IProgressOperation — The operation object.

progress

()method 
public function progress(operation:IProgressOperation, current:Number, total:Number, description:String = null):void

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10
Runtime Versions: AIR 1.1, Flash Player 9

Called to indicate progress on the operation.

Parameters

operation:IProgressOperation — The operation object.
 
current:Number — A string describing the current progress to potentially be displayed to an end-user. Can be null.
 
total:Number — The current progress; for example, if loading a file, this might be the number of bytes loaded so far.
 
description:String (default = null) — The maximum value; for example, if loading a file, this might be the total number of bytes in the file.

start

()method 
public function start(operation:IProgressOperation):void

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10
Runtime Versions: AIR 1.1, Flash Player 9

Called when an asynchronous operation starts.

Parameters

operation:IProgressOperation — The operation object.