Packagesystem.broadcasters
Interfacepublic interface Broadcaster
Implementors CoreBroadcaster, InternalBroadcaster

This class provides a basic broadcaster interface based "Observer" event model (like ASBroadcaster in AS1).



Public Properties
 PropertyDefined By
  length : uint
[read-only] Indicates the number of listeners registered in the Broadcaster object.
Broadcaster
Public Methods
 MethodDefined By
  
addListener(listener:*, priority:uint = 0, autoRemove:Boolean = false):Boolean
Registers an object to receive messages.
Broadcaster
  
broadcastMessage(message:String, ... rest):*
Broadcast the specified message.
Broadcaster
  
hasListener(listener:*):Boolean
Returns true if this broadcaster contains the specified listener.
Broadcaster
  
isEmpty():Boolean
Returns true if the set of listeners is empty.
Broadcaster
  
removeListener(listener:* = null):Boolean
Removes the specified listener or all listeners if the parameter is null.
Broadcaster
Property Detail
lengthproperty
length:uint  [read-only]

Indicates the number of listeners registered in the Broadcaster object.


Implementation
    public function get length():uint
Method Detail
addListener()method
public function addListener(listener:*, priority:uint = 0, autoRemove:Boolean = false):Boolean

Registers an object to receive messages.

Parameters

listener:* — The listener to register.
 
priority:uint (default = 0) — Determinates the priority level of the listener.
 
autoRemove:Boolean (default = false) — Apply a removeListener after the first trigger

Returns
Booleantrue If the listener is register in the broadcaster.
broadcastMessage()method 
public function broadcastMessage(message:String, ... rest):*

Broadcast the specified message.

Parameters

message:String
 
... rest

Returns
*
hasListener()method 
public function hasListener(listener:*):Boolean

Returns true if this broadcaster contains the specified listener.

Parameters

listener:*

Returns
Booleantrue if this broadcaster contains the specified listener.
isEmpty()method 
public function isEmpty():Boolean

Returns true if the set of listeners is empty.

Returns
Booleantrue if the set of listeners is empty.
removeListener()method 
public function removeListener(listener:* = null):Boolean

Removes the specified listener or all listeners if the parameter is null.

Parameters

listener:* (default = null)

Returns
Booleantrue if the specified listener exist and can be removed.