Did some minor tidying up.
[jquery.git] / src / event / event.js
index e0d4b90..5d8e89a 100644 (file)
@@ -12,42 +12,71 @@ jQuery.event = {
                // around, causing it to be cloned in the process
                if ( jQuery.browser.msie && element.setInterval != undefined )
                        element = window;
-
-               // if data is passed, bind to handler
-               if( data ) 
-                       handler.data = data;
-
+               
                // Make sure that the function being executed has a unique ID
                if ( !handler.guid )
                        handler.guid = this.guid++;
+                       
+               // if data is passed, bind to handler 
+               if( data != undefined ) { 
+               // Create temporary function pointer to original handler 
+                       var fn = handler; 
+
+                       // Create unique handler function, wrapped around original handler 
+                       handler = function() { 
+                               // Pass arguments and context to original handler 
+                               return fn.apply(this, arguments); 
+                       };
+
+                       // Store data in unique handler 
+                       handler.data = data;
+
+                       // Set the guid of unique handler to the same of original handler, so it can be removed 
+                       handler.guid = fn.guid;
+               }
 
                // Init the element's event structure
                if (!element.$events)
                        element.$events = {};
+               
+               if (!element.$handle)
+                       element.$handle = function() {
+                               // returned undefined or false
+                               var val;
+
+                               // Handle the second event of a trigger and when
+                               // an event is called after a page has unloaded
+                               if ( typeof jQuery == "undefined" || jQuery.event.triggered )
+                                 return val;
+                               
+                               val = jQuery.event.handle.apply(element, arguments);
+                               
+                               return val;
+                       };
 
                // Get the current list of functions bound to this event
                var handlers = element.$events[type];
 
-               // If it hasn't been initialized yet
+               // Init the event handler queue
                if (!handlers) {
-                       // Init the event handler queue
-                       handlers = element.$events[type] = {};
-
-                       // Remember an existing handler, if it's already there
-                       if (element["on" + type])
-                               handlers[0] = element["on" + type];
+                       handlers = element.$events[type] = {};  
+                       
+                       // And bind the global event handler to the element
+                       if (element.addEventListener)
+                               element.addEventListener(type, element.$handle, false);
+                       else
+                               element.attachEvent("on" + type, element.$handle);
                }
 
                // Add the function to the element's handler list
                handlers[handler.guid] = handler;
 
-               // And bind the global event handler to the element
-               element["on" + type] = this.handle;
-
                // Remember the function in a global list (for triggering)
                if (!this.global[type])
                        this.global[type] = [];
-               this.global[type].push( element );
+               // Only add the element to the global list once
+               if (jQuery.inArray(element, this.global[type]) == -1)
+                       this.global[type].push( element );
        },
 
        guid: 1,
