Triggered event handlers are only executed once now.
[jquery.git] / src / event / event.js
index 1a8a6b5..a948bfc 100644 (file)
@@ -74,28 +74,34 @@ jQuery.event = {
                data = jQuery.makeArray(data || []);
 
                // Handle a global trigger
-               if ( !element ) {
-                       var g = this.global[type];
-                       if ( g )
-                               for ( var i = 0, gl = g.length; i < gl; i++ )
-                                       this.trigger( type, data, g[i] );
+               if ( !element )
+                       jQuery.each( this.global[type] || [], function(){
+                               jQuery.event.trigger( type, data, this );
+                       });
 
                // Handle triggering a single element
-               } else if ( element["on" + type] ) {
-                       if ( element[ type ] && element[ type ].constructor == Function )
-                               element[ type ]();
-                       else {
-                               // Pass along a fake event
-                               data.unshift( this.fix({ type: type, target: element }) );
+               else if ( element["on" + type] ) {
+                       // Pass along a fake event
+                       data.unshift( this.fix({ type: type, target: element }) );
        
-                               // Trigger the event
-                               element["on" + type].apply( element, data );
+                       // Trigger the event
+                       var val = element["on" + type].apply( element, data );
+
+                       if ( val !== false && jQuery.isFunction( element[ type ] ) ) {
+                               this.triggered = true;
+                               element[ type ]();
                        }
                }
        },
 
        handle: function(event) {
-               if ( typeof jQuery == "undefined" ) return false;
+               if ( typeof jQuery == "undefined" ) return;
+
+               // Handle the second event of a trigger
+               if ( jQuery.event.triggered ) {
+                       jQuery.event.triggered = false;
+                       return;
+               }
 
                // Empty object is for triggered events with no data
                event = jQuery.event.fix( event || window.event || {} ); 
@@ -133,14 +139,14 @@ jQuery.event = {
                        event.target = event.srcElement;
 
                // Calculate pageX/Y if missing and clientX/Y available
-               if ( typeof event.pageX == "undefined" && typeof event.clientX != "undefined" ) {
+               if ( event.pageX == undefined && event.clientX != undefined ) {
                        var e = document.documentElement, b = document.body;
                        event.pageX = event.clientX + (e.scrollLeft || b.scrollLeft);
                        event.pageY = event.clientY + (e.scrollTop || b.scrollTop);
                }
                                
                // check if target is a textnode (safari)
-               if (event.target.nodeType == 3) {
+               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;
@@ -187,32 +193,32 @@ jQuery.fn.extend({
         * data as the second paramter (and the handler function as the third), see 
         * second example.
         *
-        * @example $("p").bind( "click", function() {
+        * @example $("p").bind("click", function(){
         *   alert( $(this).text() );
-        * } )
+        * });
         * @before <p>Hello</p>
         * @result alert("Hello")
         *
-        * @example var handler = function(event) {
+        * @example function handler(event) {
         *   alert(event.data.foo);
-        * };
-        * $("p").bind( "click", {foo: "bar"}, handler)
+        * }
+        * $("p").bind("click", {foo: "bar"}, handler)
         * @result alert("bar")
         * @desc Pass some additional data to the event handler.
         *
-        * @example $("form").bind( "submit", function() { return false; } )
+        * @example $("form").bind("submit", function() { return false; })
         * @desc Cancel a default action and prevent it from bubbling by returning false
         * from your function.
         *
-        * @example $("form").bind( "submit", function(event) {
+        * @example $("form").bind("submit", function(event){
         *   event.preventDefault();
-        * } );
+        * });
         * @desc Cancel only the default action by using the preventDefault method.
         *
         *
-        * @example $("form").bind( "submit", function(event) {
+        * @example $("form").bind("submit", function(event){
         *   event.stopPropagation();
-        * } )
+        * });
         * @desc Stop only an event from bubbling by using the stopPropagation method.
         *
         * @name bind
@@ -241,9 +247,9 @@ jQuery.fn.extend({
         * data as the second paramter (and the handler function as the third), see 
         * second example.
         *
-        * @example $("p").one( "click", function() {
+        * @example $("p").one("click", function(){
         *   alert( $(this).text() );
-        * } )
+        * });
         * @before <p>Hello</p>
         * @result alert("Hello")
         *
@@ -265,43 +271,31 @@ jQuery.fn.extend({
 
        /**
         * The opposite of bind, removes a bound event from each of the matched
-        * elements. You must pass the identical function that was used in the original
-        * bind method.
+        * elements.
         *
-        * @example $("p").unbind( "click", function() { alert("Hello"); } )
+        * Without any arguments, all bound events are removed.
+        *
+        * If the type is provided, all bound events of that type are removed.
+        *
+        * If the function that was passed to bind is provided as the second argument,
+        * only that specific event handler is removed.
+        *
+        * @example $("p").unbind()
         * @before <p onclick="alert('Hello');">Hello</p>
         * @result [ <p>Hello</p> ]
         *
-        * @name unbind
-        * @type jQuery
-        * @param String type An event type
-        * @param Function fn A function to unbind from the event on each of the set of matched elements
-        * @cat Events
-        */
-
-       /**
-        * Removes all bound events of a particular type from each of the matched
-        * elements.
-        *
         * @example $("p").unbind( "click" )
         * @before <p onclick="alert('Hello');">Hello</p>
         * @result [ <p>Hello</p> ]
         *
-        * @name unbind
-        * @type jQuery
-        * @param String type An event type
-        * @cat Events
-        */
-
-       /**
-        * Removes all bound events from each of the matched elements.
-        *
-        * @example $("p").unbind()
+        * @example $("p").unbind( "click", function() { alert("Hello"); } )
         * @before <p onclick="alert('Hello');">Hello</p>
         * @result [ <p>Hello</p> ]
         *
         * @name unbind
         * @type jQuery
+        * @param String type (optional) An event type
+        * @param Function fn (optional) A function to unbind from the event on each of the set of matched elements
         * @cat Events
         */
        unbind: function( type, fn ) {
@@ -328,10 +322,6 @@ jQuery.fn.extend({
                });
        },
 
-       // We're overriding the old toggle function, so
-       // remember it for later
-       _toggle: jQuery.fn.toggle,
-       
        /**
         * Toggle between two function calls every other click.
         * Whenever a matched element is clicked, the first specified function 
@@ -353,9 +343,10 @@ jQuery.fn.extend({
         * @cat Events
         */
        toggle: function() {
-               // save reference to arguments for access in closure
+               // Save reference to arguments for access in closure
                var a = arguments;
-               return typeof a[0] == "function" && typeof a[1] == "function" ? this.click(function(e) {
+
+               return this.click(function(e) {
                        // Figure out which function to execute
                        this.lastToggle = this.lastToggle == 0 ? 1 : 0;
                        
@@ -364,10 +355,7 @@ jQuery.fn.extend({
                        
                        // and execute the function
                        return a[this.lastToggle].apply( this, [e] ) || false;
-               }) :
-               
-               // Otherwise, execute the old toggle function
-               this._toggle.apply( this, arguments );
+               });
        },
        
        /**
@@ -426,6 +414,10 @@ jQuery.fn.extend({
         * and attaching a function to that. By using this method, your bound Function 
         * will be called the instant the DOM is ready to be read and manipulated, 
         * which is exactly what 99.99% of all Javascript code needs to run.
+        *
+        * There is one argument passed to the ready event handler: A reference to
+        * the jQuery function. You can name that argument whatever you like, and
+        * can therefore stick with the $ alias without risc of naming collisions.
         * 
         * Please ensure you have no code in your &lt;body&gt; onload event handler, 
         * otherwise $(document).ready() may not fire.
@@ -435,21 +427,30 @@ jQuery.fn.extend({
         *
         * @example $(document).ready(function(){ Your code here... });
         *
+        * @example jQuery(function($) {
+        *   // Your code using failsafe $ alias here...
+        * });
+        * @desc Uses both the shortcut for $(document).ready() and the argument
+        * to write failsafe jQuery code using the $ alias, without relying on the
+        * global alias.
+        *
         * @name ready
         * @type jQuery
         * @param Function fn The function to be executed when the DOM is ready.
         * @cat Events
+        * @see $.noConflict()
+        * @see $(Function)
         */
        ready: function(f) {
                // If the DOM is already ready
                if ( jQuery.isReady )
                        // Execute the function immediately
-                       f.apply( document );
+                       f.apply( document, [jQuery] );
                        
                // Otherwise, remember the function for later
                else {
                        // Add the function to the wait list
-                       jQuery.readyList.push( f );
+                       jQuery.readyList.push( function() { return f.apply(this, [jQuery]) } );
                }
        
                return this;
@@ -473,8 +474,9 @@ jQuery.extend({
                        // If there are functions bound, to execute
                        if ( jQuery.readyList ) {
                                // Execute all of them
-                               for ( var i = 0; i < jQuery.readyList.length; i++ )
-                                       jQuery.readyList[i].apply( document );
+                               jQuery.each( jQuery.readyList, function(){
+                                       this.apply( document );
+                               });
                                
                                // Reset the list of functions
                                jQuery.readyList = null;
@@ -498,20 +500,7 @@ new function(){
         * @name scroll
         * @type jQuery
         * @param Function fn A function to bind to the scroll event on each of the matched elements.
-        * @cat Events/Browser
-        */
-
-       /**
-        * Trigger the scroll event of each matched element. This causes all of the functions
-        * that have been bound to thet scroll event to be executed.
-        *
-        * @example $("p").scroll();
-        * @before <p onscroll="alert('Hello');">Hello</p>
-        * @result alert('Hello');
-        *
-        * @name scroll
-        * @type jQuery
-        * @cat Events/Browser
+        * @cat Events
         */
 
        /**
@@ -526,7 +515,7 @@ new function(){
         * @name submit
         * @type jQuery
         * @param Function fn A function to bind to the submit event on each of the matched elements.
-        * @cat Events/Form
+        * @cat Events
         */
 
        /**
@@ -541,7 +530,7 @@ new function(){
         *
         * @name submit
         * @type jQuery
-        * @cat Events/Form
+        * @cat Events
         */
 
        /**
@@ -554,7 +543,7 @@ new function(){
         * @name focus
         * @type jQuery
         * @param Function fn A function to bind to the focus event on each of the matched elements.
-        * @cat Events/UI
+        * @cat Events
         */
 
        /**
@@ -570,7 +559,7 @@ new function(){
         *
         * @name focus
         * @type jQuery
-        * @cat Events/UI
+        * @cat Events
         */
 
        /**
@@ -583,20 +572,7 @@ new function(){
         * @name keydown
         * @type jQuery
         * @param Function fn A function to bind to the keydown event on each of the matched elements.
-        * @cat Events/Keyboard
-        */
-
-       /**
-        * Trigger the keydown event of each matched element. This causes all of the functions
-        * that have been bound to thet keydown event to be executed.
-        *
-        * @example $("p").keydown();
-        * @before <p onkeydown="alert('Hello');">Hello</p>
-        * @result alert('Hello');
-        *
-        * @name keydown
-        * @type jQuery
-        * @cat Events/Keyboard
+        * @cat Events
         */
 
        /**
@@ -609,20 +585,7 @@ new function(){
         * @name dblclick
         * @type jQuery
         * @param Function fn A function to bind to the dblclick event on each of the matched elements.
-        * @cat Events/Mouse
-        */
-
-       /**
-        * Trigger the dblclick event of each matched element. This causes all of the functions
-        * that have been bound to thet dblclick event to be executed.
-        *
-        * @example $("p").dblclick();
-        * @before <p ondblclick="alert('Hello');">Hello</p>
-        * @result alert('Hello');
-        *
-        * @name dblclick
-        * @type jQuery
-        * @cat Events/Mouse
+        * @cat Events
         */
 
        /**
@@ -635,20 +598,7 @@ new function(){
         * @name keypress
         * @type jQuery
         * @param Function fn A function to bind to the keypress event on each of the matched elements.
-        * @cat Events/Keyboard
-        */
-
-       /**
-        * Trigger the keypress event of each matched element. This causes all of the functions
-        * that have been bound to thet keypress event to be executed.
-        *
-        * @example $("p").keypress();
-        * @before <p onkeypress="alert('Hello');">Hello</p>
-        * @result alert('Hello');
-        *
-        * @name keypress
-        * @type jQuery
-        * @cat Events/Keyboard
+        * @cat Events
         */
 
        /**
@@ -661,20 +611,7 @@ new function(){
         * @name error
         * @type jQuery
         * @param Function fn A function to bind to the error event on each of the matched elements.
-        * @cat Events/Browser
-        */
-
-       /**
-        * Trigger the error event of each matched element. This causes all of the functions
-        * that have been bound to thet error event to be executed.
-        *
-        * @example $("p").error();
-        * @before <p onerror="alert('Hello');">Hello</p>
-        * @result alert('Hello');
-        *
-        * @name error
-        * @type jQuery
-        * @cat Events/Browser
+        * @cat Events
         */
 
        /**
@@ -687,7 +624,7 @@ new function(){
         * @name blur
         * @type jQuery
         * @param Function fn A function to bind to the blur event on each of the matched elements.
-        * @cat Events/UI
+        * @cat Events
         */
 
        /**
@@ -703,7 +640,7 @@ new function(){
         *
         * @name blur
         * @type jQuery
-        * @cat Events/UI
+        * @cat Events
         */
 
        /**
@@ -716,24 +653,7 @@ new function(){
         * @name load
         * @type jQuery
         * @param Function fn A function to bind to the load event on each of the matched elements.
-        * @cat Events/Browser
-        */
-
-       /**
-        * Trigger the load event of each matched element. This causes all of the functions
-        * that have been bound to thet load event to be executed.
-        *
-        * Marked as private: Calling load() without arguments throws exception because the ajax load
-        * does not handle it.
-        *
-        * @example $("p").load();
-        * @before <p onload="alert('Hello');">Hello</p>
-        * @result alert('Hello');
-        *
-        * @name load
-        * @private
-        * @type jQuery
-        * @cat Events/Browser
+        * @cat Events
         */
 
        /**
@@ -746,7 +666,7 @@ new function(){
         * @name select
         * @type jQuery
         * @param Function fn A function to bind to the select event on each of the matched elements.
-        * @cat Events/Form
+        * @cat Events
         */
 
        /**
@@ -759,7 +679,7 @@ new function(){
         *
         * @name select
         * @type jQuery
-        * @cat Events/Form
+        * @cat Events
         */
 
        /**
@@ -772,20 +692,7 @@ new function(){
         * @name mouseup
         * @type jQuery
         * @param Function fn A function to bind to the mouseup event on each of the matched elements.
-        * @cat Events/Mouse
-        */
-
-       /**
-        * Trigger the mouseup event of each matched element. This causes all of the functions
-        * that have been bound to thet mouseup event to be executed.
-        *
-        * @example $("p").mouseup();
-        * @before <p onmouseup="alert('Hello');">Hello</p>
-        * @result alert('Hello');
-        *
-        * @name mouseup
-        * @type jQuery
-        * @cat Events/Mouse
+        * @cat Events
         */
 
        /**
@@ -798,20 +705,7 @@ new function(){
         * @name unload
         * @type jQuery
         * @param Function fn A function to bind to the unload event on each of the matched elements.
-        * @cat Events/Browser
-        */
-
-       /**
-        * Trigger the unload event of each matched element. This causes all of the functions
-        * that have been bound to thet unload event to be executed.
-        *
-        * @example $("p").unload();
-        * @before <p onunload="alert('Hello');">Hello</p>
-        * @result alert('Hello');
-        *
-        * @name unload
-        * @type jQuery
-        * @cat Events/Browser
+        * @cat Events
         */
 
        /**
@@ -824,20 +718,7 @@ new function(){
         * @name change
         * @type jQuery
         * @param Function fn A function to bind to the change event on each of the matched elements.
-        * @cat Events/Form
-        */
-
-       /**
-        * Trigger the change event of each matched element. This causes all of the functions
-        * that have been bound to thet change event to be executed.
-        *
-        * @example $("p").change();
-        * @before <p onchange="alert('Hello');">Hello</p>
-        * @result alert('Hello');
-        *
-        * @name change
-        * @type jQuery
-        * @cat Events/Form
+        * @cat Events
         */
 
        /**
@@ -850,20 +731,7 @@ new function(){
         * @name mouseout
         * @type jQuery
         * @param Function fn A function to bind to the mouseout event on each of the matched elements.
-        * @cat Events/Mouse
-        */
-
-       /**
-        * Trigger the mouseout event of each matched element. This causes all of the functions
-        * that have been bound to thet mouseout event to be executed.
-        *
-        * @example $("p").mouseout();
-        * @before <p onmouseout="alert('Hello');">Hello</p>
-        * @result alert('Hello');
-        *
-        * @name mouseout
-        * @type jQuery
-        * @cat Events/Mouse
+        * @cat Events
         */
 
        /**
@@ -876,20 +744,7 @@ new function(){
         * @name keyup
         * @type jQuery
         * @param Function fn A function to bind to the keyup event on each of the matched elements.
-        * @cat Events/Keyboard
-        */
-
-       /**
-        * Trigger the keyup event of each matched element. This causes all of the functions
-        * that have been bound to thet keyup event to be executed.
-        *
-        * @example $("p").keyup();
-        * @before <p onkeyup="alert('Hello');">Hello</p>
-        * @result alert('Hello');
-        *
-        * @name keyup
-        * @type jQuery
-        * @cat Events/Keyboard
+        * @cat Events
         */
 
        /**
@@ -902,7 +757,7 @@ new function(){
         * @name click
         * @type jQuery
         * @param Function fn A function to bind to the click event on each of the matched elements.
-        * @cat Events/Mouse
+        * @cat Events
         */
 
        /**
@@ -915,7 +770,7 @@ new function(){
         *
         * @name click
         * @type jQuery
-        * @cat Events/Mouse
+        * @cat Events
         */
 
        /**
@@ -928,20 +783,7 @@ new function(){
         * @name resize
         * @type jQuery
         * @param Function fn A function to bind to the resize event on each of the matched elements.
-        * @cat Events/Browser
-        */
-
-       /**
-        * Trigger the resize event of each matched element. This causes all of the functions
-        * that have been bound to thet resize event to be executed.
-        *
-        * @example $("p").resize();
-        * @before <p onresize="alert('Hello');">Hello</p>
-        * @result alert('Hello');
-        *
-        * @name resize
-        * @type jQuery
-        * @cat Events/Browser
+        * @cat Events
         */
 
        /**
@@ -954,20 +796,7 @@ new function(){
         * @name mousemove
         * @type jQuery
         * @param Function fn A function to bind to the mousemove event on each of the matched elements.
-        * @cat Events/Mouse
-        */
-
-       /**
-        * Trigger the mousemove event of each matched element. This causes all of the functions
-        * that have been bound to thet mousemove event to be executed.
-        *
-        * @example $("p").mousemove();
-        * @before <p onmousemove="alert('Hello');">Hello</p>
-        * @result alert('Hello');
-        *
-        * @name mousemove
-        * @type jQuery
-        * @cat Events/Mouse
+        * @cat Events
         */
 
        /**
@@ -980,20 +809,7 @@ new function(){
         * @name mousedown
         * @type jQuery
         * @param Function fn A function to bind to the mousedown event on each of the matched elements.
-        * @cat Events/Mouse
-        */
-
-       /**
-        * Trigger the mousedown event of each matched element. This causes all of the functions
-        * that have been bound to thet mousedown event to be executed.
-        *
-        * @example $("p").mousedown();
-        * @before <p onmousedown="alert('Hello');">Hello</p>
-        * @result alert('Hello');
-        *
-        * @name mousedown
-        * @type jQuery
-        * @cat Events/Mouse
+        * @cat Events
         */
         
        /**
@@ -1006,38 +822,18 @@ new function(){
         * @name mouseover
         * @type jQuery
         * @param Function fn A function to bind to the mousedown event on each of the matched elements.
-        * @cat Events/Mouse
-        */
-
-       /**
-        * Trigger the mouseover event of each matched element. This causes all of the functions
-        * that have been bound to thet mousedown event to be executed.
-        *
-        * @example $("p").mouseover();
-        * @before <p onmouseover="alert('Hello');">Hello</p>
-        * @result alert('Hello');
-        *
-        * @name mouseover
-        * @type jQuery
-        * @cat Events/Mouse
+        * @cat Events
         */
-
-       var e = ("blur,focus,load,resize,scroll,unload,click,dblclick," +
+       jQuery.each( ("blur,focus,load,resize,scroll,unload,click,dblclick," +
                "mousedown,mouseup,mousemove,mouseover,mouseout,change,select," + 
-               "submit,keydown,keypress,keyup,error").split(",");
-
-       // Go through all the event names, but make sure that
-       // it is enclosed properly
-       for ( var i = 0; i < e.length; i++ ) new function(){
-                       
-               var o = e[i];
+               "submit,keydown,keypress,keyup,error").split(","), function(i,o){
                
                // Handle event binding
                jQuery.fn[o] = function(f){
                        return f ? this.bind(o, f) : this.trigger(o);
                };
                        
-       };
+       });
        
        // If Mozilla is used
        if ( jQuery.browser.mozilla || jQuery.browser.opera )
@@ -1090,7 +886,7 @@ new function(){
 
 // Clean up after IE to avoid memory leaks
 if (jQuery.browser.msie)
-       jQuery(window).bind("unload", function() {
+       jQuery(window).one("unload", function() {
                var global = jQuery.event.global;
                for ( var type in global ) {
                        var els = global[type], i = els.length;
@@ -1099,4 +895,4 @@ if (jQuery.browser.msie)
                                        jQuery.event.remove(els[i-1], type);
                                while (--i);
                }
-       });
\ No newline at end of file
+       });