DispatchableInterface

Kind of class:interface
Inherits from:CoreInterface
Implemented by:
Version:02/06/07
Author:Aaron Clinger
Classpath:org.casaframework.event.DispatchableInterface
File last modified:Wednesday, 07 March 2007, 14:18:33
Event interface which all objects that use EventDispatcher should adhere to.

Instance methods

addEventObserver

function addEventObserver (
scope:Object, eventName:String, eventHandler:String) : Boolean
Registers a function to receive notification when a event handler is invoked.
Parameters:
scope :
The target or object in which to subscribe.
eventName :
Event name to subscribe to.
eventHandler:
[optional] Name of function to recieve the event. If undefined class assumes eventHandler matches eventName.
Returns:
Returns true if the observer was established successfully; otherwise false.

dispatchEvent

function dispatchEvent (
eventName:String) : Boolean
Reports event to all subscribed objects.
Parameters:
eventName:
Event name.
param(s) :
[optional] Parameters passed to the function specified by "eventName". Multiple parameters are allowed and should be separated by commas: param1,param2, ...,paramN
Returns:
Returns true if observer(s) listening to specifed event were found; otherwise false.

removeAllEventObservers

function removeAllEventObservers (
) : Boolean
Removes all observers regardless of scope or event.
Returns:
Returns true if observers were successfully removed; otherwise false.

removeEventObserver

function removeEventObserver (
scope:Object, eventName:String, eventHandler:String) : Boolean
Removes specific observer for event.
Parameters:
scope :
The target or object in which subscribed.
eventName :
Event name to unsubscribe to.
eventHandler:
[optional] Name of function that recieved the event. If undefined class assumes eventHandler matched eventName.
Returns:
Returns true if the observer was successfully found and removed; otherwise false.

removeEventObserversForEvent

function removeEventObserversForEvent (
eventName:String) : Boolean
Removes all observers for a specified event.
Parameters:
eventName:
Event name to unsubscribe to.
Returns:
Returns true if observers were successfully found for specified eventName and removed; otherwise false.

removeEventObserversForScope

function removeEventObserversForScope (
scope:Object) : Boolean
Removes all observers in a specified scope.
Parameters:
scope:
The target or object in which to unsubscribe.
Returns:
Returns true if observers were successfully found in scope and removed; otherwise false.