ActionScript 2.0 Components Language Reference
ScrollPane component > ScrollPane.complete

ScrollPane.complete

Availability

Flash Player 6 (6.0.79.0).

Edition

Flash MX 2004.

Usage

Usage 1:

var listenerObject:Object = new Object();
listenerObject.complete = function(eventObject:Object) {
    // ...
};
scrollPaneInstance.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 (scrollPaneInstance) 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 ScrollPane 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 ScrollPane instance myScrollPaneComponent, sends "_level0.myScrollPaneComponent" to the Output panel:

on (complete) {
    trace(this);
}

Example

The following example creates a listener object with a complete event handler for the scrollPane instance. When the scroll pane's content is loaded, the listener displays a message in the Output panel.

You first drag the ScrollPane component from the Components panel to the library and then add the following code to Frame 1:

/**
 Requires:
  - ScrollPane in library
*/

System.security.allowDomain("http://www.helpexamples.com");

this.createClassObject(mx.containers.ScrollPane, "my_sp", 10);
my_sp.setSize(320, 240);

// Create listener object for completed loading.
var completeListener:Object = new Object();
completeListener.complete = function(evt_obj:Object) {
 trace(evt_obj.target.contentPath + " has completed loading.");
};
// Add listener.
my_sp.addEventListener("complete", completeListener);

my_sp.contentPath = "http://www.helpexamples.com/flash/images/image1.jpg";

View comments on LiveDocs