Class Index | File Index

Classes


Namespace JXG.EventEmitter


Defined in: EventEmitter.js.

Namespace Summary
Constructor Attributes Constructor Name and Description
 
Field Summary
Field Attributes Field Name and Description
 
Holds the registered event handlers.
Method Summary
Method Attributes Method Name and Description
 
Implements the functionality from this interface in the given object.
 
off(event, handler)
Unregister an event handler.
 
on(event, handler, context)
Register a new event handler.
 
Triggers all event handlers of this element for a given event.
Namespace Detail
JXG.EventEmitter
Field Detail
{Object} eventHandlers
Holds the registered event handlers.
Method Detail
eventify(o)
Implements the functionality from this interface in the given object. All objects getting their event handling capabilities from this method should document it by adding the on, off, triggerEventHandlers via the borrows tag as methods to their documentation:
@borrows JXG.EventEmitter#on as this.on
Parameters:
{Object} o

off(event, handler)
Unregister an event handler.
Parameters:
{String} event
{Function} handler
Returns:
Reference to the object.

on(event, handler, context)
Register a new event handler. For a list of possible events see documentation of the elements and objects implementing the EventEmitter interface.
Parameters:
{String} event
{Function} handler
{Object} context Optional
The context the handler will be called in, default is the element itself.
Returns:
Reference to the object.

triggerEventHandlers(event)
Triggers all event handlers of this element for a given event.
Parameters:
{String} event
Returns:
Reference to the object.

Documentation generated by JsDoc Toolkit 2.4.0 on Thu May 30 2013 23:22:17 GMT+0200 (CEST)