ProgressEvent  - AS3

The number of items or bytes loaded when the listener processes the event.

The total number of items or bytes that will be loaded if the loading process succeeds. If the progress event is dispatched/attached to a Socket object, the bytesTotal will always be 0 unless a value is specified in the bytesTotal parameter of the constructor. The actual number of bytes sent back or forth is not set and is up to the application developer.

Creates an Event object that contains information about progress events. Event objects are passed as parameters to event listeners.

Creates a copy of the ProgressEvent object and sets each property's value to match that of the original.

Returns a string that contains all the properties of the ProgressEvent object. The string is in the following format:

[ProgressEvent type=value bubbles=value cancelable=value bytesLoaded=value bytesTotal=value]

Defines the value of the type property of a progress event object.

This event has the following properties:

Related API Elements

Defines the value of the type property of a socketData event object.

This event has the following properties:

Related API Elements

Defines the value of the type property of a standardErrorData event object.

This event has the following properties:

Related API Elements

Defines the value of the type property of a standardInputProgress event object.

This event has the following properties:

Related API Elements

Defines the value of the type property of a standardOutputData event object.

This event has the following properties:

Related API Elements

1. The properties downloadURL and fileName are created, which indicate the location and name of the download file.
2. In the ProgressEventExample constructor, a new FileReference object named file is created and then passed to the configureListeners() method.
3. The downloadURL and fileName properties are then passed to file.download(), which prompts for the location to download the file.
4. The configureListeners() method adds seven event listeners and their associated subscriber methods:
   1. cancel/cancelHandler() is dispatched if the file download is canceled.
   2. complete/complereHandler() is dispatched when the file download process is finished.
   3. ioError/ioErrorHandler() is dispatched if the download file is unavailable or inaccessible.
   4. open/openHandler() is dispatched when the download operation has started.
   5. progress/progressHandler() is dispatched when the download process begins and again when it ends.
   6. securityError/securityErrorHandler is dispatched if the local playback security setting does not match the type of data access for the download file (local versus network); see the notes below.
   7. select/selectHandler() is dispatched when the download object is selected.

Notes:

• You need to compile the SWF file with Local Playback Security set to Access Network Files Only.
• This example requires a file named SomeFile.pdf.
• Although this example makes use of all events available to the FileReference object, most situations require only a subset.

package {
    import flash.display.Sprite;
    import flash.events.*;
    import flash.net.FileReference;
    import flash.net.URLRequest;

    public class ProgressEventExample extends Sprite {
        private var downloadURL:String = "http://www.[yourDomain].com/SomeFile.pdf";
        private var fileName:String = "SomeFile.pdf";
        private var file:FileReference;

        public function ProgressEventExample() {
            var request:URLRequest = new URLRequest(downloadURL);
            file = new FileReference();
            configureListeners(file);
            file.download(request, fileName);
        }

        private function configureListeners(dispatcher:IEventDispatcher):void {
            dispatcher.addEventListener(Event.CANCEL, cancelHandler);
            dispatcher.addEventListener(Event.COMPLETE, completeHandler);
            dispatcher.addEventListener(IOErrorEvent.IO_ERROR, ioErrorHandler);
            dispatcher.addEventListener(Event.OPEN, openHandler);
            dispatcher.addEventListener(ProgressEvent.PROGRESS, progressHandler);
            dispatcher.addEventListener(SecurityErrorEvent.SECURITY_ERROR, securityErrorHandler);
            dispatcher.addEventListener(Event.SELECT, selectHandler);
        }

        private function cancelHandler(event:Event):void {
            trace("cancelHandler: " + event);
        }

        private function completeHandler(event:Event):void {
            trace("completeHandler: " + event);
        }

        private function ioErrorHandler(event:IOErrorEvent):void {
            trace("ioErrorHandler: " + event);
        }

        private function openHandler(event:Event):void {
            trace("openHandler: " + event);
        }

        private function progressHandler(event:ProgressEvent):void {
            var file:FileReference = FileReference(event.target);
            trace("progressHandler: name=" + file.name + " bytesLoaded=" + event.bytesLoaded + " bytesTotal=" + event.bytesTotal);
        }

        private function securityErrorHandler(event:SecurityErrorEvent):void {
            trace("securityErrorHandler: " + event);
        }

        private function selectHandler(event:Event):void {
            var file:FileReference = FileReference(event.target);
            trace("selectHandler: name=" + file.name + " URL=" + downloadURL);
        }
    }
}