Class com.sekati.events.Broadcaster

Implemented Interfaces

IBroadcastable

Description

Singleton Broadcaster with bulk subscribe/unsubscribe & the ability to pass arguments through broadcast events.

 Usage:
 var bc:Broadcaster = Broadcaster.getInstance ();
 bc.subscribe (fooMc);
 bc.broadcast ("onChangeAlpha", 50);
 

See Also

Field Index

$

Method Index

addListener(), broadcast(), destroy(), getInstance(), removeListener(), reset(), subscribe(), unsubscribe()

Inherited from CoreObject

Field Detail

$

static public $:Broadcaster [Read Only]
shorthand singleton accessor getter

Method Detail

getInstance

static public function getInstance():Broadcaster

Singleton Accessor

Return

Broadcaster

subscribe

public function subscribe(o:Object):Void

subscribe an object or array of objects as listeners to the Broadcaster. Note: movieclips will automatically unsubscribe onUnload

Parameters

o(Object) Object or Array of Object to subscribe

Return

Void

 Usage:
 Broadcaster.getInstance().subscribe( [fooMc, barMc] );
 

Specified By

subscribe() in com.sekati.events.IBroadcastable

unsubscribe

public function unsubscribe(o:Object):Void

unsubscribe an object or array of objects from Broadcaster

Parameters

o(Object) Object or Array of Object to unsubscribe

Return

Void

 Usage:
 Broadcaster.getInstance().unsubscribe( [fooMc, barMc] );
 

Specified By

unsubscribe() in com.sekati.events.IBroadcastable

reset

public function reset():Void

Clear all listeners and reset the broadcaster.

Return

Void

Specified By

reset() in com.sekati.events.IBroadcastable

broadcast

public function broadcast():Void

Broadcast event message to all subscribed listeners

Parameters

Return

Void

Specified By

broadcast() in com.sekati.events.IBroadcastable

addListener

public function addListener(o:Object):Number

add listener to broadcaster

Parameters

o(Object)

Return

Number

Specified By

addListener() in com.sekati.events.IBroadcastable

removeListener

public function removeListener(o:Object):Boolean

remove listener from broadcaster

Parameters

o(Object)

Return

Boolean

Specified By

removeListener() in com.sekati.events.IBroadcastable

destroy

public function destroy():Void

Destroy singleton instance.

Return

Void

Specified By

destroy() in com.sekati.core.CoreInterface

Overrides

destroy() in com.sekati.core.CoreObject