| Player version: | Flash Player 9.0 |
| Language version: | ActionScript 3.0 |
The Broadcaster interface.
public function addEventListener(type:String, listener:Object, ... rest):Boolean
| Player version: | Flash Player 9.0 |
| Language version: | ActionScript 3.0 |
Adds an event listener for the specified event type.
There is two behaviors for the addEventListener
function :
- The passed-in listener is an object :
The object is added as listener only for the specified event, the object must
have a function with the same name than
type or at least a
handleEvent function.
- The passed-in listener is a function :
A
Delegate object is created and then
added as listener for the event type. There is no restriction on the name of
the function. If the rest is not empty, all elements in it is
used as additional arguments into the delegate object.
Parameters
| type:String — name of the event for which register the listener
|
| |
| listener:Object — object or function which will receive this event
|
| |
| ... rest — additional arguments for the function listener
|
Returns
| Boolean — true if the function have been succesfully added as
listener fot the passed-in event
|
Throws
| UnsupportedOperationException — If the listener is an object
which have neither a function with the same name than the event type nor
a function called handleEvent
|
public function addListener(listener:Object):Boolean
| Player version: | Flash Player 9.0 |
| Language version: | ActionScript 3.0 |
Adds the passed-in listener as listener for all events dispatched
by this event broadcaster. The function returns true
if the listener have been added at the end of the call. If the
listener is already registered in this event broadcaster the function
returns false.
Note : The addListener function doesn't accept functions
as listener, functions could only register for a single event.
Parameters
| listener:Object — the listener object to add as global listener
|
Returns
| Boolean — true if the listener have been added during this call
|
Throws
| IllegalArgumentException — If the passed-in listener
listener doesn't match the listener type supported by this event
broadcaster
|
| |
| IllegalArgumentException — If the passed-in listener
is a function
|
public function broadcastEvent(e:Event):void
| Player version: | Flash Player 9.0 |
| Language version: | ActionScript 3.0 |
Broadcast the passed-in event object to listeners
according to the event's type. The event is broadcasted
to both listeners registered specifically for this event
type and global listeners in the broadcaster.
If the target property of the passed-in event
is null, it will be set using the value of the
source property of this event broadcaster.
Parameters
| e:Event — event object to broadcast
|
Throws
| UnsupportedOperationException — If one listener is an object
which have neither a function with the same name than the event type nor
a function called handleEvent
|
public function hasListenerCollection(type:String):Boolean
| Player version: | Flash Player 9.0 |
| Language version: | ActionScript 3.0 |
Returns true if this event broadcaster has
listeners for the passed-in event type.
Parameters
| type:String — name of the event for which look for listener
|
Returns
| Boolean — true if this event broadcaster has
listeners for the passed-in event type
|
public function isRegistered(listener:Object, type:String = null):Boolean
| Player version: | Flash Player 9.0 |
| Language version: | ActionScript 3.0 |
Returns true if the passed-in listener object is registered
as listener for the passed-in event type. If the type parameter
is omitted, the function returns true only if the listener is
registered as global listener.
Note : the listener could be either an object or a function.
Parameters
| listener:Object — object to look for registration
|
| |
| type:String (default = null) |
Returns
| Boolean — true if the passed-in listener should receive notification
of the passed-in event type
|
public function removeAllListeners():void
| Player version: | Flash Player 9.0 |
| Language version: | ActionScript 3.0 |
Removes all listeners registered in this event broadcaster.
public function removeEventListener(type:String, listener:Object):Boolean
| Player version: | Flash Player 9.0 |
| Language version: | ActionScript 3.0 |
Removes the passed-in listener for listening the specified event. The
listener could be either an object or a function.
Parameters
| type:String — name of the event for which unregister the listener
|
| |
| listener:Object — object or function to be unregistered
|
Returns
| Boolean — true if the listener have been successfully removed
as listener for the passed-in event
|
public function removeListener(listener:Object):Boolean
| Player version: | Flash Player 9.0 |
| Language version: | ActionScript 3.0 |
Removes the passed-in listener object from this event
broadcaster. The object is removed as listener for all
events the broadcaster may dispatch.
Parameters
| listener:Object — the listener object to remove from
this event broadcaster object
|
Returns
| Boolean — true if the object have been successfully
removed from this event broadcaster
|
Throws
| IllegalArgumentException — If the passed-in listener
is a function
|
LowRA API documentation 2008- 2009
Licensed under the MOZILLA PUBLIC LICENSE, Version 1.1
mer. févr. 25 2009, 9:22 AM GMT+01:00
