src/event.js

   1 /*
   2  * A number of helper functions used for managing events.
   3  * Many of the ideas behind this code originated 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 ( elem.setInterval && elem != window )
  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 = this.proxy( fn, 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
  38                 // Init the element's event structure
  39                 var events = jQuery.data(elem, "events") || jQuery.data(elem, "events", {}),
  40                         handle = jQuery.data(elem, "handle") || jQuery.data(elem, "handle", function(){
  41                                 // Handle the second event of a trigger and when
  42                                 // an event is called after a page has unloaded
  43                                 return typeof jQuery !== "undefined" && !jQuery.event.triggered ?
  44                                         jQuery.event.handle.apply(arguments.callee.elem, arguments) :
  45                                         undefined;
  46                         });
  47                 // Add elem as a property of the handle function
  48                 // This is to prevent a memory leak with non-native
  49                 // event in IE.
  50                 handle.elem = elem;
  51
  52                 // Handle multiple events separated by a space
  53                 // jQuery(...).bind("mouseover mouseout", fn);
  54                 jQuery.each(types.split(/\s+/), function(index, type) {
  55                         // Namespaced event handlers
  56                         var namespaces = type.split(".");
  57                         type = namespaces.shift();
  58                         handler.type = namespaces.slice().sort().join(".");
  59
  60                         // Get the current list of functions bound to this event
  61                         var handlers = events[type];
  62
  63                         if ( jQuery.event.specialAll[type] )
  64                                 jQuery.event.specialAll[type].setup.call(elem, data, namespaces);
  65
  66                         // Init the event handler queue
  67                         if (!handlers) {
  68                                 handlers = events[type] = {};
  69
  70                                 // Check for a special event handler
  71                                 // Only use addEventListener/attachEvent if the special
  72                                 // events handler returns false
  73                                 if ( !jQuery.event.special[type] || jQuery.event.special[type].setup.call(elem, data, namespaces) === false ) {
  74                                         // Bind the global event handler to the element
  75                                         if (elem.addEventListener)
  76                                                 elem.addEventListener(type, handle, false);
  77                                         else if (elem.attachEvent)
  78                                                 elem.attachEvent("on" + type, handle);
  79                                 }
  80                         }
  81
  82                         // Add the function to the element's handler list
  83                         handlers[handler.guid] = handler;
  84
  85                         // Keep track of which events have been used, for global triggering
  86                         jQuery.event.global[type] = true;
  87                 });
  88
  89                 // Nullify elem to prevent memory leaks in IE
  90                 elem = null;
  91         },
  92
  93         guid: 1,
  94         global: {},
  95
  96         // Detach an event or set of events from an element
  97         remove: function(elem, types, handler) {
  98                 // don't do events on text and comment nodes
  99                 if ( elem.nodeType == 3 || elem.nodeType == 8 )
 100                         return;
 101
 102                 var events = jQuery.data(elem, "events"), ret, index;
 103
 104                 if ( events ) {
 105                         // Unbind all events for the element
 106                         if ( types === undefined || (typeof types === "string" && types.charAt(0) == ".") )
 107                                 for ( var type in events )
 108                                         this.remove( elem, type + (types || "") );
 109                         else {
 110                                 // types is actually an event object here
 111                                 if ( types.type ) {
 112                                         handler = types.handler;
 113                                         types = types.type;
 114                                 }
 115
 116                                 // Handle multiple events seperated by a space
 117                                 // jQuery(...).unbind("mouseover mouseout", fn);
 118                                 jQuery.each(types.split(/\s+/), function(index, type){
 119                                         // Namespaced event handlers
 120                                         var namespaces = type.split(".");
 121                                         type = namespaces.shift();
 122                                         var namespace = RegExp("(^|\\.)" + namespaces.slice().sort().join(".*\\.") + "(\\.|$)");
 123
 124                                         if ( events[type] ) {
 125                                                 // remove the given handler for the given type
 126                                                 if ( handler )
 127                                                         delete events[type][handler.guid];
 128
 129                                                 // remove all handlers for the given type
 130                                                 else
 131                                                         for ( handler in events[type] )
 132                                                                 // Handle the removal of namespaced events
 133                                                                 if ( namespace.test(events[type][handler].type) )
 134                                                                         delete events[type][handler];
 135
 136                                                 if ( jQuery.event.specialAll[type] )
 137                                                         jQuery.event.specialAll[type].teardown.call(elem, namespaces);
 138
 139                                                 // remove generic event handler if no more handlers exist
 140                                                 for ( ret in events[type] ) break;
 141                                                 if ( !ret ) {
 142                                                         if ( !jQuery.event.special[type] || jQuery.event.special[type].teardown.call(elem, namespaces) === false ) {
 143                                                                 if (elem.removeEventListener)
 144                                                                         elem.removeEventListener(type, jQuery.data(elem, "handle"), false);
 145                                                                 else if (elem.detachEvent)
 146                                                                         elem.detachEvent("on" + type, jQuery.data(elem, "handle"));
 147                                                         }
 148                                                         ret = null;
 149                                                         delete events[type];
 150                                                 }
 151                                         }
 152                                 });
 153                         }
 154
 155                         // Remove the expando if it's no longer used
 156                         for ( ret in events ) break;
 157                         if ( !ret ) {
 158                                 var handle = jQuery.data( elem, "handle" );
 159                                 if ( handle ) handle.elem = null;
 160                                 jQuery.removeData( elem, "events" );
 161                                 jQuery.removeData( elem, "handle" );
 162                         }
 163                 }
 164         },
 165
 166         trigger: function( e, data, elem, donative, extra, dohandlers) {
 167                 // Event object or event type
 168                 var type = e.type || e;
 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.each( jQuery.cache, function(){
 175                                         if ( this.events && this.events[type] )
 176                                                 jQuery.event.trigger( e, data, this.handle.elem, false );
 177                                 });
 178
 179                 // Handle triggering a single element
 180                 } else {
 181
 182                         // don't do events on text and comment nodes
 183                         if ( elem.nodeType == 3 || elem.nodeType == 8 )
 184                                 return undefined;
 185
 186                         // Clone the incoming data, if any
 187                         data = jQuery.makeArray(data);
 188
 189                         if ( type.indexOf("!") >= 0 ) {
 190                                 type = type.slice(0, -1);
 191                                 var exclusive = true;
 192                         }
 193
 194                         e = typeof e === "object" ?
 195                                 // jQuery.Event object
 196                                 e[expando] ? e :
 197                                 // Object literal
 198                                 jQuery.extend( new jQuery.Event(type), e ) :
 199                                 // Just the event type (string)
 200                                 new jQuery.Event(type);
 201
 202                         e.target = e.target || elem;
 203                         e.currentTarget = elem;
 204                         e.exclusive = exclusive;
 205
 206                         data.unshift( e );
 207
 208                         var val, ret, fn = jQuery.isFunction( elem[ type ] );
 209
 210                         if ( dohandlers !== false ) {
 211                                 // Trigger the event, it is assumed that "handle" is a function
 212                                 var handle = jQuery.data(elem, "handle");
 213                                 if ( handle )
 214                                         val = handle.apply( elem, data );
 215
 216                                 // Handle triggering native .onfoo handlers (and on links since we don't call .click() for links)
 217                                 if ( (!fn || (jQuery.nodeName(elem, 'a') && type == "click")) && elem["on"+type] && elem["on"+type].apply( elem, data ) === false )
 218                                         val = false;
 219                         }
 220
 221                         if ( donative !== false && val !== false ) {
 222                                 var parent = elem.parentNode || elem.ownerDocument;
 223                                 if ( parent )
 224                                         jQuery.event.trigger(e, data, parent, donative);
 225                         }
 226
 227                         // Extra functions don't get the custom event object
 228                         data.shift();
 229
 230                         // Handle triggering of extra function
 231                         if ( extra && jQuery.isFunction( extra ) ) {
 232                                 // call the extra function and tack the current return value on the end for possible inspection
 233                                 ret = extra.apply( elem, val == null ? data : data.concat( val ) );
 234                                 // if anything is returned, give it precedence and have it overwrite the previous value
 235                                 if ( ret !== undefined )
 236                                         val = ret;
 237                         }
 238
 239                         // Trigger the native events (except for clicks on links)
 240                         if ( fn && donative !== false && val !== false && !(jQuery.nodeName(elem, 'a') && type == "click") ) {
 241                                 this.triggered = true;
 242                                 try {
 243                                         elem[ type ]();
 244                                 // prevent IE from throwing an error for some hidden elements
 245                                 } catch (e) {}
 246                         }
 247
 248                         this.triggered = false;
 249                 }
 250
 251                 return val;
 252         },
 253
 254         handle: function(event) {
 255                 // returned undefined or false
 256                 var val, ret, all, handlers;
 257
 258                 event = arguments[0] = jQuery.event.fix( event || window.event );
 259
 260                 // Namespaced event handlers
 261                 var namespaces = event.type.split(".");
 262                 event.type = namespaces.shift();
 263
 264                 // Cache this now, all = true means, any handler
 265                 all = !namespaces.length && !event.exclusive;
 266
 267                 var namespace = RegExp("(^|\\.)" + namespaces.slice().sort().join(".*\\.") + "(\\.|$)");
 268
 269                 handlers = ( jQuery.data(this, "events") || {} )[event.type];
 270
 271                 for ( var j in handlers ) {
 272                         var handler = handlers[j];
 273
 274                         // Filter the functions by class
 275                         if ( all || namespace.test(handler.type) ) {
 276                                 // Pass in a reference to the handler function itself
 277                                 // So that we can later remove it
 278                                 event.handler = handler;
 279                                 event.data = handler.data;
 280
 281                                 ret = handler.apply( this, arguments );
 282
 283                                 if ( val !== false )
 284                                         val = ret;
 285
 286                                 if ( ret === false ) {
 287                                         event.preventDefault();
 288                                         event.stopPropagation();
 289                                 }
 290
 291                                 if( event._sip )
 292                                         break;
 293
 294                         }
 295                 }
 296
 297                 return val;
 298         },
 299
 300         props: "altKey attrChange attrName bubbles button cancelable charCode clientX clientY ctrlKey currentTarget data detail eventPhase fromElement handler keyCode metaKey newValue originalTarget pageX pageY prevValue relatedNode relatedTarget screenX screenY shiftKey srcElement target toElement view wheelDelta which".split(" "),
 301
 302         fix: function(event) {
 303                 if ( event[expando] )
 304                         return event;
 305
 306                 // store a copy of the original event object
 307                 // and "clone" to set read-only properties
 308                 var originalEvent = event;
 309                 event = new jQuery.Event( originalEvent );
 310
 311                 for ( var i = this.props.length, prop; i; ){
 312                         prop = this.props[ --i ];
 313                         event[ prop ] = originalEvent[ prop ];
 314                 }
 315
 316                 // Fix target property, if necessary
 317                 if ( !event.target )
 318                         event.target = event.srcElement || document; // Fixes #1925 where srcElement might not be defined either
 319
 320                 // check if target is a textnode (safari)
 321                 if ( event.target.nodeType == 3 )
 322                         event.target = event.target.parentNode;
 323
 324                 // Add relatedTarget, if necessary
 325                 if ( !event.relatedTarget && event.fromElement )
 326                         event.relatedTarget = event.fromElement == event.target ? event.toElement : event.fromElement;
 327
 328                 // Calculate pageX/Y if missing and clientX/Y available
 329                 if ( event.pageX == null && event.clientX != null ) {
 330                         var doc = document.documentElement, body = document.body;
 331                         event.pageX = event.clientX + (doc && doc.scrollLeft || body && body.scrollLeft || 0) - (doc.clientLeft || 0);
 332                         event.pageY = event.clientY + (doc && doc.scrollTop || body && body.scrollTop || 0) - (doc.clientTop || 0);
 333                 }
 334
 335                 // Add which for key events
 336                 if ( !event.which && ((event.charCode || event.charCode === 0) ? event.charCode : event.keyCode) )
 337                         event.which = event.charCode || event.keyCode;
 338
 339                 // Add metaKey to non-Mac browsers (use ctrl for PC's and Meta for Macs)
 340                 if ( !event.metaKey && event.ctrlKey )
 341                         event.metaKey = event.ctrlKey;
 342
 343                 // Add which for click: 1 == left; 2 == middle; 3 == right
 344                 // Note: button is not normalized, so don't use it
 345                 if ( !event.which && event.button )
 346                         event.which = (event.button & 1 ? 1 : ( event.button & 2 ? 3 : ( event.button & 4 ? 2 : 0 ) ));
 347
 348                 return event;
 349         },
 350
 351         proxy: function( fn, proxy ){
 352                 // Set the guid of unique handler to the same of original handler, so it can be removed
 353                 proxy.guid = fn.guid = fn.guid || proxy.guid || this.guid++;
 354                 // So proxy can be declared as an argument
 355                 return proxy;
 356         },
 357
 358         special: {
 359                 ready: {
 360                         // Make sure the ready event is setup
 361                         setup: bindReady,
 362                         teardown: function() {}
 363                 }
 364         },
 365
 366         specialAll: {
 367                 live: {
 368                         setup: function( selector, namespaces ){
 369                                 jQuery.event.add( this, namespaces[0], liveHandler );
 370                         },
 371                         teardown:  function( namespaces ){
 372                                 if ( namespaces.length ) {
 373                                         var remove = 0, name = RegExp("(^|\\.)" + namespaces[0] + "(\\.|$)");
 374
 375                                         jQuery.each( (jQuery.data(this, "events").live || {}), function(){
 376                                                 if ( name.test(this.type) )
 377                                                         remove++;
 378                                         });
 379
 380                                         if ( remove <= 1 )
 381                                                 jQuery.event.remove( this, namespaces[0], liveHandler );
 382                                 }
 383                         }
 384                 }
 385         }
 386 };
 387
 388 jQuery.Event = function( src ){
 389         // Event object
 390         if( src && src.type ){
 391                 this.originalEvent = src;
 392                 this.type = src.type;
 393
 394                 // Fix timeStamp
 395                 this.timeStamp = src.timeStamp || now();
 396         // Event type
 397         }else
 398                 this.type = src;
 399
 400         // Mark it as fixed
 401         this[expando] = true;
 402 };
 403
 404 jQuery.Event.prototype = {
 405         // add preventDefault and stopPropagation since
 406         // they will not work on the clone
 407         preventDefault: function() {
 408                 var e = this.originalEvent;
 409                 if( !e )
 410                         return;
 411                 // if preventDefault exists run it on the original event
 412                 if (e.preventDefault)
 413                         e.preventDefault();
 414                 // otherwise set the returnValue property of the original event to false (IE)
 415                 e.returnValue = false;
 416         },
 417         stopPropagation: function() {
 418                 var e = this.originalEvent;
 419                 if( !e )
 420                         return;
 421                 // if stopPropagation exists run it on the original event
 422                 if (e.stopPropagation)
 423                         e.stopPropagation();
 424                 // otherwise set the cancelBubble property of the original event to true (IE)
 425                 e.cancelBubble = true;
 426         },
 427         stopImmediatePropagation:function(){
 428                 this._sip = true;
 429                 this.stopPropagation();
 430         }
 431 };
 432 // Checks if an event happened on an element within another element
 433 // Used in jQuery.event.special.mouseenter and mouseleave handlers
 434 var withinElement = function(event) {
 435         // Check if mouse(over|out) are still within the same parent element
 436         var parent = event.relatedTarget;
 437         // Traverse up the tree
 438         while ( parent && parent != this )
 439                 try { parent = parent.parentNode; }
 440                 catch(e) { parent = this; }
 441
 442         if( parent != this ){
 443                 // set the correct event type
 444                 event.type = event.data;
 445                 // handle event if we actually just moused on to a non sub-element
 446                 jQuery.event.handle.apply( this, arguments );
 447         }
 448 };
 449
 450 jQuery.each({
 451         mouseover: 'mouseenter',
 452         mouseout: 'mouseleave'
 453 }, function( orig, fix ){
 454         jQuery.event.special[ fix ] = {
 455                 setup: function(){
 456                         jQuery.event.add( this, orig, withinElement, fix );
 457                 },
 458                 teardown: function(){
 459                         jQuery.event.remove( this, orig, withinElement );
 460                 }
 461         };
 462 });
 463
 464 jQuery.fn.extend({
 465         bind: function( type, data, fn ) {
 466                 return type == "unload" ? this.one(type, data, fn) : this.each(function(){
 467                         jQuery.event.add( this, type, fn || data, fn && data );
 468                 });
 469         },
 470
 471         one: function( type, data, fn ) {
 472                 var one = jQuery.event.proxy( fn || data, function(event) {
 473                         jQuery(this).unbind(event, one);
 474                         return (fn || data).apply( this, arguments );
 475                 });
 476                 return this.each(function(){
 477                         jQuery.event.add( this, type, one, fn && data);
 478                 });
 479         },
 480
 481         unbind: function( type, fn ) {
 482                 return this.each(function(){
 483                         jQuery.event.remove( this, type, fn );
 484                 });
 485         },
 486
 487         trigger: function( type, data, fn ) {
 488                 return this.each(function(){
 489                         jQuery.event.trigger( type, data, this, true, fn );
 490                 });
 491         },
 492
 493         triggerHandler: function( type, data, fn ) {
 494                 return this[0] && jQuery.event.trigger( type, data, this[0], false, fn );
 495         },
 496
 497         toggle: function( fn ) {
 498                 // Save reference to arguments for access in closure
 499                 var args = arguments, i = 1;
 500
 501                 // link all the functions, so any of them can unbind this click handler
 502                 while( i < args.length )
 503                         jQuery.event.proxy( fn, args[i++] );
 504
 505                 return this.click( jQuery.event.proxy( fn, function(event) {
 506                         // Figure out which function to execute
 507                         this.lastToggle = ( this.lastToggle || 0 ) % i;
 508
 509                         // Make sure that clicks stop
 510                         event.preventDefault();
 511
 512                         // and execute the function
 513                         return args[ this.lastToggle++ ].apply( this, arguments ) || false;
 514                 }));
 515         },
 516
 517         hover: function(fnOver, fnOut) {
 518                 return this.mouseenter(fnOver).mouseleave(fnOut);
 519         },
 520
 521         ready: function(fn) {
 522                 // Attach the listeners
 523                 bindReady();
 524
 525                 // If the DOM is already ready
 526                 if ( jQuery.isReady )
 527                         // Execute the function immediately
 528                         fn.call( document, jQuery );
 529
 530                 // Otherwise, remember the function for later
 531                 else
 532                         // Add the function to the wait list
 533                         jQuery.readyList.push( function() { return fn.call(this, jQuery); } );
 534
 535                 return this;
 536         },
 537
 538         live: function( type, fn ){
 539                 jQuery(document).bind( liveConvert(type, this.selector), this.selector, fn );
 540                 return this;
 541         },
 542
 543         die: function( type, fn ){
 544                 jQuery(document).unbind( liveConvert(type, this.selector), fn );
 545                 return this;
 546         }
 547 });
 548
 549 function liveHandler( event ){
 550         var check = RegExp("(^|\\.)" + event.type + "(\\.|$)");
 551         jQuery.each(jQuery.data(this, "events").live || [], function(i, fn){
 552                 if ( check.test(fn.type) ) {
 553                         var elem = jQuery(event.target).closest(fn.data)[0];
 554                         if ( elem )
 555                                 jQuery.event.trigger( event.type, fn.data, elem, false, fn, false );
 556                 }
 557         });
 558 }
 559
 560 function liveConvert(type, selector){
 561         return ["live", type, selector.replace(/\./g, "_")].join(".");
 562 }
 563
 564 jQuery.extend({
 565         isReady: false,
 566         readyList: [],
 567         // Handle when the DOM is ready
 568         ready: function() {
 569                 // Make sure that the DOM is not already loaded
 570                 if ( !jQuery.isReady ) {
 571                         // Remember that the DOM is ready
 572                         jQuery.isReady = true;
 573
 574                         // If there are functions bound, to execute
 575                         if ( jQuery.readyList ) {
 576                                 // Execute all of them
 577                                 jQuery.each( jQuery.readyList, function(){
 578                                         this.call( document );
 579                                 });
 580
 581                                 // Reset the list of functions
 582                                 jQuery.readyList = null;
 583                         }
 584
 585                         // Trigger any bound ready events
 586                         jQuery(document).triggerHandler("ready");
 587                 }
 588         }
 589 });
 590
 591 var readyBound = false;
 592
 593 function bindReady(){
 594         if ( readyBound ) return;
 595         readyBound = true;
 596
 597         // Mozilla, Opera and webkit nightlies currently support this event
 598         if ( document.addEventListener ) {
 599                 // Use the handy event callback
 600                 document.addEventListener( "DOMContentLoaded", function(){
 601                         document.removeEventListener( "DOMContentLoaded", arguments.callee, false );
 602                         jQuery.ready();
 603                 }, false );
 604
 605         // If IE event model is used
 606         } else if ( document.attachEvent ) {
 607                 // ensure firing before onload,
 608                 // maybe late but safe also for iframes
 609                 document.attachEvent("onreadystatechange", function(){
 610                         if ( document.readyState === "complete" ) {
 611                                 document.detachEvent( "onreadystatechange", arguments.callee );
 612                                 jQuery.ready();
 613                         }
 614                 });
 615
 616                 // If IE and not an iframe
 617                 // continually check to see if the document is ready
 618                 if ( document.documentElement.doScroll && !window.frameElement ) (function(){
 619                         if ( jQuery.isReady ) return;
 620
 621                         try {
 622                                 // If IE is used, use the trick by Diego Perini
 623                                 // http://javascript.nwbox.com/IEContentLoaded/
 624                                 document.documentElement.doScroll("left");
 625                         } catch( error ) {
 626                                 setTimeout( arguments.callee, 0 );
 627                                 return;
 628                         }
 629
 630                         // and execute any waiting functions
 631                         jQuery.ready();
 632                 })();
 633         }
 634
 635         // A fallback to window.onload, that will always work
 636         jQuery.event.add( window, "load", jQuery.ready );
 637 }
 638
 639 jQuery.each( ("blur,focus,load,resize,scroll,unload,click,dblclick," +
 640         "mousedown,mouseup,mousemove,mouseover,mouseout,mouseenter,mouseleave," +
 641         "change,select,submit,keydown,keypress,keyup,error").split(","), function(i, name){
 642
 643         // Handle event binding
 644         jQuery.fn[name] = function(fn){
 645                 return fn ? this.bind(name, fn) : this.trigger(name);
 646         };
 647 });
 648
 649 // Prevent memory leaks in IE
 650 // And prevent errors on refresh with events like mouseover in other browsers
 651 // Window isn't included so as not to unbind existing unload events
 652 jQuery( window ).bind( 'unload', function(){
 653         for ( var id in jQuery.cache )
 654                 // Skip the window
 655                 if ( id != 1 && jQuery.cache[ id ].handle )
 656                         jQuery.event.remove( jQuery.cache[ id ].handle.elem );
 657 });