event-debug.js revision f6baa527839e75655081768c365a749c59edc80d
fb84f9014321c5f33c4682de5661b579fcde318fAndreas Gustafsson/*
665a24faf6b3711e4012ac02ae5f0981c093ac1eTinderbox User * DOM event listener abstraction layer
75c0816e8295e180f4bc7f10db3d0d880383bc1cMark Andrews * @module event
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * @submodule event-base
4a14ce5ba00ab7bc55c99ffdcf59c7a4ab902721Automatic Updater */
fb84f9014321c5f33c4682de5661b579fcde318fAndreas Gustafsson
fb84f9014321c5f33c4682de5661b579fcde318fAndreas Gustafsson(function() {
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
af5073d03288a53b646ec3b807ac25ced64d7879Mark Andrews// Unlike most of the library, this code has to be executed as soon as it is
af5073d03288a53b646ec3b807ac25ced64d7879Mark Andrews// introduced into the page -- and it should only be executed one time
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein// regardless of the number of instances that use it.
af5073d03288a53b646ec3b807ac25ced64d7879Mark Andrews
af5073d03288a53b646ec3b807ac25ced64d7879Mark Andrewsvar stateChangeListener,
af5073d03288a53b646ec3b807ac25ced64d7879Mark Andrews GLOBAL_ENV = YUI.Env,
af5073d03288a53b646ec3b807ac25ced64d7879Mark Andrews config = YUI.config,
fb84f9014321c5f33c4682de5661b579fcde318fAndreas Gustafsson doc = config.doc,
ea94d370123a5892f6c47a97f21d1b28d44bb168Tinderbox User docElement = doc && doc.documentElement,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein doScrollCap = docElement && docElement.doScroll,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein add = YUI.Env.add,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein remove = YUI.Env.remove,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein targetEvent = (doScrollCap) ? 'onreadystatechange' : 'DOMContentLoaded',
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User pollInterval = config.pollInterval || 40,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein _ready = function(e) {
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User GLOBAL_ENV._ready();
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews };
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinif (!GLOBAL_ENV._ready) {
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein GLOBAL_ENV._ready = function() {
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein if (!GLOBAL_ENV.DOMReady) {
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein GLOBAL_ENV.DOMReady = true;
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein remove(doc, targetEvent, _ready); // remove DOMContentLoaded listener
1c09d68dfd18b6e839c8cd68b78c11b3ccca4160Automatic Updater }
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein };
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein/*! DOMReady: based on work by: Dean Edwards/John Resig/Matthias Miller/Diego Perini */
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User// Internet Explorer: use the doScroll() method on the root element. This isolates what
665a24faf6b3711e4012ac02ae5f0981c093ac1eTinderbox User// appears to be a safe moment to manipulate the DOM prior to when the document's readyState
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User// suggests it is safe to do so.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein if (doScrollCap) {
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein if (self !== self.top) {
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein stateChangeListener = function() {
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User if (doc.readyState == 'complete') {
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein remove(doc, targetEvent, stateChangeListener); // remove onreadystatechange listener
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein _ready();
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User }
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein };
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein add(doc, targetEvent, stateChangeListener); // add onreadystatechange listener
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User } else {
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein GLOBAL_ENV._dri = setInterval(function() {
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein try {
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein docElement.doScroll('left');
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein clearInterval(GLOBAL_ENV._dri);
d71e2e0c61df16ff37c9934c371a4a60c08974f7Mark Andrews GLOBAL_ENV._dri = null;
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User _ready();
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein } catch (domNotReady) { }
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein }, pollInterval);
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein }
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein } else { // FireFox, Opera, Safari 3+ provide an event for this moment.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein add(doc, targetEvent, _ready); // add DOMContentLoaded listener
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User }
03c0efc6892ef2ed17338b2ecbb2c5f23fbad0c9Tinderbox User}
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User
d8620c7234281056fdfd2ee40cf16636b8281092Tinderbox User})();
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinYUI.add('event-base', function(Y) {
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
b49958b502ee45022010a0b1bed3968f598895a4Automatic Updater(function() {
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User/*
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * DOM event listener abstraction layer
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * @module event
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User * @submodule event-base
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein */
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinvar GLOBAL_ENV = YUI.Env,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
b3cbb2f1ad021349e89807f3492df6e4e679cd56Mark Andrews yready = function() {
b3cbb2f1ad021349e89807f3492df6e4e679cd56Mark Andrews Y.fire('domready');
665a24faf6b3711e4012ac02ae5f0981c093ac1eTinderbox User };
b49958b502ee45022010a0b1bed3968f598895a4Automatic Updater
b49958b502ee45022010a0b1bed3968f598895a4Automatic Updater/**
b3cbb2f1ad021349e89807f3492df6e4e679cd56Mark Andrews * The domready event fires at the moment the browser's DOM is
b3cbb2f1ad021349e89807f3492df6e4e679cd56Mark Andrews * usable. In most cases, this is before images are fully
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * downloaded, allowing you to provide a more responsive user
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User * interface.
665a24faf6b3711e4012ac02ae5f0981c093ac1eTinderbox User *
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * In YUI 3, domready subscribers will be notified immediately if
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User * that moment has already passed when the subscription is created.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein *
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * One exception is if the yui.js file is dynamically injected into
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * the page. If this is done, you must tell the YUI instance that
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * you did this in order for DOMReady (and window load events) to
61e1dc26d62c2a0059e3ca7efe2ad0f4a5b8df92Mark Andrews * fire normally. That configuration option is 'injected' -- set
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * it to true if the yui.js script is not included inline.
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User *
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * This method is part of the 'event-ready' module, which is a
d8620c7234281056fdfd2ee40cf16636b8281092Tinderbox User * submodule of 'event'.
d8620c7234281056fdfd2ee40cf16636b8281092Tinderbox User *
d8620c7234281056fdfd2ee40cf16636b8281092Tinderbox User * @event domready
d8620c7234281056fdfd2ee40cf16636b8281092Tinderbox User * @for YUI
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein */
d8620c7234281056fdfd2ee40cf16636b8281092Tinderbox UserY.publish('domready', {
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User fireOnce: true,
d8620c7234281056fdfd2ee40cf16636b8281092Tinderbox User async: true
d8620c7234281056fdfd2ee40cf16636b8281092Tinderbox User});
d8620c7234281056fdfd2ee40cf16636b8281092Tinderbox User
d8620c7234281056fdfd2ee40cf16636b8281092Tinderbox Userif (GLOBAL_ENV.DOMReady) {
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User // console.log('DOMReady already fired', 'info', 'event');
d8620c7234281056fdfd2ee40cf16636b8281092Tinderbox User yready();
d8620c7234281056fdfd2ee40cf16636b8281092Tinderbox User} else {
d8620c7234281056fdfd2ee40cf16636b8281092Tinderbox User // console.log('setting up before listener', 'info', 'event');
d8620c7234281056fdfd2ee40cf16636b8281092Tinderbox User // console.log('env: ' + YUI.Env.windowLoaded, 'info', 'event');
d8620c7234281056fdfd2ee40cf16636b8281092Tinderbox User Y.before(yready, GLOBAL_ENV, "_ready");
d8620c7234281056fdfd2ee40cf16636b8281092Tinderbox User}
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User
d8620c7234281056fdfd2ee40cf16636b8281092Tinderbox User})();
d8620c7234281056fdfd2ee40cf16636b8281092Tinderbox User(function() {
d8620c7234281056fdfd2ee40cf16636b8281092Tinderbox User
d8620c7234281056fdfd2ee40cf16636b8281092Tinderbox User/**
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * Custom event engine, DOM event listener abstraction layer, synthetic DOM
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * events.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * @module event
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * @submodule event-base
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein */
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein/**
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * Wraps a DOM event, properties requiring browser abstraction are
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * fixed here. Provids a security layer when required.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * @class DOMEventFacade
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * @param ev {Event} the DOM event
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User * @param currentTarget {HTMLElement} the element the listener was attached to
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * @param wrapper {Event.Custom} the custom event wrapper for this DOM event
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein */
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein/*
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * @TODO constants? LEFTBUTTON, MIDDLEBUTTON, RIGHTBUTTON, keys
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein */
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User
665a24faf6b3711e4012ac02ae5f0981c093ac1eTinderbox User/*
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinvar whitelist = {
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein altKey : 1,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein // "button" : 1, // we supply
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein // "bubbles" : 1, // needed?
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein // "cancelable" : 1, // needed?
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein // "charCode" : 1, // we supply
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein cancelBubble : 1,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein // "currentTarget" : 1, // we supply
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein ctrlKey : 1,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein clientX : 1, // needed?
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein clientY : 1, // needed?
a1b05dea35aa30b152a47115e18bbe679d3fcf19Mark Andrews detail : 1, // not fully implemented
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein // "fromElement" : 1,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein keyCode : 1,
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User // "height" : 1, // needed?
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein // "initEvent" : 1, // need the init events?
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein // "initMouseEvent" : 1,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein // "initUIEvent" : 1,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein // "layerX" : 1, // needed?
d71e2e0c61df16ff37c9934c371a4a60c08974f7Mark Andrews // "layerY" : 1, // needed?
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein metaKey : 1,
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User // "modifiers" : 1, // needed?
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein // "offsetX" : 1, // needed?
1c09d68dfd18b6e839c8cd68b78c11b3ccca4160Automatic Updater // "offsetY" : 1, // needed?
1c09d68dfd18b6e839c8cd68b78c11b3ccca4160Automatic Updater // "preventDefault" : 1, // we supply
1c09d68dfd18b6e839c8cd68b78c11b3ccca4160Automatic Updater // "reason" : 1, // IE proprietary
1c09d68dfd18b6e839c8cd68b78c11b3ccca4160Automatic Updater // "relatedTarget" : 1,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein // "returnValue" : 1, // needed?
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein shiftKey : 1,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein // "srcUrn" : 1, // IE proprietary
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User // "srcElement" : 1,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein // "srcFilter" : 1, IE proprietary
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein // "stopPropagation" : 1, // we supply
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein // "target" : 1,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein // "timeStamp" : 1, // needed?
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein // "toElement" : 1,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein type : 1,
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User // "view" : 1,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein // "which" : 1, // we supply
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein // "width" : 1, // needed?
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User x : 1,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein y : 1
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein},
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein*/
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
f6da30bb5447c23d880b09f601441e70c5313557Mark Andrews var ua = Y.UA,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein /**
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * webkit key remapping required for Safari < 3.1
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * @property webkitKeymap
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * @private
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein */
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein webkitKeymap = {
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein 63232: 38, // up
a057e8e33baa5fa369be28a9680585200ce3ff73Mark Andrews 63233: 40, // down
a057e8e33baa5fa369be28a9680585200ce3ff73Mark Andrews 63234: 37, // left
665a24faf6b3711e4012ac02ae5f0981c093ac1eTinderbox User 63235: 39, // right
8c9957e63274e6ea44d182703116307b1a65dabbMark Andrews 63276: 33, // page up
a057e8e33baa5fa369be28a9680585200ce3ff73Mark Andrews 63277: 34, // page down
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein 25: 9, // SHIFT-TAB (Safari provides a different key code in
d71e2e0c61df16ff37c9934c371a4a60c08974f7Mark Andrews // this case, even though the shiftKey modifier is set)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein 63272: 46, // delete
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein 63273: 36, // home
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein 63275: 35 // end
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein },
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User /**
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * Returns a wrapped node. Intended to be used on event targets,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * so it will return the node's parent if the target is a text
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * node.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein *
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * If accessing a property of the node throws an error, this is
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * probably the anonymous div wrapper Gecko adds inside text
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * nodes. This likely will only occur when attempting to access
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * the relatedTarget. In this case, we now return null because
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * the anonymous div is completely useless and we do not know
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * what the related target was because we can't even get to
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User * the element's parent node.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein *
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * @method resolve
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * @private
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein */
7329012471d165cd3dc4180ad2a0a43de91e7f01Mark Andrews resolve = function(n) {
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein try {
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein if (n && 3 == n.nodeType) {
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein n = n.parentNode;
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein }
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein } catch(e) {
61e1dc26d62c2a0059e3ca7efe2ad0f4a5b8df92Mark Andrews return null;
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein }
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein return Y.one(n);
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein };
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein// provide a single event with browser abstractions resolved
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User//
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein// include all properties for both browers?
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein// include only DOM2 spec properties?
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein// provide browser-specific facade?
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User
665a24faf6b3711e4012ac02ae5f0981c093ac1eTinderbox UserY.DOMEventFacade = function(ev, currentTarget, wrapper) {
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein wrapper = wrapper || {};
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein var e = ev, ot = currentTarget, d = Y.config.doc, b = d.body,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein x = e.pageX, y = e.pageY, c, t, de = d.documentElement,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein overrides = wrapper.overrides || {};
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein this.altKey = e.altKey;
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein this.ctrlKey = e.ctrlKey;
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein this.metaKey = e.metaKey;
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein this.shiftKey = e.shiftKey;
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein this.type = overrides.type || e.type;
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein this.clientX = e.clientX;
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein this.clientY = e.clientY;
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein //////////////////////////////////////////////////////
fb84f9014321c5f33c4682de5661b579fcde318fAndreas Gustafsson
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein if (('clientX' in e) && (!x) && (0 !== x)) {
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User x = e.clientX;
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein y = e.clientY;
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein if (ua.ie) {
d71e2e0c61df16ff37c9934c371a4a60c08974f7Mark Andrews x += (de.scrollLeft || b.scrollLeft || 0);
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein y += (de.scrollTop || b.scrollTop || 0);
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein }
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein }
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein this._yuifacade = true;
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein /**
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * The native event
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * @property _event
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein */
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein this._event = e;
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein /**
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * The X location of the event on the page (including scroll)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * @property pageX
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * @type int
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein */
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein this.pageX = x;
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein /**
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * The Y location of the event on the page (including scroll)
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User * @property pageY
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * @type int
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein */
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein this.pageY = y;
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein //////////////////////////////////////////////////////
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein c = e.keyCode || e.charCode || 0;
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein if (ua.webkit && (c in webkitKeymap)) {
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein c = webkitKeymap[c];
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein }
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein /**
a057e8e33baa5fa369be28a9680585200ce3ff73Mark Andrews * The keyCode for key events. Uses charCode if keyCode is not available
a057e8e33baa5fa369be28a9680585200ce3ff73Mark Andrews * @property keyCode
a057e8e33baa5fa369be28a9680585200ce3ff73Mark Andrews * @type int
a057e8e33baa5fa369be28a9680585200ce3ff73Mark Andrews */
a057e8e33baa5fa369be28a9680585200ce3ff73Mark Andrews this.keyCode = c;
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein /**
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * The charCode for key events. Same as keyCode
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * @property charCode
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * @type int
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein */
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein this.charCode = c;
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein //////////////////////////////////////////////////////
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein /**
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * The button that was pushed.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * @property button
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * @type int
370c55dfcdc559b8761ef3eb4921498580caf14cAutomatic Updater */
370c55dfcdc559b8761ef3eb4921498580caf14cAutomatic Updater this.button = e.which || e.button;
370c55dfcdc559b8761ef3eb4921498580caf14cAutomatic Updater
370c55dfcdc559b8761ef3eb4921498580caf14cAutomatic Updater /**
370c55dfcdc559b8761ef3eb4921498580caf14cAutomatic Updater * The button that was pushed. Same as button.
370c55dfcdc559b8761ef3eb4921498580caf14cAutomatic Updater * @property which
370c55dfcdc559b8761ef3eb4921498580caf14cAutomatic Updater * @type int
77dccf2a5d9327d16b4374a135cdb99bdd48620eAutomatic Updater */
77dccf2a5d9327d16b4374a135cdb99bdd48620eAutomatic Updater this.which = this.button;
370c55dfcdc559b8761ef3eb4921498580caf14cAutomatic Updater
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein //////////////////////////////////////////////////////
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein /**
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * Node reference for the targeted element
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * @propery target
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * @type Node
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein */
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein this.target = resolve(e.target || e.srcElement);
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein /**
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * Node reference for the element that the listener was attached to.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * @propery currentTarget
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * @type Node
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein */
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein this.currentTarget = resolve(ot);
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein t = e.relatedTarget;
77dccf2a5d9327d16b4374a135cdb99bdd48620eAutomatic Updater
77dccf2a5d9327d16b4374a135cdb99bdd48620eAutomatic Updater if (!t) {
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User if (e.type == "mouseout") {
77dccf2a5d9327d16b4374a135cdb99bdd48620eAutomatic Updater t = e.toElement;
77dccf2a5d9327d16b4374a135cdb99bdd48620eAutomatic Updater } else if (e.type == "mouseover") {
77dccf2a5d9327d16b4374a135cdb99bdd48620eAutomatic Updater t = e.fromElement;
77dccf2a5d9327d16b4374a135cdb99bdd48620eAutomatic Updater }
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein }
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User /**
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * Node reference to the relatedTarget
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * @propery relatedTarget
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * @type Node
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein */
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein this.relatedTarget = resolve(t);
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein /**
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * Number representing the direction and velocity of the movement of the mousewheel.
77dccf2a5d9327d16b4374a135cdb99bdd48620eAutomatic Updater * Negative is down, the higher the number, the faster. Applies to the mousewheel event.
77dccf2a5d9327d16b4374a135cdb99bdd48620eAutomatic Updater * @property wheelDelta
77dccf2a5d9327d16b4374a135cdb99bdd48620eAutomatic Updater * @type int
77dccf2a5d9327d16b4374a135cdb99bdd48620eAutomatic Updater */
77dccf2a5d9327d16b4374a135cdb99bdd48620eAutomatic Updater if (e.type == "mousewheel" || e.type == "DOMMouseScroll") {
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User this.wheelDelta = (e.detail) ? (e.detail * -1) : Math.round(e.wheelDelta / 80) || ((e.wheelDelta < 0) ? -1 : 1);
77dccf2a5d9327d16b4374a135cdb99bdd48620eAutomatic Updater }
77dccf2a5d9327d16b4374a135cdb99bdd48620eAutomatic Updater
77dccf2a5d9327d16b4374a135cdb99bdd48620eAutomatic Updater //////////////////////////////////////////////////////
77dccf2a5d9327d16b4374a135cdb99bdd48620eAutomatic Updater // methods
77dccf2a5d9327d16b4374a135cdb99bdd48620eAutomatic Updater
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User /**
77dccf2a5d9327d16b4374a135cdb99bdd48620eAutomatic Updater * Stops the propagation to the next bubble target
77dccf2a5d9327d16b4374a135cdb99bdd48620eAutomatic Updater * @method stopPropagation
77dccf2a5d9327d16b4374a135cdb99bdd48620eAutomatic Updater */
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein this.stopPropagation = function() {
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein if (e.stopPropagation) {
a1b05dea35aa30b152a47115e18bbe679d3fcf19Mark Andrews e.stopPropagation();
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein } else {
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User e.cancelBubble = true;
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein }
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein wrapper.stopped = 1;
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein this.stopped = 1;
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein };
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein /**
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * Stops the propagation to the next bubble target and
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * prevents any additional listeners from being exectued
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * on the current target.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * @method stopImmediatePropagation
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein */
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein this.stopImmediatePropagation = function() {
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein if (e.stopImmediatePropagation) {
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein e.stopImmediatePropagation();
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein } else {
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein this.stopPropagation();
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein }
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein wrapper.stopped = 2;
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein this.stopped = 2;
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein };
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
be6c1c506161e6f45fcff5d0425f78801bc267c1Automatic Updater /**
be6c1c506161e6f45fcff5d0425f78801bc267c1Automatic Updater * Prevents the event's default behavior
be6c1c506161e6f45fcff5d0425f78801bc267c1Automatic Updater * @method preventDefault
be6c1c506161e6f45fcff5d0425f78801bc267c1Automatic Updater * @param returnValue {string} sets the returnValue of the event to this value
be6c1c506161e6f45fcff5d0425f78801bc267c1Automatic Updater * (rather than the default false value). This can be used to add a customized
be6c1c506161e6f45fcff5d0425f78801bc267c1Automatic Updater * confirmation query to the beforeunload event).
be6c1c506161e6f45fcff5d0425f78801bc267c1Automatic Updater */
be6c1c506161e6f45fcff5d0425f78801bc267c1Automatic Updater this.preventDefault = function(returnValue) {
be6c1c506161e6f45fcff5d0425f78801bc267c1Automatic Updater if (e.preventDefault) {
9054d0bb0301aa04ea1ff700ebe4beaf0b573d24Tinderbox User e.preventDefault();
9054d0bb0301aa04ea1ff700ebe4beaf0b573d24Tinderbox User }
9054d0bb0301aa04ea1ff700ebe4beaf0b573d24Tinderbox User e.returnValue = returnValue || false;
9054d0bb0301aa04ea1ff700ebe4beaf0b573d24Tinderbox User wrapper.prevented = 1;
9054d0bb0301aa04ea1ff700ebe4beaf0b573d24Tinderbox User this.prevented = 1;
9054d0bb0301aa04ea1ff700ebe4beaf0b573d24Tinderbox User };
9054d0bb0301aa04ea1ff700ebe4beaf0b573d24Tinderbox User
9054d0bb0301aa04ea1ff700ebe4beaf0b573d24Tinderbox User /**
9054d0bb0301aa04ea1ff700ebe4beaf0b573d24Tinderbox User * Stops the event propagation and prevents the default
9054d0bb0301aa04ea1ff700ebe4beaf0b573d24Tinderbox User * event behavior.
be6c1c506161e6f45fcff5d0425f78801bc267c1Automatic Updater * @method halt
be6c1c506161e6f45fcff5d0425f78801bc267c1Automatic Updater * @param immediate {boolean} if true additional listeners
be6c1c506161e6f45fcff5d0425f78801bc267c1Automatic Updater * on the current target will not be executed
be6c1c506161e6f45fcff5d0425f78801bc267c1Automatic Updater */
be6c1c506161e6f45fcff5d0425f78801bc267c1Automatic Updater this.halt = function(immediate) {
be6c1c506161e6f45fcff5d0425f78801bc267c1Automatic Updater if (immediate) {
be6c1c506161e6f45fcff5d0425f78801bc267c1Automatic Updater this.stopImmediatePropagation();
be6c1c506161e6f45fcff5d0425f78801bc267c1Automatic Updater } else {
be6c1c506161e6f45fcff5d0425f78801bc267c1Automatic Updater this.stopPropagation();
be6c1c506161e6f45fcff5d0425f78801bc267c1Automatic Updater }
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein this.preventDefault();
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein };
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein if (this._touch) {
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein this._touch(e, currentTarget, wrapper);
d71e2e0c61df16ff37c9934c371a4a60c08974f7Mark Andrews }
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein};
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein})();
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein(function() {
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein/**
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * DOM event listener abstraction layer
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * @module event
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * @submodule event-base
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein */
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein/**
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * The event utility provides functions to add and remove event listeners,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * event cleansing. It also tries to automatically remove listeners it
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * registers during the unload event.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein *
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * @class Event
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * @static
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein */
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinY.Env.evt.dom_wrappers = {};
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinY.Env.evt.dom_map = {};
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinvar _eventenv = Y.Env.evt,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinconfig = Y.config,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinwin = config.win,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinadd = YUI.Env.add,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinremove = YUI.Env.remove,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinonLoad = function() {
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein YUI.Env.windowLoaded = true;
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Y.Event._load();
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein remove(win, "load", onLoad);
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein},
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinonUnload = function() {
fb84f9014321c5f33c4682de5661b579fcde318fAndreas Gustafsson Y.Event._unload();
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein remove(win, "unload", onUnload);
d71e2e0c61df16ff37c9934c371a4a60c08974f7Mark Andrews},
d71e2e0c61df16ff37c9934c371a4a60c08974f7Mark Andrews
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinEVENT_READY = 'domready',
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinCOMPAT_ARG = '~yui|2|compat~',
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinshouldIterate = function(o) {
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein try {
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein return (o && typeof o !== "string" && Y.Lang.isNumber(o.length) && !o.tagName && !o.alert);
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein } catch(ex) {
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Y.log("collection check failure", "warn", "event");
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein return false;
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein }
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein},
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinEvent = function() {
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein /**
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * True after the onload event has fired
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * @property _loadComplete
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * @type boolean
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * @static
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * @private
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein */
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein var _loadComplete = false,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein /**
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * The number of times to poll after window.onload. This number is
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * increased if additional late-bound handlers are requested after
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * the page load.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * @property _retryCount
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * @static
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * @private
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein */
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein _retryCount = 0,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein /**
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * onAvailable listeners
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * @property _avail
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * @static
00124ad0406365d39f4b2d1011ef6a76706e9df0Mark Andrews * @private
00124ad0406365d39f4b2d1011ef6a76706e9df0Mark Andrews */
00124ad0406365d39f4b2d1011ef6a76706e9df0Mark Andrews _avail = [],
00124ad0406365d39f4b2d1011ef6a76706e9df0Mark Andrews
00124ad0406365d39f4b2d1011ef6a76706e9df0Mark Andrews /**
00124ad0406365d39f4b2d1011ef6a76706e9df0Mark Andrews * Custom event wrappers for DOM events. Key is
00124ad0406365d39f4b2d1011ef6a76706e9df0Mark Andrews * 'event:' + Element uid stamp + event type
00124ad0406365d39f4b2d1011ef6a76706e9df0Mark Andrews * @property _wrappers
77dccf2a5d9327d16b4374a135cdb99bdd48620eAutomatic Updater * @type Y.Event.Custom
77dccf2a5d9327d16b4374a135cdb99bdd48620eAutomatic Updater * @static
77dccf2a5d9327d16b4374a135cdb99bdd48620eAutomatic Updater * @private
77dccf2a5d9327d16b4374a135cdb99bdd48620eAutomatic Updater */
00124ad0406365d39f4b2d1011ef6a76706e9df0Mark Andrews _wrappers = _eventenv.dom_wrappers,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein _windowLoadKey = null,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein /**
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * Custom event wrapper map DOM events. Key is
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User * Element uid stamp. Each item is a hash of custom event
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * wrappers as provided in the _wrappers collection. This
6c8a888822cfe45f0525e7496dcaa27d341b6a5eAutomatic Updater * provides the infrastructure for getListeners.
6c8a888822cfe45f0525e7496dcaa27d341b6a5eAutomatic Updater * @property _el_events
6c8a888822cfe45f0525e7496dcaa27d341b6a5eAutomatic Updater * @static
6c8a888822cfe45f0525e7496dcaa27d341b6a5eAutomatic Updater * @private
6c8a888822cfe45f0525e7496dcaa27d341b6a5eAutomatic Updater */
6c8a888822cfe45f0525e7496dcaa27d341b6a5eAutomatic Updater _el_events = _eventenv.dom_map;
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein return {
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein /**
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * The number of times we should look for elements that are not
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * in the DOM at the time the event is requested after the document
d71e2e0c61df16ff37c9934c371a4a60c08974f7Mark Andrews * has been loaded. The default is 1000@amp;40 ms, so it will poll
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * for 40 seconds or until all outstanding handlers are bound
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * (whichever comes first).
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * @property POLL_RETRYS
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * @type int
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * @static
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * @final
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein */
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein POLL_RETRYS: 1000,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein /**
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * The poll interval in milliseconds
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * @property POLL_INTERVAL
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * @type int
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * @static
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * @final
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein */
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein POLL_INTERVAL: 40,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
90153b6536f7a5078e1c157c980110dbcd7fe205Mark Andrews /**
90153b6536f7a5078e1c157c980110dbcd7fe205Mark Andrews * addListener/removeListener can throw errors in unexpected scenarios.
90153b6536f7a5078e1c157c980110dbcd7fe205Mark Andrews * These errors are suppressed, the method returns false, and this property
90153b6536f7a5078e1c157c980110dbcd7fe205Mark Andrews * is set
90153b6536f7a5078e1c157c980110dbcd7fe205Mark Andrews * @property lastError
90153b6536f7a5078e1c157c980110dbcd7fe205Mark Andrews * @static
90153b6536f7a5078e1c157c980110dbcd7fe205Mark Andrews * @type Error
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User */
90153b6536f7a5078e1c157c980110dbcd7fe205Mark Andrews lastError: null,
90153b6536f7a5078e1c157c980110dbcd7fe205Mark Andrews
90153b6536f7a5078e1c157c980110dbcd7fe205Mark Andrews
90153b6536f7a5078e1c157c980110dbcd7fe205Mark Andrews /**
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * poll handle
90153b6536f7a5078e1c157c980110dbcd7fe205Mark Andrews * @property _interval
90153b6536f7a5078e1c157c980110dbcd7fe205Mark Andrews * @static
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * @private
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein */
d71e2e0c61df16ff37c9934c371a4a60c08974f7Mark Andrews _interval: null,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein /**
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * document readystate poll handle
8dc5d5e460da15b2481893687cad7e5b72d0314aAutomatic Updater * @property _dri
8dc5d5e460da15b2481893687cad7e5b72d0314aAutomatic Updater * @static
8dc5d5e460da15b2481893687cad7e5b72d0314aAutomatic Updater * @private
8dc5d5e460da15b2481893687cad7e5b72d0314aAutomatic Updater */
20489550151432d8d99c3f49629c7c718fdca6abMark Andrews _dri: null,
20489550151432d8d99c3f49629c7c718fdca6abMark Andrews
20489550151432d8d99c3f49629c7c718fdca6abMark Andrews /**
20489550151432d8d99c3f49629c7c718fdca6abMark Andrews * True when the document is initially usable
20489550151432d8d99c3f49629c7c718fdca6abMark Andrews * @property DOMReady
20489550151432d8d99c3f49629c7c718fdca6abMark Andrews * @type boolean
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * @static
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein */
fb84f9014321c5f33c4682de5661b579fcde318fAndreas Gustafsson DOMReady: false,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein /**
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User * @method startInterval
665a24faf6b3711e4012ac02ae5f0981c093ac1eTinderbox User * @static
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * @private
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User */
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein startInterval: function() {
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein if (!Event._interval) {
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinEvent._interval = setInterval(Y.bind(Event._poll, Event), Event.POLL_INTERVAL);
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein }
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein },
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein /**
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * Executes the supplied callback when the item with the supplied
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * id is found. This is meant to be used to execute behavior as
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * soon as possible as the page loads. If you use this after the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * initial page load it will poll for a fixed time for the element.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * The number of times it will poll and the frequency are
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * configurable. By default it will poll for 10 seconds.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein *
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * <p>The callback is executed with a single parameter:
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * the custom object parameter, if provided.</p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein *
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * @method onAvailable
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein *
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * @param {string||string[]} id the id of the element, or an array
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * of ids to look for.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * @param {function} fn what to execute when the element is found.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * @param {object} p_obj an optional object to be passed back as
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * a parameter to fn.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * @param {boolean|object} p_override If set to true, fn will execute
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * in the context of p_obj, if set to an object it
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User * will execute in the context of that object
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * @param checkContent {boolean} check child node readiness (onContentReady)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * @static
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein * @deprecated Use Y.on("available")
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein */
fb84f9014321c5f33c4682de5661b579fcde318fAndreas Gustafsson // @TODO fix arguments
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein onAvailable: function(id, fn, p_obj, p_override, checkContent, compat) {
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User var a = Y.Array(id), i, availHandle;
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein // Y.log('onAvailable registered for: ' + id);
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein for (i=0; i<a.length; i=i+1) {
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein _avail.push({
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein id: a[i],
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein fn: fn,
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User obj: p_obj,
665a24faf6b3711e4012ac02ae5f0981c093ac1eTinderbox User override: p_override,
057cafaa3df7be7a6dcca71fbaf8fb498fd83518Mark Andrews checkReady: checkContent,
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User compat: compat
057cafaa3df7be7a6dcca71fbaf8fb498fd83518Mark Andrews });
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User }
057cafaa3df7be7a6dcca71fbaf8fb498fd83518Mark Andrews _retryCount = this.POLL_RETRYS;
057cafaa3df7be7a6dcca71fbaf8fb498fd83518Mark Andrews
057cafaa3df7be7a6dcca71fbaf8fb498fd83518Mark Andrews // We want the first test to be immediate, but async
057cafaa3df7be7a6dcca71fbaf8fb498fd83518Mark Andrews setTimeout(Y.bind(Event._poll, Event), 0);
057cafaa3df7be7a6dcca71fbaf8fb498fd83518Mark Andrews
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User availHandle = new Y.EventHandle({
057cafaa3df7be7a6dcca71fbaf8fb498fd83518Mark Andrews
057cafaa3df7be7a6dcca71fbaf8fb498fd83518Mark Andrews _delete: function() {
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User // set by the event system for lazy DOM listeners
665a24faf6b3711e4012ac02ae5f0981c093ac1eTinderbox User if (availHandle.handle) {
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein availHandle.handle.detach();
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein return;
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein }
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein var i, j;
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User
665a24faf6b3711e4012ac02ae5f0981c093ac1eTinderbox User // otherwise try to remove the onAvailable listener(s)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein for (i = 0; i < a.length; i++) {
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein for (j = 0; j < _avail.length; j++) {
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein if (a[i] === _avail[j].id) {
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein _avail.splice(j, 1);
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein }
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein }
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User }
665a24faf6b3711e4012ac02ae5f0981c093ac1eTinderbox User }
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein });
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein return availHandle;
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein },
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
/**
* Works the same way as onAvailable, but additionally checks the
* state of sibling elements to determine if the content of the
* available element is safe to modify.
*
* <p>The callback is executed with a single parameter:
* the custom object parameter, if provided.</p>
*
* @method onContentReady
*
* @param {string} id the id of the element to look for.
* @param {function} fn what to execute when the element is ready.
* @param {object} p_obj an optional object to be passed back as
* a parameter to fn.
* @param {boolean|object} p_override If set to true, fn will execute
* in the context of p_obj. If an object, fn will
* exectute in the context of that object
*
* @static
* @deprecated Use Y.on("contentready")
*/
// @TODO fix arguments
onContentReady: function(id, fn, p_obj, p_override, compat) {
return this.onAvailable(id, fn, p_obj, p_override, true, compat);
},
/**
* Adds an event listener
*
* @method attach
*
* @param {String} type The type of event to append
* @param {Function} fn The method the event invokes
* @param {String|HTMLElement|Array|NodeList} el An id, an element
* reference, or a collection of ids and/or elements to assign the
* listener to.
* @param {Object} context optional context object
* @param {Boolean|object} args 0..n arguments to pass to the callback
* @return {EventHandle} an object to that can be used to detach the listener
*
* @static
*/
attach: function(type, fn, el, context) {
return Event._attach(Y.Array(arguments, 0, true));
},
_createWrapper: function (el, type, capture, compat, facade) {
var cewrapper,
ek = Y.stamp(el),
key = 'event:' + ek + type;
if (false === facade) {
key += 'native';
}
if (capture) {
key += 'capture';
}
cewrapper = _wrappers[key];
if (!cewrapper) {
// create CE wrapper
cewrapper = Y.publish(key, {
silent: true,
bubbles: false,
contextFn: function() {
if (compat) {
return cewrapper.el;
} else {
cewrapper.nodeRef = cewrapper.nodeRef || Y.one(cewrapper.el);
return cewrapper.nodeRef;
}
}
});
cewrapper.overrides = {};
// for later removeListener calls
cewrapper.el = el;
cewrapper.key = key;
cewrapper.domkey = ek;
cewrapper.type = type;
cewrapper.fn = function(e) {
cewrapper.fire(Event.getEvent(e, el, (compat || (false === facade))));
};
cewrapper.capture = capture;
if (el == win && type == "load") {
// window load happens once
cewrapper.fireOnce = true;
_windowLoadKey = key;
}
_wrappers[key] = cewrapper;
_el_events[ek] = _el_events[ek] || {};
_el_events[ek][key] = cewrapper;
add(el, type, cewrapper.fn, capture);
}
return cewrapper;
},
_attach: function(args, conf) {
var compat,
handles, oEl, cewrapper, context,
fireNow = false, ret,
type = args[0],
fn = args[1],
el = args[2] || win,
facade = conf && conf.facade,
capture = conf && conf.capture,
overrides = conf && conf.overrides;
if (args[args.length-1] === COMPAT_ARG) {
compat = true;
// trimmedArgs.pop();
}
if (!fn || !fn.call) {
// throw new TypeError(type + " attach call failed, callback undefined");
Y.log(type + " attach call failed, invalid callback", "error", "event");
return false;
}
// The el argument can be an array of elements or element ids.
if (shouldIterate(el)) {
handles=[];
Y.each(el, function(v, k) {
args[2] = v;
handles.push(Event._attach(args, conf));
});
// return (handles.length === 1) ? handles[0] : handles;
return new Y.EventHandle(handles);
// If the el argument is a string, we assume it is
// actually the id of the element. If the page is loaded
// we convert el to the actual element, otherwise we
// defer attaching the event until the element is
// ready
} else if (Y.Lang.isString(el)) {
// oEl = (compat) ? Y.DOM.byId(el) : Y.Selector.query(el);
if (compat) {
oEl = Y.DOM.byId(el);
} else {
oEl = Y.Selector.query(el);
switch (oEl.length) {
case 0:
oEl = null;
break;
case 1:
oEl = oEl[0];
break;
default:
args[2] = oEl;
return Event._attach(args, conf);
}
}
if (oEl) {
el = oEl;
// Not found = defer adding the event until the element is available
} else {
// Y.log(el + ' not found');
ret = this.onAvailable(el, function() {
// Y.log('lazy attach: ' + args);
ret.handle = Event._attach(args, conf);
}, Event, true, false, compat);
return ret;
}
}
// Element should be an html element or node
if (!el) {
Y.log("unable to attach event " + type, "warn", "event");
return false;
}
if (Y.Node && el instanceof Y.Node) {
el = Y.Node.getDOMNode(el);
}
cewrapper = this._createWrapper(el, type, capture, compat, facade);
if (overrides) {
Y.mix(cewrapper.overrides, overrides);
}
if (el == win && type == "load") {
// if the load is complete, fire immediately.
// all subscribers, including the current one
// will be notified.
if (YUI.Env.windowLoaded) {
fireNow = true;
}
}
if (compat) {
args.pop();
}
context = args[3];
// set context to the Node if not specified
// ret = cewrapper.on.apply(cewrapper, trimmedArgs);
ret = cewrapper._on(fn, context, (args.length > 4) ? args.slice(4) : null);
if (fireNow) {
cewrapper.fire();
}
return ret;
},
/**
* Removes an event listener. Supports the signature the event was bound
* with, but the preferred way to remove listeners is using the handle
* that is returned when using Y.on
*
* @method detach
*
* @param {String} type the type of event to remove.
* @param {Function} fn the method the event invokes. If fn is
* undefined, then all event handlers for the type of event are
* removed.
* @param {String|HTMLElement|Array|NodeList|EventHandle} el An
* event handle, an id, an element reference, or a collection
* of ids and/or elements to remove the listener from.
* @return {boolean} true if the unbind was successful, false otherwise.
* @static
*/
detach: function(type, fn, el, obj) {
var args=Y.Array(arguments, 0, true), compat, l, ok, i,
id, ce;
if (args[args.length-1] === COMPAT_ARG) {
compat = true;
// args.pop();
}
if (type && type.detach) {
return type.detach();
}
// The el argument can be a string
if (typeof el == "string") {
// el = (compat) ? Y.DOM.byId(el) : Y.all(el);
if (compat) {
el = Y.DOM.byId(el);
} else {
el = Y.Selector.query(el);
l = el.length;
if (l < 1) {
el = null;
} else if (l == 1) {
el = el[0];
}
}
// return Event.detach.apply(Event, args);
}
if (!el) {
return false;
}
if (el.detach) {
args.splice(2, 1);
return el.detach.apply(el, args);
// The el argument can be an array of elements or element ids.
} else if (shouldIterate(el)) {
ok = true;
for (i=0, l=el.length; i<l; ++i) {
args[2] = el[i];
ok = ( Y.Event.detach.apply(Y.Event, args) && ok );
}
return ok;
}
if (!type || !fn || !fn.call) {
return this.purgeElement(el, false, type);
}
id = 'event:' + Y.stamp(el) + type;
ce = _wrappers[id];
if (ce) {
return ce.detach(fn);
} else {
return false;
}
},
/**
* Finds the event in the window object, the caller's arguments, or
* in the arguments of another method in the callstack. This is
* executed automatically for events registered through the event
* manager, so the implementer should not normally need to execute
* this function at all.
* @method getEvent
* @param {Event} e the event parameter from the handler
* @param {HTMLElement} el the element the listener was attached to
* @return {Event} the event
* @static
*/
getEvent: function(e, el, noFacade) {
var ev = e || win.event;
return (noFacade) ? ev :
new Y.DOMEventFacade(ev, el, _wrappers['event:' + Y.stamp(el) + e.type]);
},
/**
* Generates an unique ID for the element if it does not already
* have one.
* @method generateId
* @param el the element to create the id for
* @return {string} the resulting id of the element
* @static
*/
generateId: function(el) {
var id = el.id;
if (!id) {
id = Y.stamp(el);
el.id = id;
}
return id;
},
/**
* We want to be able to use getElementsByTagName as a collection
* to attach a group of events to. Unfortunately, different
* browsers return different types of collections. This function
* tests to determine if the object is array-like. It will also
* fail if the object is an array, but is empty.
* @method _isValidCollection
* @param o the object to test
* @return {boolean} true if the object is array-like and populated
* @deprecated was not meant to be used directly
* @static
* @private
*/
_isValidCollection: shouldIterate,
/**
* hook up any deferred listeners
* @method _load
* @static
* @private
*/
_load: function(e) {
if (!_loadComplete) {
// Y.log('Load Complete', 'info', 'event');
_loadComplete = true;
// Just in case DOMReady did not go off for some reason
// E._ready();
if (Y.fire) {
Y.fire(EVENT_READY);
}
// Available elements may not have been detected before the
// window load event fires. Try to find them now so that the
// the user is more likely to get the onAvailable notifications
// before the window load notification
Event._poll();
}
},
/**
* Polling function that runs before the onload event fires,
* attempting to attach to DOM Nodes as soon as they are
* available
* @method _poll
* @static
* @private
*/
_poll: function() {
if (this.locked) {
return;
}
if (Y.UA.ie && !YUI.Env.DOMReady) {
// Hold off if DOMReady has not fired and check current
// readyState to protect against the IE operation aborted
// issue.
this.startInterval();
return;
}
this.locked = true;
// Y.log.debug("poll");
// keep trying until after the page is loaded. We need to
// check the page load state prior to trying to bind the
// elements so that we can be certain all elements have been
// tested appropriately
var i, len, item, el, notAvail, executeItem,
tryAgain = !_loadComplete;
if (!tryAgain) {
tryAgain = (_retryCount > 0);
}
// onAvailable
notAvail = [];
executeItem = function (el, item) {
var context, ov = item.override;
if (item.compat) {
if (item.override) {
if (ov === true) {
context = item.obj;
} else {
context = ov;
}
} else {
context = el;
}
item.fn.call(context, item.obj);
} else {
context = item.obj || Y.one(el);
item.fn.apply(context, (Y.Lang.isArray(ov)) ? ov : []);
}
};
// onAvailable
for (i=0,len=_avail.length; i<len; ++i) {
item = _avail[i];
if (item && !item.checkReady) {
// el = (item.compat) ? Y.DOM.byId(item.id) : Y.one(item.id);
el = (item.compat) ? Y.DOM.byId(item.id) : Y.Selector.query(item.id, null, true);
if (el) {
// Y.log('avail: ' + el);
executeItem(el, item);
_avail[i] = null;
} else {
// Y.log('NOT avail: ' + el);
notAvail.push(item);
}
}
}
// onContentReady
for (i=0,len=_avail.length; i<len; ++i) {
item = _avail[i];
if (item && item.checkReady) {
// el = (item.compat) ? Y.DOM.byId(item.id) : Y.one(item.id);
el = (item.compat) ? Y.DOM.byId(item.id) : Y.Selector.query(item.id, null, true);
if (el) {
// The element is available, but not necessarily ready
// @todo should we test parentNode.nextSibling?
if (_loadComplete || (el.get && el.get('nextSibling')) || el.nextSibling) {
executeItem(el, item);
_avail[i] = null;
}
} else {
notAvail.push(item);
}
}
}
_retryCount = (notAvail.length === 0) ? 0 : _retryCount - 1;
if (tryAgain) {
// we may need to strip the nulled out items here
this.startInterval();
} else {
clearInterval(this._interval);
this._interval = null;
}
this.locked = false;
return;
},
/**
* Removes all listeners attached to the given element via addListener.
* Optionally, the node's children can also be purged.
* Optionally, you can specify a specific type of event to remove.
* @method purgeElement
* @param {HTMLElement} el the element to purge
* @param {boolean} recurse recursively purge this element's children
* as well. Use with caution.
* @param {string} type optional type of listener to purge. If
* left out, all listeners will be removed
* @static
*/
purgeElement: function(el, recurse, type) {
// var oEl = (Y.Lang.isString(el)) ? Y.one(el) : el,
var oEl = (Y.Lang.isString(el)) ? Y.Selector.query(el, null, true) : el,
lis = this.getListeners(oEl, type), i, len, props, children, child;
if (recurse && oEl) {
lis = lis || [];
children = Y.Selector.query('*', oEl);
i = 0;
len = children.length;
for (; i < len; ++i) {
child = this.getListeners(children[i], type);
if (child) {
lis = lis.concat(child);
}
}
}
if (lis) {
i = 0;
len = lis.length;
for (; i < len; ++i) {
props = lis[i];
props.detachAll();
remove(props.el, props.type, props.fn, props.capture);
delete _wrappers[props.key];
delete _el_events[props.domkey][props.key];
}
}
},
/**
* Returns all listeners attached to the given element via addListener.
* Optionally, you can specify a specific type of event to return.
* @method getListeners
* @param el {HTMLElement|string} the element or element id to inspect
* @param type {string} optional type of listener to return. If
* left out, all listeners will be returned
* @return {Y.Custom.Event} the custom event wrapper for the DOM event(s)
* @static
*/
getListeners: function(el, type) {
var ek = Y.stamp(el, true), evts = _el_events[ek],
results=[] , key = (type) ? 'event:' + ek + type : null,
adapters = _eventenv.plugins;
if (!evts) {
return null;
}
if (key) {
// look for synthetic events
if (adapters[type] && adapters[type].eventDef) {
key += '_synth';
}
if (evts[key]) {
results.push(evts[key]);
}
// get native events as well
key += 'native';
if (evts[key]) {
results.push(evts[key]);
}
} else {
Y.each(evts, function(v, k) {
results.push(v);
});
}
return (results.length) ? results : null;
},
/**
* Removes all listeners registered by pe.event. Called
* automatically during the unload event.
* @method _unload
* @static
* @private
*/
_unload: function(e) {
Y.each(_wrappers, function(v, k) {
v.detachAll();
remove(v.el, v.type, v.fn, v.capture);
delete _wrappers[k];
delete _el_events[v.domkey][k];
});
},
/**
* Adds a DOM event directly without the caching, cleanup, context adj, etc
*
* @method nativeAdd
* @param {HTMLElement} el the element to bind the handler to
* @param {string} type the type of event handler
* @param {function} fn the callback to invoke
* @param {boolen} capture capture or bubble phase
* @static
* @private
*/
nativeAdd: add,
/**
* Basic remove listener
*
* @method nativeRemove
* @param {HTMLElement} el the element to bind the handler to
* @param {string} type the type of event handler
* @param {function} fn the callback to invoke
* @param {boolen} capture capture or bubble phase
* @static
* @private
*/
nativeRemove: remove
};
}();
Y.Event = Event;
if (config.injected || YUI.Env.windowLoaded) {
onLoad();
} else {
add(win, "load", onLoad);
}
// Process onAvailable/onContentReady items when when the DOM is ready in IE
if (Y.UA.ie) {
Y.on(EVENT_READY, Event._poll, Event, true);
}
Y.on("unload", onUnload);
Event.Custom = Y.CustomEvent;
Event.Subscriber = Y.Subscriber;
Event.Target = Y.EventTarget;
Event.Handle = Y.EventHandle;
Event.Facade = Y.EventFacade;
Event._poll();
})();
/**
* DOM event listener abstraction layer
* @module event
* @submodule event-base
*/
/**
* Executes the callback as soon as the specified element
* is detected in the DOM.
* @event available
* @param type {string} 'available'
* @param fn {function} the callback function to execute.
* @param el {string|HTMLElement|collection} the element(s) to attach
* @param context optional argument that specifies what 'this' refers to.
* @param args* 0..n additional arguments to pass on to the callback function.
* These arguments will be added after the event object.
* @return {EventHandle} the detach handle
* @for YUI
*/
Y.Env.evt.plugins.available = {
on: function(type, fn, id, o) {
var a = arguments.length > 4 ? Y.Array(arguments, 4, true) : [];
return Y.Event.onAvailable.call(Y.Event, id, fn, o, a);
}
};
/**
* Executes the callback as soon as the specified element
* is detected in the DOM with a nextSibling property
* (indicating that the element's children are available)
* @event contentready
* @param type {string} 'contentready'
* @param fn {function} the callback function to execute.
* @param el {string|HTMLElement|collection} the element(s) to attach
* @param context optional argument that specifies what 'this' refers to.
* @param args* 0..n additional arguments to pass on to the callback function.
* These arguments will be added after the event object.
* @return {EventHandle} the detach handle
* @for YUI
*/
Y.Env.evt.plugins.contentready = {
on: function(type, fn, id, o) {
var a = arguments.length > 4 ? Y.Array(arguments, 4, true) : [];
return Y.Event.onContentReady.call(Y.Event, id, fn, o, a);
}
};
}, '@VERSION@' ,{requires:['event-custom-base']});
YUI.add('event-delegate', function(Y) {
/**
* Adds event delegation support to the library.
*
* @module event
* @submodule event-delegate
*/
var toArray = Y.Array,
YLang = Y.Lang,
isString = YLang.isString,
selectorTest = Y.Selector.test,
detachCategories = Y.Env.evt.handles;
/**
* <p>Sets up event delegation on a container element. The delegated event
* will use a supplied selector or filtering function to test if the event
* references at least one node that should trigger the subscription
* callback.</p>
*
* <p>Selector string filters will trigger the callback if the event originated
* from a node that matches it or is contained in a node that matches it.
* Function filters are called for each Node up the parent axis to the
* subscribing container node, and receive at each level the Node and the event
* object. The function should return true (or a truthy value) if that Node
* should trigger the subscription callback. Note, it is possible for filters
* to match multiple Nodes for a single event. In this case, the delegate
* callback will be executed for each matching Node.</p>
*
* <p>For each matching Node, the callback will be executed with its 'this'
* object set to the Node matched by the filter (unless a specific context was
* provided during subscription), and the provided event's
* <code>currentTarget</code> will also be set to the matching Node. The
* containing Node from which the subscription was originally made can be
* referenced as <code>e.container</code>.
*
* @method delegate
* @param type {String} the event type to delegate
* @param fn {Function} the callback function to execute. This function
* will be provided the event object for the delegated event.
* @param el {String|node} the element that is the delegation container
* @param spec {string|Function} a selector that must match the target of the
* event or a function to test target and its parents for a match
* @param context optional argument that specifies what 'this' refers to.
* @param args* 0..n additional arguments to pass on to the callback function.
* These arguments will be added after the event object.
* @return {EventHandle} the detach handle
* @for YUI
*/
function delegate(type, fn, el, filter) {
var args = toArray(arguments, 0, true),
query = isString(el) ? el : null,
typeBits = type.split(/\|/),
synth, container, categories, cat, handle;
if (typeBits.length > 1) {
cat = typeBits.shift();
type = typeBits.shift();
}
synth = Y.Node.DOM_EVENTS[type];
if (YLang.isObject(synth) && synth.delegate) {
handle = synth.delegate.apply(synth, arguments);
}
if (!handle) {
if (!type || !fn || !el || !filter) {
Y.log("delegate requires type, callback, parent, & filter", "warn");
return;
}
container = (query) ? Y.Selector.query(query, null, true) : el;
if (!container && isString(el)) {
handle = Y.on('available', function () {
Y.mix(handle, Y.delegate.apply(Y, args), true);
}, el);
}
if (!handle && container) {
args.splice(2, 2, container); // remove the filter
if (isString(filter)) {
filter = Y.delegate.compileFilter(filter);
}
handle = Y.on.apply(Y, args);
handle.sub.filter = filter;
handle.sub._notify = delegate.notifySub;
}
}
if (handle && cat) {
categories = detachCategories[cat] || (detachCategories[cat] = {});
categories = categories[type] || (categories[type] = []);
categories.push(handle);
}
return handle;
}
/**
* Overrides the <code>_notify</code> method on the normal DOM subscription to inject the filtering logic and only proceed in the case of a match.
*
* @method delegate.notifySub
* @param thisObj {Object} default 'this' object for the callback
* @param args {Array} arguments passed to the event's <code>fire()</code>
* @param ce {CustomEvent} the custom event managing the DOM subscriptions for
* the subscribed event on the subscribing node.
* @return {Boolean} false if the event was stopped
* @private
* @static
* @since 3.2.0
*/
delegate.notifySub = function (thisObj, args, ce) {
// Preserve args for other subscribers
args = args.slice();
if (this.args) {
args.push.apply(args, this.args);
}
// Only notify subs if the event occurred on a targeted element
var e = args[0],
currentTarget = delegate._applyFilter(this.filter, args),
container = e.currentTarget,
i, ret, target;
if (currentTarget) {
// Support multiple matches up the the container subtree
currentTarget = toArray(currentTarget);
for (i = currentTarget.length - 1; i >= 0; --i) {
target = currentTarget[i];
// New facade to avoid corrupting facade sent to direct subs
args[0] = new Y.DOMEventFacade(e, target, ce);
args[0].container = container;
thisObj = this.context || target;
ret = this.fn.apply(thisObj, args);
if (ret === false) { // stop further notifications
break;
}
}
return ret;
}
};
/**
* <p>Compiles a selector string into a filter function to identify whether
* Nodes along the parent axis of an event's target should trigger event
* notification.</p>
*
* <p>This function is memoized, so previously compiled filter functions are
* returned if the same selector string is provided.</p>
*
* <p>This function may be useful when defining synthetic events for delegate
* handling.</p>
*
* @method delegate.compileFilter
* @param selector {String} the selector string to base the filtration on
* @return {Function}
* @since 3.2.0
* @static
*/
delegate.compileFilter = Y.cached(function (selector) {
return function (target, e) {
return selectorTest(target._node, selector, e.currentTarget._node);
};
});
/**
* Walks up the parent axis of an event's target, and tests each element
* against a supplied filter function. If any Nodes satisfy the filter, the
* delegated callback will be triggered for each.
*
* @method delegate._applyFilter
* @param filter {Function} boolean function to test for inclusion in event
* notification
* @param args {Array} the arguments that would be passed to subscribers
* @return {Node|Node[]|undefined} The Node or Nodes that satisfy the filter
* @protected
*/
delegate._applyFilter = function (filter, args) {
var e = args[0],
container = e.currentTarget,
target = e.target,
match = [];
// passing target as the first arg rather than leaving well enough alone
// making 'this' in the filter function refer to the target. This is to
// support bound filter functions.
args.unshift(target);
while (target && target !== container) {
// filter(target, e, extra args...) - this === target
if (filter.apply(target, args)) {
match.push(target);
}
args[0] = target = target.get('parentNode');
}
if (match.length <= 1) {
match = match[0]; // single match or undefined
}
// remove the target
args.shift();
return match;
};
/**
* Sets up event delegation on a container element. The delegated event
* will use a supplied filter to test if the callback should be executed.
* This filter can be either a selector string or a function that returns
* a Node to use as the currentTarget for the event.
*
* The event object for the delegated event is supplied to the callback
* function. It is modified slightly in order to support all properties
* that may be needed for event delegation. 'currentTarget' is set to
* the element that matched the selector string filter or the Node returned
* from the filter function. 'container' is set to the element that the
* listener is delegated from (this normally would be the 'currentTarget').
*
* Filter functions will be called with the arguments that would be passed to
* the callback function, including the event object as the first parameter.
* The function should return false (or a falsey value) if the success criteria
* aren't met, and the Node to use as the event's currentTarget and 'this'
* object if they are.
*
* @method delegate
* @param type {string} the event type to delegate
* @param fn {function} the callback function to execute. This function
* will be provided the event object for the delegated event.
* @param el {string|node} the element that is the delegation container
* @param filter {string|function} a selector that must match the target of the
* event or a function that returns a Node or false.
* @param context optional argument that specifies what 'this' refers to.
* @param args* 0..n additional arguments to pass on to the callback function.
* These arguments will be added after the event object.
* @return {EventHandle} the detach handle
* @for YUI
*/
Y.delegate = Y.Event.delegate = delegate;
}, '@VERSION@' ,{requires:['node-base']});
YUI.add('event-synthetic', function(Y) {
/**
* Define new DOM events that can be subscribed to from Nodes.
*
* @module event
* @submodule event-synthetic
*/
var DOMMap = Y.Env.evt.dom_map,
toArray = Y.Array,
YLang = Y.Lang,
isObject = YLang.isObject,
isString = YLang.isString,
query = Y.Selector.query,
noop = function () {};
/**
* <p>The triggering mechanism used by SyntheticEvents.</p>
*
* <p>Implementers should not instantiate these directly. Use the Notifier
* provided to the event's implemented <code>on(node, sub, notifier)</code> or
* <code>delegate(node, sub, notifier, filter)</code> methods.</p>
*
* @class SyntheticEvent.Notifier
* @constructor
* @param handle {EventHandle} the detach handle for the subscription to an
* internal custom event used to execute the callback passed to
* on(..) or delegate(..)
* @param emitFacade {Boolean} take steps to ensure the first arg received by
* the subscription callback is an event facade
* @private
* @since 3.2.0
*/
function Notifier(handle, emitFacade) {
this.handle = handle;
this.emitFacade = emitFacade;
}
/**
* <p>Executes the subscription callback, passing the firing arguments as the
* first parameters to that callback. For events that are configured with
* emitFacade=true, it is common practice to pass the triggering DOMEventFacade
* as the first parameter. Barring a proper DOMEventFacade or EventFacade
* (from a CustomEvent), a new EventFacade will be generated. In that case, if
* fire() is called with a simple object, it will be mixed into the facade.
* Otherwise, the facade will be prepended to the callback parameters.</p>
*
* <p>For notifiers provided to delegate logic, the first argument should be an
* object with a &quot;currentTarget&quot; property to identify what object to
* default as 'this' in the callback. Typically this is gleaned from the
* DOMEventFacade or EventFacade, but if configured with emitFacade=false, an
* object must be provided. In that case, the object will be removed from the
* callback parameters.</p>
*
* <p>Additional arguments passed during event subscription will be
* automatically added after those passed to fire().</p>
*
* @method fire
* @param e {EventFacade|DOMEventFacade|Object|any} (see description)
* @param arg* {any} additional arguments received by all subscriptions
* @private
*/
Notifier.prototype.fire = function (e) {
// first arg to delegate notifier should be an object with currentTarget
var args = toArray(arguments, 0, true),
handle = this.handle,
ce = handle.evt,
sub = handle.sub,
thisObj = sub.context,
delegate = sub.filter,
event = e || {};
if (this.emitFacade) {
if (!e || !e.preventDefault) {
event = ce._getFacade();
if (isObject(e) && !e.preventDefault) {
Y.mix(event, e, true);
args[0] = event;
} else {
args.unshift(event);
}
}
event.type = ce.type;
event.details = args.slice();
if (delegate) {
event.container = ce.host;
}
} else if (delegate && isObject(e) && e.currentTarget) {
args.shift();
}
sub.context = thisObj || event.currentTarget || ce.host;
ce.fire.apply(ce, args);
sub.context = thisObj; // reset for future firing
};
/**
* <p>Wrapper class for the integration of new events into the YUI event
* infrastructure. Don't instantiate this object directly, use
* <code>Y.Event.define(type, config)</code>. See that method for details.</p>
*
* <p>Properties that MAY or SHOULD be specified in the configuration are noted
* below and in the description of <code>Y.Event.define</code>.</p>
*
* @class SyntheticEvent
* @constructor
* @param cfg {Object} Implementation pieces and configuration
* @since 3.1.0
* @in event-synthetic
*/
function SyntheticEvent() {
this._init.apply(this, arguments);
}
Y.mix(SyntheticEvent, {
Notifier: Notifier,
/**
* Returns the array of subscription handles for a node for the given event
* type. Passing true as the third argument will create a registry entry
* in the event system's DOM map to host the array if one doesn't yet exist.
*
* @method getRegistry
* @param node {Node} the node
* @param type {String} the event
* @param create {Boolean} create a registration entry to host a new array
* if one doesn't exist.
* @return {Array}
* @static
* @protected
* @since 3.2.0
*/
getRegistry: function (node, type, create) {
var el = node._node,
yuid = Y.stamp(el),
key = 'event:' + yuid + type + '_synth',
events = DOMMap[yuid] || (DOMMap[yuid] = {});
if (!events[key] && create) {
events[key] = {
type : '_synth',
fn : noop,
capture : false,
el : el,
key : key,
domkey : yuid,
notifiers : [],
detachAll : function () {
var notifiers = this.notifiers,
i = notifiers.length;
while (--i >= 0) {
notifiers[i].detach();
}
}
};
}
return (events[key]) ? events[key].notifiers : null;
},
/**
* Alternate <code>_delete()</code> method for the CustomEvent object
* created to manage SyntheticEvent subscriptions.
*
* @method _deleteSub
* @param sub {Subscription} the subscription to clean up
* @private
* @since 3.2.0
*/
_deleteSub: function (sub) {
if (sub && sub.fn) {
var synth = this.eventDef,
method = (sub.filter) ? 'detachDelegate' : 'detach';
this.subscribers = {};
this.subCount = 0;
synth[method](sub.node, sub, this.notifier, sub.filter);
synth._unregisterSub(sub);
delete sub.fn;
delete sub.node;
delete sub.context;
}
},
prototype: {
constructor: SyntheticEvent,
/**
* Construction logic for the event.
*
* @method _init
* @protected
*/
_init: function () {
var config = this.publishConfig || (this.publishConfig = {});
// The notification mechanism handles facade creation
this.emitFacade = ('emitFacade' in config) ?
config.emitFacade :
true;
config.emitFacade = false;
},
/**
* <p>Implementers MAY provide this method definition.</p>
*
* <p>Implement this function if the event supports a different
* subscription signature. This function is used by both
* <code>on()</code> and <code>delegate()</code>. The second parameter
* indicates that the event is being subscribed via
* <code>delegate()</code>.</p>
*
* <p>Implementations must remove extra arguments from the args list
* before returning. The required args for <code>on()</code>
* subscriptions are</p>
* <pre><code>[type, callback, target, context, argN...]</code></pre>
*
* <p>The required args for <code>delegate()</code>
* subscriptions are</p>
*
* <pre><code>[type, callback, target, filter, context, argN...]</code></pre>
*
* <p>The return value from this function will be stored on the
* subscription in the '_extra' property for reference elsewhere.</p>
*
* @method processArgs
* @param args {Array} parmeters passed to Y.on(..) or Y.delegate(..)
* @param delegate {Boolean} true if the subscription is from Y.delegate
* @return {any}
*/
processArgs: noop,
/**
* <p>Implementers MAY override this property.</p>
*
* <p>Whether to prevent multiple subscriptions to this event that are
* classified as being the same. By default, this means the subscribed
* callback is the same function. See the <code>subMatch</code>
* method. Setting this to true will impact performance for high volume
* events.</p>
*
* @property preventDups
* @type {Boolean}
* @default false
*/
//preventDups : false,
/**
* <p>Implementers SHOULD provide this method definition.</p>
*
* Implementation logic for subscriptions done via <code>node.on(type,
* fn)</code> or <code>Y.on(type, fn, target)</code>. This
* function should set up the monitor(s) that will eventually fire the
* event. Typically this involves subscribing to at least one DOM
* event. It is recommended to store detach handles from any DOM
* subscriptions to make for easy cleanup in the <code>detach</code>
* method. Typically these handles are added to the <code>sub</code>
* object. Also for SyntheticEvents that leverage a single DOM
* subscription under the hood, it is recommended to pass the DOM event
* object to <code>notifier.fire(e)</code>. (The event name on the
* object will be updated).
*
* @method on
* @param node {Node} the node the subscription is being applied to
* @param sub {Subscription} the object to track this subscription
* @param notifier {SyntheticEvent.Notifier} call notifier.fire(..) to
* trigger the execution of the subscribers
*/
on: noop,
/**
* <p>Implementers SHOULD provide this method definition.</p>
*
* <p>Implementation logic for detaching subscriptions done via
* <code>node.on(type, fn)</code>. This function should clean up any
* subscriptions made in the <code>on()</code> phase.</p>
*
* @method detach
* @param node {Node} the node the subscription was applied to
* @param sub {Subscription} the object tracking this subscription
* @param notifier {SyntheticEvent.Notifier} the Notifier used to
* trigger the execution of the subscribers
*/
detach: noop,
/**
* <p>Implementers SHOULD provide this method definition.</p>
*
* <p>Implementation logic for subscriptions done via
* <code>node.delegate(type, fn, filter)</code> or
* <code>Y.delegate(type, fn, container, filter)</code>. Like with
* <code>on()</code> above, this function should monitor the environment
* for the event being fired, and trigger subscription execution by
* calling <code>notifier.fire(e)</code>.</p>
*
* <p>This function receives a fourth argument, which is the filter
* used to identify which Node's are of interest to the subscription.
* The filter will be either a boolean function that accepts a target
* Node for each hierarchy level as the event bubbles, or a selector
* string. To translate selector strings into filter functions, use
* <code>Y.delegate.compileFilter(filter)</code>.</p>
*
* @method delegate
* @param node {Node} the node the subscription is being applied to
* @param sub {Subscription} the object to track this subscription
* @param notifier {SyntheticEvent.Notifier} call notifier.fire(..) to
* trigger the execution of the subscribers
* @param filter {String|Function} Selector string or function that
* accepts an event object and returns null, a Node, or an
* array of Nodes matching the criteria for processing.
* @since 3.2.0
*/
delegate : noop,
/**
* <p>Implementers SHOULD provide this method definition.</p>
*
* <p>Implementation logic for detaching subscriptions done via
* <code>node.delegate(type, fn, filter)</code> or
* <code>Y.delegate(type, fn, container, filter)</code>. This function
* should clean up any subscriptions made in the
* <code>delegate()</code> phase.</p>
*
* @method detachDelegate
* @param node {Node} the node the subscription was applied to
* @param sub {Subscription} the object tracking this subscription
* @param notifier {SyntheticEvent.Notifier} the Notifier used to
* trigger the execution of the subscribers
* @param filter {String|Function} Selector string or function that
* accepts an event object and returns null, a Node, or an
* array of Nodes matching the criteria for processing.
* @since 3.2.0
*/
detachDelegate : noop,
/**
* Sets up the boilerplate for detaching the event and facilitating the
* execution of subscriber callbacks.
*
* @method _on
* @param args {Array} array of arguments passed to
* <code>Y.on(...)</code> or <code>Y.delegate(...)</code>
* @param delegate {Boolean} true if called from
* <code>Y.delegate(...)</code>
* @return {EventHandle} the detach handle for this subscription
* @private
* since 3.2.0
*/
_on: function (args, delegate) {
var handles = [],
selector = args[2],
method = delegate ? 'delegate' : 'on',
nodes, handle;
// Can't just use Y.all because it doesn't support window (yet?)
nodes = (isString(selector)) ? query(selector) : toArray(selector);
if (!nodes.length && isString(selector)) {
handle = Y.on('available', function () {
Y.mix(handle, Y[method].apply(Y, args), true);
}, selector);
return handle;
}
Y.each(nodes, function (node) {
var subArgs = args.slice(),
extra, filter;
node = Y.one(node);
if (node) {
extra = this.processArgs(subArgs, delegate);
if (delegate) {
filter = subArgs.splice(3, 1)[0];
}
// (type, fn, el, thisObj, ...) => (fn, thisObj, ...)
subArgs.splice(0, 4, subArgs[1], subArgs[3]);
if (!this.preventDups || !this.getSubs(node, args,null,true)) {
handle = this._getNotifier(node, subArgs, extra,filter);
this[method](node, handle.sub, handle.notifier, filter);
handles.push(handle);
}
}
}, this);
return (handles.length === 1) ?
handles[0] :
new Y.EventHandle(handles);
},
/**
* Creates a new Notifier object for use by this event's
* <code>on(...)</code> or <code>delegate(...)</code> implementation.
*
* @method _getNotifier
* @param node {Node} the Node hosting the event
* @param args {Array} the subscription arguments passed to either
* <code>Y.on(...)</code> or <code>Y.delegate(...)</code>
* after running through <code>processArgs(args)</code> to
* normalize the argument signature
* @param extra {any} Extra data parsed from
* <code>processArgs(args)</code>
* @param filter {String|Function} the selector string or function
* filter passed to <code>Y.delegate(...)</code> (not
* present when called from <code>Y.on(...)</code>)
* @return {SyntheticEvent.Notifier}
* @private
* @since 3.2.0
*/
_getNotifier: function (node, args, extra, filter) {
var dispatcher = new Y.CustomEvent(this.type, this.publishConfig),
handle = dispatcher.on.apply(dispatcher, args),
notifier = new Notifier(handle, this.emitFacade),
registry = SyntheticEvent.getRegistry(node, this.type, true),
sub = handle.sub;
handle.notifier = notifier;
sub.node = node;
sub.filter = filter;
sub._extra = extra;
Y.mix(dispatcher, {
eventDef : this,
notifier : notifier,
host : node, // I forget what this is for
currentTarget: node, // for generating facades
target : node, // for generating facades
el : node._node, // For category detach
_delete : SyntheticEvent._deleteSub
}, true);
registry.push(handle);
return handle;
},
/**
* Removes the subscription from the Notifier registry.
*
* @method _unregisterSub
* @param sub {Subscription} the subscription
* @private
* @since 3.2.0
*/
_unregisterSub: function (sub) {
var notifiers = SyntheticEvent.getRegistry(sub.node, this.type),
i;
if (notifiers) {
for (i = notifiers.length - 1; i >= 0; --i) {
if (notifiers[i].sub === sub) {
notifiers.splice(i, 1);
break;
}
}
}
},
/**
* Removes the subscription(s) from the internal subscription dispatch
* mechanism. See <code>SyntheticEvent._deleteSub</code>.
*
* @method _detach
* @param args {Array} The arguments passed to
* <code>node.detach(...)</code>
* @private
* @since 3.2.0
*/
_detach: function (args) {
// Can't use Y.all because it doesn't support window (yet?)
// TODO: Does Y.all support window now?
var target = args[2],
els = (isString(target)) ?
query(target) : toArray(target),
node, i, len, handles, j;
// (type, fn, el, context, filter?) => (type, fn, context, filter?)
args.splice(2, 1);
for (i = 0, len = els.length; i < len; ++i) {
node = Y.one(els[i]);
if (node) {
handles = this.getSubs(node, args);
if (handles) {
for (j = handles.length - 1; j >= 0; --j) {
handles[j].detach();
}
}
}
}
},
/**
* Returns the detach handles of subscriptions on a node that satisfy a
* search/filter function. By default, the filter used is the
* <code>subMatch</code> method.
*
* @method getSubs
* @param node {Node} the node hosting the event
* @param args {Array} the array of original subscription args passed
* to <code>Y.on(...)</code> (before
* <code>processArgs</code>
* @param filter {Function} function used to identify a subscription
* for inclusion in the returned array
* @param first {Boolean} stop after the first match (used to check for
* duplicate subscriptions)
* @return {Array} detach handles for the matching subscriptions
*/
getSubs: function (node, args, filter, first) {
var notifiers = SyntheticEvent.getRegistry(node, this.type),
handles = [],
i, len, handle;
if (notifiers) {
if (!filter) {
filter = this.subMatch;
}
for (i = 0, len = notifiers.length; i < len; ++i) {
handle = notifiers[i];
if (filter.call(this, handle.sub, args)) {
if (first) {
return handle;
} else {
handles.push(notifiers[i]);
}
}
}
}
return handles.length && handles;
},
/**
* <p>Implementers MAY override this to define what constitutes a
* &quot;same&quot; subscription. Override implementations should
* consider the lack of a comparator as a match, so calling
* <code>getSubs()</code> with no arguments will return all subs.</p>
*
* <p>Compares a set of subscription arguments against a Subscription
* object to determine if they match. The default implementation
* compares the callback function against the second argument passed to
* <code>Y.on(...)</code> or <code>node.detach(...)</code> etc.</p>
*
* @method subMatch
* @param sub {Subscription} the existing subscription
* @param args {Array} the calling arguments passed to
* <code>Y.on(...)</code> etc.
* @return {Boolean} true if the sub can be described by the args
* present
* @since 3.2.0
*/
subMatch: function (sub, args) {
// Default detach cares only about the callback matching
return !args[1] || sub.fn === args[1];
}
}
}, true);
Y.SyntheticEvent = SyntheticEvent;
/**
* <p>Defines a new event in the DOM event system. Implementers are
* responsible for monitoring for a scenario whereby the event is fired. A
* notifier object is provided to the functions identified below. When the
* criteria defining the event are met, call notifier.fire( [args] ); to
* execute event subscribers.</p>
*
* <p>The first parameter is the name of the event. The second parameter is a
* configuration object which define the behavior of the event system when the
* new event is subscribed to or detached from. The methods that should be
* defined in this configuration object are <code>on</code>,
* <code>detach</code>, <code>delegate</code>, and <code>detachDelegate</code>.
* You are free to define any other methods or properties needed to define your
* event. Be aware, however, that since the object is used to subclass
* SyntheticEvent, you should avoid method names used by SyntheticEvent unless
* your intention is to override the default behavior.</p>
*
* <p>This is a list of properties and methods that you can or should specify
* in the configuration object:</p>
*
* <dl>
* <dt><code>on</code></dt>
* <dd><code>function (node, subscription, notifier)</code> The
* implementation logic for subscription. Any special setup you need to
* do to create the environment for the event being fired--E.g. native
* DOM event subscriptions. Store subscription related objects and
* state on the <code>subscription</code> object. When the
* criteria have been met to fire the synthetic event, call
* <code>notifier.fire(e)</code>. See Notifier's <code>fire()</code>
* method for details about what to pass as parameters.</dd>
*
* <dt><code>detach</code></dt>
* <dd><code>function (node, subscription, notifier)</code> The
* implementation logic for cleaning up a detached subscription. E.g.
* detach any DOM subscriptions added in <code>on</code>.</dd>
*
* <dt><code>delegate</code></dt>
* <dd><code>function (node, subscription, notifier, filter)</code> The
* implementation logic for subscription via <code>Y.delegate</code> or
* <code>node.delegate</code>. The filter is typically either a selector
* string or a function. You can use
* <code>Y.delegate.compileFilter(selectorString)</code> to create a
* filter function from a selector string if needed. The filter function
* expects an event object as input and should output either null, a
* matching Node, or an array of matching Nodes. Otherwise, this acts
* like <code>on</code> DOM event subscriptions. Store subscription
* related objects and information on the <code>subscription</code>
* object. When the criteria have been met to fire the synthetic event,
* call <code>notifier.fire(e)</code> as noted above.</dd>
*
* <dt><code>detachDelegate</code></dt>
* <dd><code>function (node, subscription, notifier)</code> The
* implementation logic for cleaning up a detached delegate subscription.
* E.g. detach any DOM delegate subscriptions added in
* <code>delegate</code>.</dd>
*
* <dt><code>publishConfig</code></dt>
* <dd>(Object) The configuration object that will be used to instantiate
* the underlying CustomEvent. See Notifier's <code>fire</code> method
* for details.</dd>
*
* <dt><code>processArgs</code></dt
* <dd>
* <p><code>function (argArray, fromDelegate)</code> Optional method
* to extract any additional arguments from the subscription
* signature. Using this allows <code>on</code> or
* <code>delegate</code> signatures like
* <code>node.on(&quot;hover&quot;, overCallback,
* outCallback)</code>.</p>
* <p>When processing an atypical argument signature, make sure the
* args array is returned to the normal signature before returning
* from the function. For example, in the &quot;hover&quot; example
* above, the <code>outCallback</code> needs to be <code>splice</code>d
* out of the array. The expected signature of the args array for
* <code>on()</code> subscriptions is:</p>
* <pre>
* <code>[type, callback, target, contextOverride, argN...]</code>
* </pre>
* <p>And for <code>delegate()</code>:</p>
* <pre>
* <code>[type, callback, target, filter, contextOverride, argN...]</code>
* </pre>
* <p>where <code>target</code> is the node the event is being
* subscribed for. You can see these signatures documented for
* <code>Y.on()</code> and <code>Y.delegate()</code> respectively.</p>
* <p>Whatever gets returned from the function will be stored on the
* <code>subscription</code> object under
* <code>subscription._extra</code>.</p></dd>
* <dt><code>subMatch</code></dt>
* <dd>
* <p><code>function (sub, args)</code> Compares a set of
* subscription arguments against a Subscription object to determine
* if they match. The default implementation compares the callback
* function against the second argument passed to
* <code>Y.on(...)</code> or <code>node.detach(...)</code> etc.</p>
* </dd>
* </dl>
*
* @method Event.define
* @param type {String} the name of the event
* @param config {Object} the prototype definition for the new event (see above)
* @param force {Boolean} override an existing event (use with caution)
* @static
* @return {SyntheticEvent} the subclass implementation instance created to
* handle event subscriptions of this type
* @for Event
* @since 3.1.0
* @in event-synthetic
*/
Y.Event.define = function (type, config, force) {
if (!config) {
config = {};
}
var eventDef = (isObject(type)) ? type : Y.merge({ type: type }, config),
Impl, synth;
if (force || !Y.Node.DOM_EVENTS[eventDef.type]) {
Impl = function () {
SyntheticEvent.apply(this, arguments);
};
Y.extend(Impl, SyntheticEvent, eventDef);
synth = new Impl();
type = synth.type;
Y.Node.DOM_EVENTS[type] = Y.Env.evt.plugins[type] = {
eventDef: synth,
on: function () {
return synth._on(toArray(arguments));
},
delegate: function () {
return synth._on(toArray(arguments), true);
},
detach: function () {
return synth._detach(toArray(arguments));
}
};
}
return synth;
};
}, '@VERSION@' ,{requires:['node-base', 'event-custom']});
YUI.add('event-mousewheel', function(Y) {
/**
* Adds mousewheel event support
* @module event
* @submodule event-mousewheel
*/
var DOM_MOUSE_SCROLL = 'DOMMouseScroll',
fixArgs = function(args) {
var a = Y.Array(args, 0, true), target;
if (Y.UA.gecko) {
a[0] = DOM_MOUSE_SCROLL;
target = Y.config.win;
} else {
target = Y.config.doc;
}
if (a.length < 3) {
a[2] = target;
} else {
a.splice(2, 0, target);
}
return a;
};
/**
* Mousewheel event. This listener is automatically attached to the
* correct target, so one should not be supplied. Mouse wheel
* direction and velocity is stored in the 'mouseDelta' field.
* @event mousewheel
* @param type {string} 'mousewheel'
* @param fn {function} the callback to execute
* @param context optional context object
* @param args 0..n additional arguments to provide to the listener.
* @return {EventHandle} the detach handle
* @for YUI
*/
Y.Env.evt.plugins.mousewheel = {
on: function() {
return Y.Event._attach(fixArgs(arguments));
},
detach: function() {
return Y.Event.detach.apply(Y.Event, fixArgs(arguments));
}
};
}, '@VERSION@' ,{requires:['node-base']});
YUI.add('event-mouseenter', function(Y) {
/**
* <p>Adds subscription and delegation support for mouseenter and mouseleave
* events. Unlike mouseover and mouseout, these events aren't fired from child
* elements of a subscribed node.</p>
*
* <p>This avoids receiving three mouseover notifications from a setup like</p>
*
* <pre><code>div#container > p > a[href]</code></pre>
*
* <p>where</p>
*
* <pre><code>Y.one('#container').on('mouseover', callback)</code></pre>
*
* <p>When the mouse moves over the link, one mouseover event is fired from
* #container, then when the mouse moves over the p, another mouseover event is
* fired and bubbles to #container, causing a second notification, and finally
* when the mouse moves over the link, a third mouseover event is fired and
* bubbles to #container for a third notification.</p>
*
* <p>By contrast, using mouseenter instead of mouseover, the callback would be
* executed only once when the mouse moves over #container.</p>
*
* @module event
* @submodule event-mouseenter
*/
function notify(e, notifier) {
var current = e.currentTarget,
related = e.relatedTarget;
if (current !== related && !current.contains(related)) {
notifier.fire(e);
}
}
var config = {
proxyType: "mouseover",
on: function (node, sub, notifier) {
sub.onHandle = node.on(this.proxyType, notify, null, notifier);
},
detach: function (node, sub) {
sub.onHandle.detach();
},
delegate: function (node, sub, notifier, filter) {
sub.delegateHandle =
Y.delegate(this.proxyType, notify, node, filter, null, notifier);
},
detachDelegate: function (node, sub) {
sub.delegateHandle.detach();
}
};
Y.Event.define("mouseenter", config, true);
Y.Event.define("mouseleave", Y.merge(config, { proxyType: "mouseout" }), true);
}, '@VERSION@' ,{requires:['event-synthetic']});
YUI.add('event-key', function(Y) {
/**
* Functionality to listen for one or more specific key combinations.
* @module event
* @submodule event-key
*/
/**
* Add a key listener. The listener will only be notified if the
* keystroke detected meets the supplied specification. The
* spec consists of the key event type, followed by a colon,
* followed by zero or more comma separated key codes, followed
* by zero or more modifiers delimited by a plus sign. Ex:
* press:12,65+shift+ctrl
* @event key
* @for YUI
* @param type {string} 'key'
* @param fn {function} the function to execute
* @param id {string|HTMLElement|collection} the element(s) to bind
* @param spec {string} the keyCode and modifier specification
* @param o optional context object
* @param args 0..n additional arguments to provide to the listener.
* @return {Event.Handle} the detach handle
*/
Y.Env.evt.plugins.key = {
on: function(type, fn, id, spec, o) {
var a = Y.Array(arguments, 0, true), parsed, etype, criteria, ename;
parsed = spec && spec.split(':');
if (!spec || spec.indexOf(':') == -1 || !parsed[1]) {
Y.log('Illegal key spec, creating a regular keypress listener instead.', 'info', 'event');
a[0] = 'key' + ((parsed && parsed[0]) || 'press');
return Y.on.apply(Y, a);
}
// key event type: 'down', 'up', or 'press'
etype = parsed[0];
// list of key codes optionally followed by modifiers
criteria = (parsed[1]) ? parsed[1].split(/,|\+/) : null;
// the name of the custom event that will be created for the spec
ename = (Y.Lang.isString(id) ? id : Y.stamp(id)) + spec;
ename = ename.replace(/,/g, '_');
if (!Y.getEvent(ename)) {
// subscribe spec validator to the DOM event
Y.on(type + etype, function(e) {
// Y.log('keylistener: ' + e.keyCode);
var passed = false, failed = false, i, crit, critInt;
for (i=0; i<criteria.length; i=i+1) {
crit = criteria[i];
critInt = parseInt(crit, 10);
// pass this section if any supplied keyCode
// is found
if (Y.Lang.isNumber(critInt)) {
if (e.charCode === critInt) {
// Y.log('passed: ' + crit);
passed = true;
} else {
failed = true;
// Y.log('failed: ' + crit);
}
// only check modifier if no keyCode was specified
// or the keyCode check was successful. pass only
// if every modifier passes
} else if (passed || !failed) {
passed = (e[crit + 'Key']);
failed = !passed;
// Y.log(crit + ": " + passed);
}
}
// fire spec custom event if spec if met
if (passed) {
Y.fire(ename, e);
}
}, id);
}
// subscribe supplied listener to custom event for spec validator
// remove element and spec.
a.splice(2, 2);
a[0] = ename;
return Y.on.apply(Y, a);
}
};
}, '@VERSION@' ,{requires:['node-base']});
YUI.add('event-focus', function(Y) {
/**
* Adds bubbling and delegation support to DOM events focus and blur.
*
* @module event
* @submodule event-focus
*/
var Event = Y.Event,
YLang = Y.Lang,
isString = YLang.isString,
useActivate = YLang.isFunction(
Y.DOM.create('<p onbeforeactivate=";">').onbeforeactivate);
function define(type, proxy, directEvent) {
var nodeDataKey = '_' + type + 'Notifiers';
Y.Event.define(type, {
_attach: function (el, notifier, delegate) {
if (Y.DOM.isWindow(el)) {
return Event._attach([type, function (e) {
notifier.fire(e);
}, el]);
} else {
return Event._attach(
[proxy, this._proxy, el, this, notifier, delegate],
{ capture: true });
}
},
_proxy: function (e, notifier, delegate) {
var node = e.target,
notifiers = node.getData(nodeDataKey),
yuid = Y.stamp(e.currentTarget._node),
defer = (useActivate || e.target !== e.currentTarget),
sub = notifier.handle.sub,
filterArgs = [node, e].concat(sub.args || []),
directSub;
notifier.currentTarget = (delegate) ? node : e.currentTarget;
notifier.container = (delegate) ? e.currentTarget : null;
if (!sub.filter || sub.filter.apply(node, filterArgs)) {
// Maintain a list to handle subscriptions from nested
// containers div#a>div#b>input #a.on(focus..) #b.on(focus..),
// use one focus or blur subscription that fires notifiers from
// #b then #a to emulate bubble sequence.
if (!notifiers) {
notifiers = {};
node.setData(nodeDataKey, notifiers);
// only subscribe to the element's focus if the target is
// not the current target (
if (defer) {
directSub = Event._attach(
[directEvent, this._notify, node._node]).sub;
directSub.once = true;
}
}
if (!notifiers[yuid]) {
notifiers[yuid] = [];
}
notifiers[yuid].push(notifier);
if (!defer) {
this._notify(e);
}
}
},
_notify: function (e, container) {
var node = e.currentTarget,
notifiers = node.getData(nodeDataKey),
// document.get('ownerDocument') returns null
doc = node.get('ownerDocument') || node,
target = node,
nots = [],
notifier, i, len;
if (notifiers) {
// Walk up the parent axis until the origin node,
while (target && target !== doc) {
nots.push.apply(nots, notifiers[Y.stamp(target)] || []);
target = target.get('parentNode');
}
nots.push.apply(nots, notifiers[Y.stamp(doc)] || []);
for (i = 0, len = nots.length; i < len; ++i) {
notifier = nots[i];
e.currentTarget = nots[i].currentTarget;
if (notifier.container) {
e.container = notifier.container;
} else {
delete e.container;
}
notifier.fire(e);
}
// clear the notifications list (mainly for delegation)
node.clearData(nodeDataKey);
}
},
on: function (node, sub, notifier) {
sub.onHandle = this._attach(node._node, notifier);
},
detach: function (node, sub) {
sub.onHandle.detach();
},
delegate: function (node, sub, notifier, filter) {
if (isString(filter)) {
sub.filter = Y.delegate.compileFilter(filter);
}
sub.delegateHandle = this._attach(node._node, notifier, true);
},
detachDelegate: function (node, sub) {
sub.delegateHandle.detach();
}
}, true);
}
// For IE, we need to defer to focusin rather than focus because
// `el.focus(); doSomething();` executes el.onbeforeactivate, el.onactivate,
// el.onfocusin, doSomething, then el.onfocus. All others support capture
// phase focus, which executes before doSomething. To guarantee consistent
// behavior for this use case, IE's direct subscriptions are made against
// focusin so subscribers will be notified before js following el.focus() is
// executed.
if (useActivate) {
// name capture phase direct subscription
define("focus", "beforeactivate", "focusin");
define("blur", "beforedeactivate", "focusout");
} else {
define("focus", "focus", "focus");
define("blur", "blur", "blur");
}
}, '@VERSION@' ,{requires:['event-synthetic']});
YUI.add('event-resize', function(Y) {
/**
* Adds a window resize event that has its behavior normalized to fire at the
* end of the resize rather than constantly during the resize.
* @module event
* @submodule event-resize
*/
(function() {
var detachHandle,
timerHandle,
CE_NAME = 'window:resize',
handler = function(e) {
if (Y.UA.gecko) {
Y.fire(CE_NAME, e);
} else {
if (timerHandle) {
timerHandle.cancel();
}
timerHandle = Y.later(Y.config.windowResizeDelay || 40, Y, function() {
Y.fire(CE_NAME, e);
});
}
};
/**
* Firefox fires the window resize event once when the resize action
* finishes, other browsers fire the event periodically during the
* resize. This code uses timeout logic to simulate the Firefox
* behavior in other browsers.
* @event windowresize
* @for YUI
*/
Y.Env.evt.plugins.windowresize = {
on: function(type, fn) {
// check for single window listener and add if needed
if (!detachHandle) {
detachHandle = Y.Event._attach(['resize', handler]);
}
var a = Y.Array(arguments, 0, true);
a[0] = CE_NAME;
return Y.on.apply(Y, a);
}
};
})();
}, '@VERSION@' ,{requires:['node-base']});
YUI.add('event', function(Y){}, '@VERSION@' ,{use:['event-base', 'event-delegate', 'event-synthetic', 'event-mousewheel', 'event-mouseenter', 'event-key', 'event-focus', 'event-resize']});