Class IWEventManager

A class used to register, trigger and remove events on both DOM and Javascript objects. Uses the singleton design pattern. To enforce one single instance we use an anonymous constructor.

IWEventManager

IWEventManager()

addCustomListener

IWEventListener addCustomListener(obj, eventName, eventHandler)

Registers a handler for the given custom event name and object.

Parameters:
Object obj - the object firing the event
String eventName - the name of the event
Function eventHandler - the listener function to register

Returns:
IWEventListener the listener object which can be used to remove the handler

addDomListener

IWEventListener addDomListener(obj, eventName, eventHandler)

Registers a handler for the given DOM event name and object. If possible the W3C or Microsoft syntax for attaching events will be used, otherwise an IW event handler is registered.

Parameters:
Object obj - the object firing the event
String eventName - the name of the event
Function eventHandler - the listener function to register

Returns:
IWEventListener the listener object which can be used to remove the handler

addListener

IWEventListener addListener(obj, eventName, eventHandler)

Registers a handler for the given event name and object.

This method is deprecated, use addDomListener in case of a DOM event or addCustomListener otherwise.

Parameters:
Object obj - the object firing the event
String eventName - the name of the event
Function eventHandler - the listener function to register

Returns:
IWEventListener the listener object which can be used to remove the handler

bind

IWEventListener bind(obj, eventName, listenerObj, eventHandler)

Registers a method from an object as handler for events of the specified type from another object.

Parameters:
Object obj - the object firing the event
String eventName - the name of the event
Object listenerObj - the object listening to the event
Function eventHandler - the listener function to register

Returns:
IWEventListener 

clearInstanceListeners

void clearInstanceListeners(obj)

Removes all registered handlers for the given object.

Parameters:
Object obj

Returns:
void 

clearListeners

void clearListeners(obj, eventName)

Removes all handlers for the specified event type and object.

Parameters:
Object obj - an object with registered events
String eventName - the name of the event to unregister

Returns:
void 

removeListener

void removeListener(eventListener)

Removes the handler determined by the specified reference.

Parameters:
IWEventListener eventListener - the event listener to remove

Returns:
void 

trigger

void trigger(object, eventName, event)

Triggers the event on the given object.

Parameters:
Object object - the object triggering this event
String eventName - the name of this event
Object event - the event object

Returns:
void