src/event.js

   1 /*
   2  * A number of helper functions used for managing events.
   3  * Many of the ideas behind this code orignated from
   4  * Dean Edwards' addEvent library.
   5  */
   6 jQuery.event = {
   7
   8         // Bind an event to an element
   9         // Original by Dean Edwards
  10         add: function(elem, types, handler, data) {
  11                 if ( elem.nodeType == 3 || elem.nodeType == 8 )
  12                         return;
  13
  14                 // For whatever reason, IE has trouble passing the window object
  15                 // around, causing it to be cloned in the process
  16                 if ( jQuery.browser.msie && elem.setInterval != undefined )
  17                         elem = window;
  18
  19                 // Make sure that the function being executed has a unique ID
  20                 if ( !handler.guid )
  21                         handler.guid = this.guid++;
  22
  23                 // if data is passed, bind to handler
  24                 if( data != undefined ) {
  25                         // Create temporary function pointer to original handler
  26                         var fn = handler;
  27
  28                         // Create unique handler function, wrapped around original handler
  29                         handler = function() {
  30                                 // Pass arguments and context to original handler
  31                                 return fn.apply(this, arguments);
  32                         };
  33
  34                         // Store data in unique handler
  35                         handler.data = data;
  36
  37                         // Set the guid of unique handler to the same of original handler, so it can be removed
  38                         handler.guid = fn.guid;
  39                 }
  40
  41                 // Init the element's event structure
  42                 var events = jQuery.data(elem, "events") || jQuery.data(elem, "events", {}),
  43                         handle = jQuery.data(elem, "handle") || jQuery.data(elem, "handle", function(){
  44                                 // Handle the second event of a trigger and when
  45                                 // an event is called after a page has unloaded
  46                                 if ( typeof jQuery != "undefined" && !jQuery.event.triggered )
  47                                         return jQuery.event.handle.apply(arguments.callee.elem, arguments);
  48                         });
  49                 // Add elem as a property of the handle function
  50                 // This is to prevent a memory leak with non-native
  51                 // event in IE.
  52                 handle.elem = elem;
  53
  54                         // Handle multiple events seperated by a space
  55                         // jQuery(...).bind("mouseover mouseout", fn);
  56                         jQuery.each(types.split(/\s+/), function(index, type) {
  57                                 // Namespaced event handlers
  58                                 var parts = type.split(".");
  59                                 type = parts[0];
  60                                 handler.type = parts[1];
  61
  62                                 // Get the current list of functions bound to this event
  63                                 var handlers = events[type];
  64
  65                                 // Init the event handler queue
  66                                 if (!handlers) {
  67                                         handlers = events[type] = {};
  68
  69                                         // Check for a special event handler
  70                                         // Only use addEventListener/attachEvent if the special
  71                                         // events handler returns false
  72                                         if ( !jQuery.event.special[type] || jQuery.event.special[type].setup.call(elem) === false ) {
  73                                                 // Bind the global event handler to the element
  74                                                 if (elem.addEventListener)
  75                                                         elem.addEventListener(type, handle, false);
  76                                                 else if (elem.attachEvent)
  77                                                         elem.attachEvent("on" + type, handle);
  78                                         }
  79                                 }
  80
  81                                 // Add the function to the element's handler list
  82                                 handlers[handler.guid] = handler;
  83
  84                                 // Keep track of which events have been used, for global triggering
  85                                 jQuery.event.global[type] = true;
  86                         });
  87
  88                 // Nullify elem to prevent memory leaks in IE
  89                 elem = null;
  90         },
  91
  92         guid: 1,
  93         global: {},
  94
  95         // Detach an event or set of events from an element
  96         remove: function(elem, types, handler) {
  97                 // don't do events on text and comment nodes
  98                 if ( elem.nodeType == 3 || elem.nodeType == 8 )
  99                         return;
 100
 101                 var events = jQuery.data(elem, "events"), ret, index;
 102
 103                 if ( events ) {
 104                         // Unbind all events for the element
 105                         if ( types == undefined || (typeof types == "string" && types.charAt(0) == ".") )
 106                                 for ( var type in events )
 107                                         this.remove( elem, type + (types || "") );
 108                         else {
 109                                 // types is actually an event object here
 110                                 if ( types.type ) {
 111                                         handler = types.handler;
 112                                         types = types.type;
 113                                 }
 114
 115                                 // Handle multiple events seperated by a space
 116                                 // jQuery(...).unbind("mouseover mouseout", fn);
 117                                 jQuery.each(types.split(/\s+/), function(index, type){
 118                                         // Namespaced event handlers
 119                                         var parts = type.split(".");
 120                                         type = parts[0];
 121
 122                                         if ( events[type] ) {
 123                                                 // remove the given handler for the given type
 124                                                 if ( handler )
 125                                                         delete events[type][handler.guid];
 126
 127                                                 // remove all handlers for the given type
 128                                                 else
 129                                                         for ( handler in events[type] )
 130                                                                 // Handle the removal of namespaced events
 131                                                                 if ( !parts[1] || events[type][handler].type == parts[1] )
 132                                                                         delete events[type][handler];
 133
 134                                                 // remove generic event handler if no more handlers exist
 135                                                 for ( ret in events[type] ) break;
 136                                                 if ( !ret ) {
 137                                                         if ( !jQuery.event.special[type] || jQuery.event.special[type].teardown.call(elem) === false ) {
 138                                                                 if (elem.removeEventListener)
 139                                                                         elem.removeEventListener(type, jQuery.data(elem, "handle"), false);
 140                                                                 else if (elem.detachEvent)
 141                                                                         elem.detachEvent("on" + type, jQuery.data(elem, "handle"));
 142                                                         }
 143                                                         ret = null;
 144                                                         delete events[type];
 145                                                 }
 146                                         }
 147                                 });
 148                         }
 149
 150                         // Remove the expando if it's no longer used
 151                         for ( ret in events ) break;
 152                         if ( !ret ) {
 153                                 var handle = jQuery.data( elem, "handle" );
 154                                 if ( handle ) handle.elem = null;
 155                                 jQuery.removeData( elem, "events" );
 156                                 jQuery.removeData( elem, "handle" );
 157                         }
 158                 }
 159         },
 160
 161         trigger: function(type, data, elem, donative, extra) {
 162                 // Clone the incoming data, if any
 163                 data = jQuery.makeArray(data || []);
 164
 165                 if ( type.indexOf("!") >= 0 ) {
 166                         type = type.slice(0, -1);
 167                         var exclusive = true;
 168                 }
 169
 170                 // Handle a global trigger
 171                 if ( !elem ) {
 172                         // Only trigger if we've ever bound an event for it
 173                         if ( this.global[type] )
 174                                 jQuery("*").add([window, document]).trigger(type, data);
 175
 176                 // Handle triggering a single element
 177                 } else {
 178                         // don't do events on text and comment nodes
 179                         if ( elem.nodeType == 3 || elem.nodeType == 8 )
 180                                 return undefined;
 181
 182                         var val, ret, fn = jQuery.isFunction( elem[ type ] || null ),
 183                                 // Check to see if we need to provide a fake event, or not
 184                                 event = !data[0] || !data[0].preventDefault;
 185
 186                         // Pass along a fake event
 187                         if ( event )
 188                                 data.unshift( this.fix({ type: type, target: elem }) );
 189
 190                         // Enforce the right trigger type
 191                         data[0].type = type;
 192                         if ( exclusive )
 193                                 data[0].exclusive = true;
 194
 195                         // Trigger the event, it is assumed that "handle" is a function
 196                         var handle = jQuery.data(elem, "handle");
 197                         if ( handle )
 198                                 val = handle.apply( elem, data );
 199
 200                         // Handle triggering native .onfoo handlers (and on links since we don't call .click() for links)
 201                         if ( (!fn || (jQuery.nodeName(elem, 'a') && type == "click")) && elem["on"+type] && elem["on"+type].apply( elem, data ) === false )
 202                                 val = false;
 203
 204                         // Extra functions don't get the custom event object
 205                         if ( event )
 206                                 data.shift();
 207
 208                         // Handle triggering of extra function
 209                         if ( extra && jQuery.isFunction( extra ) ) {
 210                                 // call the extra function and tack the current return value on the end for possible inspection
 211                                 ret = extra.apply( elem, val == null ? data : data.concat( val ) );
 212                                 // if anything is returned, give it precedence and have it overwrite the previous value
 213                                 if (ret !== undefined)
 214                                         val = ret;
 215                         }
 216
 217                         // Trigger the native events (except for clicks on links)
 218                         if ( fn && donative !== false && val !== false && !(jQuery.nodeName(elem, 'a') && type == "click") ) {
 219                                 this.triggered = true;
 220                                 try {
 221                                         elem[ type ]();
 222                                 // prevent IE from throwing an error for some hidden elements
 223                                 } catch (e) {}
 224                         }
 225
 226                         this.triggered = false;
 227                 }
 228
 229                 return val;
 230         },
 231
 232         handle: function(event) {
 233                 // returned undefined or false
 234                 var val, namespace, all, handlers;
 235
 236                 event = arguments[0] = jQuery.event.fix( event || window.event );
 237
 238                 // Namespaced event handlers
 239                 namespace = event.type.split(".");
 240                 event.type = namespace[0];
 241                 namespace = namespace[1];
 242                 all = !namespace && !event.exclusive; //cache this now, all = true means, any handler
 243
 244                 handlers = ( jQuery.data(this, "events") || {} )[event.type];
 245
 246                 for ( var j in handlers ) {
 247                         var handler = handlers[j];
 248
 249                         // Filter the functions by class
 250                         if ( all || handler.type == namespace ) {
 251                                 // Pass in a reference to the handler function itself
 252                                 // So that we can later remove it
 253                                 event.handler = handler;
 254                                 event.data = handler.data;
 255
 256                                 val = handler.apply( this, arguments );
 257                         }
 258                 }
 259
 260                 if ( val === false ) {
 261                         event.preventDefault();
 262                         event.stopPropagation();
 263                 }
 264
 265                 // Clean up added properties in IE to prevent memory leak
 266                 if (jQuery.browser.msie)
 267                         event.target = event.preventDefault = event.stopPropagation =
 268                                 event.handler = event.data = null;
 269
 270                 return val;
 271         },
 272
 273         fix: function(event) {
 274                 // store a copy of the original event object
 275                 // and clone to set read-only properties
 276                 var originalEvent = event;
 277                 event = jQuery.extend({}, originalEvent);
 278
 279                 // add preventDefault and stopPropagation since
 280                 // they will not work on the clone
 281                 event.preventDefault = function() {
 282                         // if preventDefault exists run it on the original event
 283                         if (originalEvent.preventDefault)
 284                                 originalEvent.preventDefault();
 285                         // otherwise set the returnValue property of the original event to false (IE)
 286                         originalEvent.returnValue = false;
 287                 };
 288                 event.stopPropagation = function() {
 289                         // if stopPropagation exists run it on the original event
 290                         if (originalEvent.stopPropagation)
 291                                 originalEvent.stopPropagation();
 292                         // otherwise set the cancelBubble property of the original event to true (IE)
 293                         originalEvent.cancelBubble = true;
 294                 };
 295
 296                 // Fix target property, if necessary
 297                 if ( !event.target )
 298                         event.target = event.srcElement || document; // Fixes #1925 where srcElement might not be defined either
 299
 300                 // check if target is a textnode (safari)
 301                 if ( event.target.nodeType == 3 )
 302                         event.target = originalEvent.target.parentNode;
 303
 304                 // Add relatedTarget, if necessary
 305                 if ( !event.relatedTarget && event.fromElement )
 306                         event.relatedTarget = event.fromElement == event.target ? event.toElement : event.fromElement;
 307
 308                 // Calculate pageX/Y if missing and clientX/Y available
 309                 if ( event.pageX == null && event.clientX != null ) {
 310                         var doc = document.documentElement, body = document.body;
 311                         event.pageX = event.clientX + (doc && doc.scrollLeft || body && body.scrollLeft || 0) - (doc.clientLeft || 0);
 312                         event.pageY = event.clientY + (doc && doc.scrollTop || body && body.scrollTop || 0) - (doc.clientTop || 0);
 313                 }
 314
 315                 // Add which for key events
 316                 if ( !event.which && ((event.charCode || event.charCode === 0) ? event.charCode : event.keyCode) )
 317                         event.which = event.charCode || event.keyCode;
 318
 319                 // Add metaKey to non-Mac browsers (use ctrl for PC's and Meta for Macs)
 320                 if ( !event.metaKey && event.ctrlKey )
 321                         event.metaKey = event.ctrlKey;
 322
 323                 // Add which for click: 1 == left; 2 == middle; 3 == right
 324                 // Note: button is not normalized, so don't use it
 325                 if ( !event.which && event.button )
 326                         event.which = (event.button & 1 ? 1 : ( event.button & 2 ? 3 : ( event.button & 4 ? 2 : 0 ) ));
 327
 328                 return event;
 329         },
 330
 331         special: {
 332                 ready: {
 333                         setup: function() {
 334                                 // Make sure the ready event is setup
 335                                 bindReady();
 336                                 return;
 337                         },
 338
 339                         teardown: function() { return; }
 340                 },
 341
 342                 mouseenter: {
 343                         setup: function() {
 344                                 if ( jQuery.browser.msie ) return false;
 345                                 jQuery(this).bind("mouseover", jQuery.event.special.mouseenter.handler);
 346                                 return true;
 347                         },
 348
 349                         teardown: function() {
 350                                 if ( jQuery.browser.msie ) return false;
 351                                 jQuery(this).unbind("mouseover", jQuery.event.special.mouseenter.handler);
 352                                 return true;
 353                         },
 354
 355                         handler: function(event) {
 356                                 // If we actually just moused on to a sub-element, ignore it
 357                                 if ( withinElement(event, this) ) return true;
 358                                 // Execute the right handlers by setting the event type to mouseenter
 359                                 arguments[0].type = "mouseenter";
 360                                 return jQuery.event.handle.apply(this, arguments);
 361                         }
 362                 },
 363
 364                 mouseleave: {
 365                         setup: function() {
 366                                 if ( jQuery.browser.msie ) return false;
 367                                 jQuery(this).bind("mouseout", jQuery.event.special.mouseleave.handler);
 368                                 return true;
 369                         },
 370
 371                         teardown: function() {
 372                                 if ( jQuery.browser.msie ) return false;
 373                                 jQuery(this).unbind("mouseout", jQuery.event.special.mouseleave.handler);
 374                                 return true;
 375                         },
 376
 377                         handler: function(event) {
 378                                 // If we actually just moused on to a sub-element, ignore it
 379                                 if ( withinElement(event, this) ) return true;
 380                                 // Execute the right handlers by setting the event type to mouseleave
 381                                 arguments[0].type = "mouseleave";
 382                                 return jQuery.event.handle.apply(this, arguments);
 383                         }
 384                 }
 385         }
 386 };
 387
 388 jQuery.fn.extend({
 389         bind: function( type, data, fn ) {
 390                 return type == "unload" ? this.one(type, data, fn) : this.each(function(){
 391                         jQuery.event.add( this, type, fn || data, fn && data );
 392                 });
 393         },
 394
 395         one: function( type, data, fn ) {
 396                 return this.each(function(){
 397                         jQuery.event.add( this, type, function(event) {
 398                                 jQuery(this).unbind(event);
 399                                 return (fn || data).apply( this, arguments);
 400                         }, fn && data);
 401                 });
 402         },
 403
 404         unbind: function( type, fn ) {
 405                 return this.each(function(){
 406                         jQuery.event.remove( this, type, fn );
 407                 });
 408         },
 409
 410         trigger: function( type, data, fn ) {
 411                 return this.each(function(){
 412                         jQuery.event.trigger( type, data, this, true, fn );
 413                 });
 414         },
 415
 416         triggerHandler: function( type, data, fn ) {
 417                 if ( this[0] )
 418                         return jQuery.event.trigger( type, data, this[0], false, fn );
 419                 return undefined;
 420         },
 421
 422         toggle: function() {
 423                 // Save reference to arguments for access in closure
 424                 var args = arguments;
 425
 426                 return this.click(function(event) {
 427                         // Figure out which function to execute
 428                         this.lastToggle = 0 == this.lastToggle ? 1 : 0;
 429
 430                         // Make sure that clicks stop
 431                         event.preventDefault();
 432
 433                         // and execute the function
 434                         return args[this.lastToggle].apply( this, arguments ) || false;
 435                 });
 436         },
 437
 438         hover: function(fnOver, fnOut) {
 439                 return this.bind('mouseenter', fnOver).bind('mouseleave', fnOut);
 440         },
 441
 442         ready: function(fn) {
 443                 // Attach the listeners
 444                 bindReady();
 445
 446                 // If the DOM is already ready
 447                 if ( jQuery.isReady )
 448                         // Execute the function immediately
 449                         fn.call( document, jQuery );
 450
 451                 // Otherwise, remember the function for later
 452                 else
 453                         // Add the function to the wait list
 454                         jQuery.readyList.push( function() { return fn.call(this, jQuery); } );
 455
 456                 return this;
 457         }
 458 });
 459
 460 jQuery.extend({
 461         isReady: false,
 462         readyList: [],
 463         // Handle when the DOM is ready
 464         ready: function() {
 465                 // Make sure that the DOM is not already loaded
 466                 if ( !jQuery.isReady ) {
 467                         // Remember that the DOM is ready
 468                         jQuery.isReady = true;
 469
 470                         // If there are functions bound, to execute
 471                         if ( jQuery.readyList ) {
 472                                 // Execute all of them
 473                                 jQuery.each( jQuery.readyList, function(){
 474                                         this.apply( document );
 475                                 });
 476
 477                                 // Reset the list of functions
 478                                 jQuery.readyList = null;
 479                         }
 480
 481                         // Trigger any bound ready events
 482                         jQuery(document).triggerHandler("ready");
 483                 }
 484         }
 485 });
 486
 487 var readyBound = false;
 488
 489 function bindReady(){
 490         if ( readyBound ) return;
 491         readyBound = true;
 492
 493         // Mozilla, Opera (see further below for it) and webkit nightlies currently support this event
 494         if ( document.addEventListener && !jQuery.browser.opera)
 495                 // Use the handy event callback
 496                 document.addEventListener( "DOMContentLoaded", jQuery.ready, false );
 497
 498         // If IE is used and is not in a frame
 499         // Continually check to see if the document is ready
 500         if ( jQuery.browser.msie && window == top ) (function(){
 501                 if (jQuery.isReady) return;
 502                 try {
 503                         // If IE is used, use the trick by Diego Perini
 504                         // http://javascript.nwbox.com/IEContentLoaded/
 505                         document.documentElement.doScroll("left");
 506                 } catch( error ) {
 507                         setTimeout( arguments.callee, 0 );
 508                         return;
 509                 }
 510                 // and execute any waiting functions
 511                 jQuery.ready();
 512         })();
 513
 514         if ( jQuery.browser.opera )
 515                 document.addEventListener( "DOMContentLoaded", function () {
 516                         if (jQuery.isReady) return;
 517                         for (var i = 0; i < document.styleSheets.length; i++)
 518                                 if (document.styleSheets[i].disabled) {
 519                                         setTimeout( arguments.callee, 0 );
 520                                         return;
 521                                 }
 522                         // and execute any waiting functions
 523                         jQuery.ready();
 524                 }, false);
 525
 526         if ( jQuery.browser.safari ) {
 527                 var numStyles;
 528                 (function(){
 529                         if (jQuery.isReady) return;
 530                         if ( document.readyState != "loaded" && document.readyState != "complete" ) {
 531                                 setTimeout( arguments.callee, 0 );
 532                                 return;
 533                         }
 534                         if ( numStyles === undefined )
 535                                 numStyles = jQuery("style, link[rel=stylesheet]").length;
 536                         if ( document.styleSheets.length != numStyles ) {
 537                                 setTimeout( arguments.callee, 0 );
 538                                 return;
 539                         }
 540                         // and execute any waiting functions
 541                         jQuery.ready();
 542                 })();
 543         }
 544
 545         // A fallback to window.onload, that will always work
 546         jQuery.event.add( window, "load", jQuery.ready );
 547 }
 548
 549 jQuery.each( ("blur,focus,load,resize,scroll,unload,click,dblclick," +
 550         "mousedown,mouseup,mousemove,mouseover,mouseout,change,select," +
 551         "submit,keydown,keypress,keyup,error").split(","), function(i, name){
 552
 553         // Handle event binding
 554         jQuery.fn[name] = function(fn){
 555                 return fn ? this.bind(name, fn) : this.trigger(name);
 556         };
 557 });
 558
 559 // Checks if an event happened on an element within another element
 560 // Used in jQuery.event.special.mouseenter and mouseleave handlers
 561 var withinElement = function(event, elem) {
 562         // Check if mouse(over|out) are still within the same parent element
 563         var parent = event.relatedTarget;
 564         // Traverse up the tree
 565         while ( parent && parent != elem ) try { parent = parent.parentNode; } catch(error) { parent = elem; }
 566         // Return true if we actually just moused on to a sub-element
 567         return parent == elem;
 568 };
 569
 570 // Prevent memory leaks in IE
 571 // And prevent errors on refresh with events like mouseover in other browsers
 572 // Window isn't included so as not to unbind existing unload events
 573 jQuery(window).bind("unload", function() {
 574         jQuery("*").add(document).unbind();
 575 });