Namespace: event

Classes

HandleManager

Members

<static> DEFAULT_EVENT_TYPE

DOM3 event types. ('abort', 'error', 'load', 'unload', 'select', 'focus', 'blur', 'focusin', 'focusout', 'resize', 'scroll', 'click', 'dblclick', 'mousedown', 'mousemove', 'mouseout', 'mouseup', 'mouseover', 'mousewheel', 'mouseenter', 'mouseleave', 'wheel', 'beforeinput', 'input', 'keydown', 'keyup')

Since:

• 2.0.0

Methods

<static> add(element, type, listener, capture, filter) → {Array.<EventHandle>|EventHandle|caph.dom.Element}

Adds a handler to an event for the elements.

Parameters:

Name	Type	Argument	Description
element	HTMLCollection | NodeList | Array.<HTMLElement> | HTMLElement | caph.dom.Element		A HTMLCollection or a NodeList or an array of HTMLElement or a HTMLElement or a caph.dom.Element object to add a handler.
type	String		A string containing a DOM event types, such as 'click' or 'submit,' or custom event names.
listener	function		A function to execute each time the event is triggered.
capture	Boolean	<optional>	Indicates that the user wishes to initiate capture.
filter	function	<optional>	A function to filter the elements that trigger the event.

Since:

• 2.0.0

Returns:

An array of event handle or an event handle or a caph.dom.Element object.

EventHandle Details

{HTMLElement[]|HTMLElement|caph.dom.Element} element	An array of elements or an element which handle the occurred event.
{String} type	The target DOM event type
{Function} listener	A function to execute when the designated event is occurred.
{Boolean} capture	A boolean indicating whether the user wishes to initiate capture or not.

Type

Array.<EventHandle> | EventHandle | caph.dom.Element

Example

var handle1 = caph.dom.event.add(document.getElementById('id1'), 'click', function(event) {
     console.log('click');
 });
 
 var handle2 = caph.dom.event.add(document.getElementById('id2'), 'click', function(event) {
     console.log('click');
 }, function(target) {
     return target.nodeName === 'DIV';
 });

<static> fire(element, type, prop)

Executes all handlers attached to the elements for the given event type.

Parameters:

Name	Type	Argument	Description
element	HTMLCollection | NodeList | Array.<HTMLElement> | HTMLElement | caph.dom.Element		A HTMLCollection or a NodeList or an array of HTMLElement or a HTMLElement or a caph.dom.Element object which receives an event.
type	String		A string containing a DOM event types, such as 'click' or 'submit,' or custom event names.
prop	Object	<optional>	Additional parameters to pass along to the event handler.

Since:

• 2.0.0

Example

var element = document.getElementById('id');
 
 caph.dom.event.add(element, 'click', function(event) {
     console.log('click');
 });
 
 caph.dom.event.fire(element, 'click');
 caph.dom.event.fire(element, 'click', {
     offsetX: 10,
     offsetY: 20
 });

<static> remove(handle)

Removes attached event handler.

Parameters:

Name	Type	Description
handle	Array.<EventHandle> | EventHandle | caph.dom.Element	An array of event handle or an event handle or a caph.dom.Element object to remove.

Since:

• 2.0.0

Example

var handle = caph.dom.event.add(document.getElementById('id'), 'click', function(event) {
     console.log('click');
 });
 
 caph.dom.event.remove(handle);
 
 var element = new caph.dom.Element(document.getElementById('id'));
 
 element.bind('click', function(event) {
     console.log('click!');
 });
 
 caph.dom.event.remove(element);