76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * Functionality to make the node a delegated event container
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @module node
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @submodule node-event-delegate
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * <p>Sets up a delegation listener for an event occurring inside the Node.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * The delegated event will be verified against a supplied selector or
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * filtering function to test if the event references at least one node that
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * should trigger the subscription callback.</p>
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * <p>Selector string filters will trigger the callback if the event originated
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * from a node that matches it or is contained in a node that matches it.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * Function filters are called for each Node up the parent axis to the
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * subscribing container node, and receive at each level the Node and the event
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * object. The function should return true (or a truthy value) if that Node
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * should trigger the subscription callback. Note, it is possible for filters
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * to match multiple Nodes for a single event. In this case, the delegate
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * callback will be executed for each matching Node.</p>
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * <p>For each matching Node, the callback will be executed with its 'this'
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * object set to the Node matched by the filter (unless a specific context was
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * provided during subscription), and the provided event's
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * <code>currentTarget</code> will also be set to the matching Node. The
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * containing Node from which the subscription was originally made can be
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * referenced as <code>e.container</code>.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @method delegate
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @param type {String} the event type to delegate
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @param fn {Function} the callback function to execute. This function
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * will be provided the event object for the delegated event.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @param spec {String|Function} a selector that must match the target of the
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * event or a function to test target and its parents for a match
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @param context {Object} optional argument that specifies what 'this' refers to.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @param args* {any} 0..n additional arguments to pass on to the callback function.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * These arguments will be added after the event object.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @return {EventHandle} the detach handle
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass index = (Y.Lang.isObject(type) && !Y.Lang.isArray(type)) ? 1 : 2;
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass}, '@VERSION@' ,{requires:['node-base', 'event-delegate']});