User Guide

ProgressBar component 611
Event object
In addition to the standard event object properties, there are two additional properties defined
for the
ProgressBar.complete event: current (the loaded value equals total), and total (the
total value
).
Description
Event; broadcast to all registered listeners when the loading progress has completed.
The first usage example uses an
on() handler and must be attached directly to a ProgressBar
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 instance
pBar, sends
“_level0.pBar” to the Output panel:
on(complete){
trace(this);
}
The second usage example uses a dispatcher/listener event model. A component instance (pBar)
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” on page 415.
Example
This example creates a form listener object with a complete callback function that sends a
message to the Output panel with the value of the
pBar instance:
form.complete = function(eventObj){
// eventObj.target is the component that generated the complete event,
// i.e., the progress bar.
trace("Current ProgressBar value = " + eventObj.target.value);
}
pBar.addEventListener("complete", form);
See also
EventDispatcher.addEventListener()