ActionScript 2.0 Language Reference

AsBroadcaster

Object
    |
    +-AsBroadcaster

public class AsBroadcaster
extends Object

Provides event notification and listener management capabilities that you can add to user-defined objects. This class is intended for advanced users who want to create custom event handling mechanisms. You can use this class to make any object an event broadcaster and to create one or more listener objects that receive notification anytime the broadcasting object calls the broadcastMessage() method.

There is no constructor function for the AsBroadcaster class. To use this class, follow this process:

Select or create an object to serve as the event broadcaster.
Make the object an event broadcaster by calling the static AsBroadcaster.initialize(obj:Object) method, where the obj parameter is the name of the object that you selected to be the broadcaster.
Select or create one or more listener objects. Listener objects receive notification whenever the broadcasting object broadcasts a message
Define a listener method for each of your listener objects. The listener method executes ActionScript code in response to the event notification. The name of the method must match the name of the event that is broadcasted by the broadcasting object.
Register each listener object with the event broadcaster by calling myBroadcaster.addListener(myListener), where myBroadcaster is the name of the event broadcaster object and myListener is the name of the listener object. Each event broadcaster stores a list of listener objects to be notified when a message is broadcast. Use the addListener() method to add listeners to the list, and use removeListener() to remove listeners from the list.
Finally, to broadcast a message, call the myBroadcaster.broadcastMessage(eventName:String) method, where myBroadcaster is the name of the event broadcaster and eventName is the name of the event that matches the name of the listener method.

Note: A common mistake is to capitalize the second letter of AsBroadcaster. When calling the AsBroadcaster.initialize() method, ensure that the second letter is lowercase. Any misspelling of AsBroadcaster fails silently.

Availability: ActionScript 1.0; Flash Player 6

Property summary

Modifiers	Property	Description
	_listeners`:`Array [read-only]	A list of references to all registered listener objects.

Properties inherited from class Object

constructor (Object.constructor property), __proto__ (Object.__proto__ property), prototype (Object.prototype property), __resolve (Object.__resolve property)

Method summary

Modifiers	Signature	Description
	addListener`(listenerObj:`Object`) :` Boolean	Registers an object to receive event notification messages.
	broadcastMessage`(eventName:`String`) : Void`	Sends an event message to each object in the list of listeners.
`static`	initialize`(obj:`Object`) : Void`	Adds event notification and listener management functionality to a given object.
	removeListener`(listenerObj:`Object`) :` Boolean	Removes an object from the list of objects that receive event notification messages.

Methods inherited from class Object

addProperty (Object.addProperty method), hasOwnProperty (Object.hasOwnProperty method), isPropertyEnumerable (Object.isPropertyEnumerable method), isPrototypeOf (Object.isPrototypeOf method), registerClass (Object.registerClass method), toString (Object.toString method), unwatch (Object.unwatch method), valueOf (Object.valueOf method), watch (Object.watch method)

View comments on LiveDocs