ProgressBar.progress

Availability

Flash Player 6.0.79.

Edition

Flash MX 2004.

Usage

Usage 1:

on(progress){
  ...
}

Usage 2:

listenerObject = new Object();
listenerObject.progress = function(eventObject){
  ...
}
pBarInstance.addEventListener("progress", listenerObject)

Event Object

In addition to the standard event object properties, there are two additional properties defined for the ProgressBar.progress event: current (the loaded value equals total), and total (the total value).

Description

Event; broadcast to all registered listeners whenever the value of a progress bar changes. This event is only broadcast when ProgressBar.mode is set to "manual" or "polled".

The first usage example uses an on() handler and must be attached directly to a ProgressBar component 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 myPBar, sends "_level0.myPBar" to the Output panel:

on(progress){
  trace(this);
}

The second usage example uses a dispatcher/listener event model. A component instance (pBarInstance) dispatches an event (in this case, progress) and the event is handled by a function attached to 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 a set of properties that contains information about the event. You can use these properties to write code that handles the event. Finally, you call the UIEventDispatcher.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 about event objects, see Event Objects.

Example

This example creates a listener object, form, and defines a progress event handler on it. The form listener is registered to the pBar instance in the last line of code. When the progress event is triggered, pBar broadcasts the event to the form listener which calls the progress callback function, as follows:

var form:Object = new Object();
form.progress = function(eventObj){
  // eventObj.target is the component which generated the change event,
  // i.e., the Progress Bar.
  trace("Value changed to " + eventObj.target.value);
}
pBar.addEventListener("progress", form);

See also

UIEventDispatcher.addEventListener()