ensemble.Event

ensemble

• ensemble
  • ~Event
    • new Event(ns, name, node)
    • instance
      • ._Symbol.toStringTag ⇒ string
      • .add(handle, options)
      • .remove(handle)
    • static
      • .isEvent() ⇒ boolean

ensemble~Event

Event is an event manager.

It is a wrapper around the native Event [DOM].

Kind: inner class of ensemble
See

• Element.addEventListener()
• Element.removeElementListener()

• ~Event
  • new Event(ns, name, node)
  • instance
    • ._Symbol.toStringTag ⇒ string
    • .add(handle, options)
    • .remove(handle)
  • static
    • .isEvent() ⇒ boolean

new Event(ns, name, node)

Constructor method.

Param	Type	Description
ns	string	Event namespace
name	string	The [DOM] Event type name
node	Element	A valid Element node -or- component

Example

new ensemble.Event('namespace-of-my-foo-component', 'mousewheel', node).add(func, { capture: true });

event._Symbol.toStringTag ⇒ string

Getter for Symbol property, returns the symbolic name for ensemble.Event class.

Kind: instance property of Event
See: Symbol.toStringTag
Todo

• return undef
• backward compatibility

event.add(handle, options)

Adds an event for this composition.

Kind: instance method of Event
See: Element.addEventListener()

Param	Type	Default	Description
handle	function		The function handler
options	mixed	false	An options Object -or- useCapture boolean

event.remove(handle)

Removes an event from this composition.

Kind: instance method of Event
See: Element.removeElementListener()
Todo

• ? removes handle ref.

Param	Type	Description
handle	function	The function handler

Event.isEvent() ⇒ boolean

Check if passed object is an ensemble.Event instance.

Kind: static method of Event
Todo

• backward compatibility