@@ -55,7 +84,7 @@ jQuery.event = {
 
        // Detach an event or set of events from an element
        remove: function(element, type, handler) {
-               var events = element.$events, ret;
+               var events = element.$events, ret, index;
 
                if ( events ) {
                        // type is actually an event object here
@@ -81,15 +110,23 @@ jQuery.event = {
                                // remove generic event handler if no more handlers exist
                                for ( ret in events[type] ) break;
                                if ( !ret ) {
-                                       ret = element["on" + type] = null;
+                                       if (element.removeEventListener)
+                                               element.removeEventListener(type, element.$handle, false);
+                                       else
+                                               element.detachEvent("on" + type, element.$handle);
+                                       ret = null;
                                        delete events[type];
+                                       
+                                       // Remove element from the global event type cache
+                                       while ( this.global[type] && ( (index = jQuery.inArray(element, this.global[type])) >= 0 ) )
+                                               delete this.global[type][index];
                                }
                        }
 
                        // Remove the expando if it's no longer used
                        for ( ret in events ) break;
                        if ( !ret )
-                               element.$events = null;
+                               element.$handle = element.$events = null;
                }
        },
 
@@ -105,19 +142,16 @@ jQuery.event = {
 
                // Handle triggering a single element
                else {
-                       var handler = element["on" + type ], val,
-                               fn = jQuery.isFunction( element[ type ] );
+                       var val, ret, fn = jQuery.isFunction( element[ type ] || null );
+                       
+                       // Pass along a fake event
+                       data.unshift( this.fix({ type: type, target: element }) );
 
-                       if ( handler ) {
-                               // Pass along a fake event
-                               data.unshift( this.fix({ type: type, target: element }) );
-       
-                               // Trigger the event
-                               if ( (val = handler.apply( element, data )) !== false )
-                                       this.triggered = true;
-                       }
+                       // Trigger the event
+                       if ( jQuery.isFunction(element.$handle) && (val = element.$handle.apply( element, data )) !== false )
+                               this.triggered = true;
 
-                       if ( fn && val !== false )
+                       if ( fn && val !== false && !jQuery.nodeName(element, 'a') )
                                element[ type ]();
 
                        this.triggered = false;
@@ -125,19 +159,13 @@ jQuery.event = {
        },
 
        handle: function(event) {
-               // Handle the second event of a trigger and when
-               // an event is called after a page has unloaded
-               if ( typeof jQuery == "undefined" || jQuery.event.triggered ) return;
+               // returned undefined or false
+               var val;
 
                // Empty object is for triggered events with no data
                event = jQuery.event.fix( event || window.event || {} ); 
 
-               // returned undefined or false
-               var returnValue;
-
-               var c = this.$events[event.type];
-
-               var args = [].slice.call( arguments, 1 );
+               var c = this.$events && this.$events[event.type], args = [].slice.call( arguments, 1 );
                args.unshift( event );
 
                for ( var j in c ) {
@@ -149,58 +177,72 @@ jQuery.event = {
                        if ( c[j].apply( this, args ) === false ) {
                                event.preventDefault();
                                event.stopPropagation();
-                               returnValue = false;
+                               val = false;
                        }
                }
 
                // Clean up added properties in IE to prevent memory leak
-               if (jQuery.browser.msie) event.target = event.preventDefault = event.stopPropagation = event.handler = event.data = null;
+               if (jQuery.browser.msie)
+                       event.target = event.preventDefault = event.stopPropagation =
+                               event.handler = event.data = null;
 
-               return returnValue;
+               return val;
        },
 
        fix: function(event) {
+               // store a copy of the original event object 
+               // and clone to set read-only properties
+               var originalEvent = event;
+               event = jQuery.extend({}, originalEvent);
+               
+               // add preventDefault and stopPropagation since 
+               // they will not work on the clone
+               event.preventDefault = function() {
+                       // if preventDefault exists run it on the original event
+                       if (originalEvent.preventDefault)
+                               return originalEvent.preventDefault();
+                       // otherwise set the returnValue property of the original event to false (IE)
+                       originalEvent.returnValue = false;
+               };
+               event.stopPropagation = function() {
+                       // if stopPropagation exists run it on the original event
+                       if (originalEvent.stopPropagation)
+                               return originalEvent.stopPropagation();
+                       // otherwise set the cancelBubble property of the original event to true (IE)
+                       originalEvent.cancelBubble = true;
+               };
+               
                // Fix target property, if necessary
                if ( !event.target && event.srcElement )
                        event.target = event.srcElement;
+                               
+               // check if target is a textnode (safari)
+               if (jQuery.browser.safari && event.target.nodeType == 3)
+                       event.target = originalEvent.target.parentNode;
+
+               // Add relatedTarget, if necessary
+               if ( !event.relatedTarget && event.fromElement )
+                       event.relatedTarget = event.fromElement == event.target ? event.toElement : event.fromElement;
 
                // Calculate pageX/Y if missing and clientX/Y available
-               if ( event.pageX == undefined && event.clientX != undefined ) {
+               if ( event.pageX == null && event.clientX != null ) {
                        var e = document.documentElement, b = document.body;
-                       event.pageX = event.clientX + (e.scrollLeft || b.scrollLeft);
-                       event.pageY = event.clientY + (e.scrollTop || b.scrollTop);
+                       event.pageX = event.clientX + (e && e.scrollLeft || b.scrollLeft);
+                       event.pageY = event.clientY + (e && e.scrollTop || b.scrollTop);
                }
-                               
-               // check if target is a textnode (safari)
-               if (jQuery.browser.safari && event.target.nodeType == 3) {
-                       // store a copy of the original event object 
-                       // and clone because target is read only
-                       var originalEvent = event;
-                       event = jQuery.extend({}, originalEvent);
                        
-                       // get parentnode from textnode
-                       event.target = originalEvent.target.parentNode;
-                       
-                       // add preventDefault and stopPropagation since 
-                       // they will not work on the clone
-                       event.preventDefault = function() {
-                               return originalEvent.preventDefault();
-                       };
-                       event.stopPropagation = function() {
-                               return originalEvent.stopPropagation();
-                       };
-               }
+               // Add which for key events
+               if ( !event.which && (event.charCode || event.keyCode) )
+                       event.which = event.charCode || event.keyCode;
                
-               // fix preventDefault and stopPropagation
-               if (!event.preventDefault)
-                       event.preventDefault = function() {
-                               this.returnValue = false;
-                       };
-                       
-               if (!event.stopPropagation)
-                       event.stopPropagation = function() {
-                               this.cancelBubble = true;
-                       };
+               // Add metaKey to non-Mac browsers (use ctrl for PC's and Meta for Macs)
+               if ( !event.metaKey && event.ctrlKey )
+                       event.metaKey = event.ctrlKey;
+
+               // Add which for click: 1 == left; 2 == middle; 3 == right
+               // Note: button is not normalized, so don't use it
+               if ( !event.which && event.button )
+                       event.which = (event.button & 1 ? 1 : ( event.button & 2 ? 3 : ( event.button & 4 ? 2 : 0 ) ));
                        
                return event;
        }
@@ -219,6 +261,9 @@ jQuery.fn.extend({
         * data as the second parameter (and the handler function as the third), see 
         * second example.
         *
+        * Calling bind with an event type of "unload" will automatically
+        * use the one method instead of bind to prevent memory leaks.
+        *
         * @example $("p").bind("click", function(){
         *   alert( $(this).text() );
         * });
@@ -255,8 +300,8 @@ jQuery.fn.extend({
         * @cat Events
         */
        bind: function( type, data, fn ) {
-               return this.each(function(){
-                       jQuery.event.add( this, type, fn || data, data );
+               return type == "unload" ? this.one(type, data, fn) : this.each(function(){
+                       jQuery.event.add( this, type, fn || data, fn && data );
                });
        },
        
@@ -264,7 +309,7 @@ jQuery.fn.extend({
         * Binds a handler to a particular event (like click) for each matched element.
         * The handler is executed only once for each element. Otherwise, the same rules
         * as described in bind() apply.
-        The event handler is passed an event object that you can use to prevent
+        * The event handler is passed an event object that you can use to prevent
         * default behaviour. To stop both default action and event bubbling, your handler
         * has to return false.
         *
@@ -291,7 +336,7 @@ jQuery.fn.extend({
                        jQuery.event.add( this, type, function(event) {
                                jQuery(this).unbind(event);
                                return (fn || data).apply( this, arguments);
-                       }, data);
+                       }, fn && data);
                });
        },
 
@@ -394,7 +439,7 @@ jQuery.fn.extend({
 
                return this.click(function(e) {
                        // Figure out which function to execute
-                       this.lastToggle = this.lastToggle == 0 ? 1 : 0;
+                       this.lastToggle = 0 == this.lastToggle ? 1 : 0;
                        
                        // Make sure that clicks stop
                        e.preventDefault();
@@ -434,7 +479,7 @@ jQuery.fn.extend({
                // A private function for handling mouse 'hovering'
                function handleHover(e) {
                        // Check if mouse(over|out) are still within the same parent element
-                       var p = (e.type == "mouseover" ? e.fromElement : e.toElement) || e.relatedTarget;
+                       var p = e.relatedTarget;
        
                        // Traverse up the tree
                        while ( p && p != this ) try { p = p.parentNode } catch(e) { p = this; };
@@ -494,10 +539,9 @@ jQuery.fn.extend({
                        f.apply( document, [jQuery] );
                        
                // Otherwise, remember the function for later
-               else {
+               else
                        // Add the function to the wait list
                        jQuery.readyList.push( function() { return f.apply(this, [jQuery]) } );
-               }
        
                return this;
        }
@@ -527,9 +571,13 @@ jQuery.extend({
                                // Reset the list of functions
                                jQuery.readyList = null;
                        }
-                       // Remove event lisenter to avoid memory leak
+                       // Remove event listener to avoid memory leak
                        if ( jQuery.browser.mozilla || jQuery.browser.opera )
                                document.removeEventListener( "DOMContentLoaded", jQuery.ready, false );
+                       
+                       // Remove script element used by IE hack
+                       if( !window.frames.length ) // don't remove if frames are present (#1187)
+                               jQuery(window).load(function(){ jQuery("#__ie_init").remove(); });
                }
        }
 });
@@ -907,7 +955,6 @@ new function(){
                if ( script ) 
                        script.onreadystatechange = function() {
                                if ( this.readyState != "complete" ) return;
-                               this.parentNode.removeChild( this );
                                jQuery.ready();
                        };
        
@@ -944,7 +991,7 @@ if (jQuery.browser.msie)
                        var els = global[type], i = els.length;
                        if ( i && type != 'unload' )
                                do
-                                       jQuery.event.remove(els[i-1], type);
+                                       els[i-1] && jQuery.event.remove(els[i-1], type);
                                while (--i);
                }
        });