ActionScript 2.0 Components Language Reference
Loader component > Loader.complete

Loader.complete

Availability

Flash Player 6 (6.0.79.0).

Edition

Flash MX 2004.

Usage

Usage 1:

var listenerObject:Object = new Object();
listenerObject.complete = function(eventObj:Object){
    // ...
};
loaderInstance.addEventListener("complete", listenerObject);

Usage 2:

on (complete) {
    // ...
}

Description

Event; broadcast to all registered listeners when the content finishes loading.

The first usage example uses a dispatcher/listener event model. A component instance (loaderInstance) dispatches an event (in this case, complete) and the event is handled by a function, also called a handler, on a listener object (listenerObject) that you create. You define a method with the same name as the event on the listener object; the method is called when the event is triggered. When the event is triggered, it automatically passes an event object (eventObject) to the listener object method. Each event object has properties that contain information about the event. You can use these properties to write code that handles the event. Finally, you call the EventDispatcher.addEventListener() method on the component instance that broadcasts the event to register the listener with the instance. When the instance dispatches the event, the listener is called.

For more information, see EventDispatcher class.

The second usage example uses an on() handler and must be attached directly to a Loader instance. The keyword this, used inside an on() handler attached to a component, refers to the component instance. For example, the following code, attached to the Loader instance myLoaderComponent, sends "_level0.myLoaderComponent" to the Output panel:

on (complete) {
    trace(this);
}

Example

The following example creates a Loader component, my_ldr, and then defines a listener object for a complete event. The example loads an image from a web page; when loading is complete, the listener displays a message in the Output panel.

Drag a Loader component to the library, then add the following code to the first frame of the timeline.

/**
 Requires:
  - Loader component in Library.
*/

System.security.allowDomain("http://www.flash-mx.com");

//Create loader instance.
this.createClassObject(mx.controls.Loader, "my_ldr", 10);

//Create listener object.
var loaderListener:Object = new Object();
loaderListener.complete = function(evt_obj:Object){
   trace("loading complete");
}

//Add listener.
my_ldr.addEventListener("complete", loaderListener);
my_ldr.load("http://www.flash-mx.com/images/image2.jpg");

View comments on LiveDocs