Added in jQuery.isFunction().
[jquery.git] / src / event / event.js
index eaf6858..63a8a7c 100644 (file)
@@ -82,15 +82,14 @@ jQuery.event = {
 
                // 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 }) );
+                       // 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 ] ) )
+                               element[ type ]();
                }
        },
 
@@ -133,7 +132,7 @@ 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);
@@ -187,32 +186,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 +240,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")
         *
@@ -316,10 +315,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 
@@ -341,9 +336,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;
                        
@@ -352,10 +348,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 );
+               });
        },
        
        /**
@@ -414,6 +407,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.
@@ -423,21 +420,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;
@@ -486,20 +492,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
         */
 
        /**
@@ -514,7 +507,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
         */
 
        /**
@@ -529,7 +522,7 @@ new function(){
         *
         * @name submit
         * @type jQuery
-        * @cat Events/Form
+        * @cat Events
         */
 
        /**
@@ -542,7 +535,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
         */
 
        /**
@@ -558,7 +551,7 @@ new function(){
         *
         * @name focus
         * @type jQuery
-        * @cat Events/UI
+        * @cat Events
         */
 
        /**
@@ -571,20 +564,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
         */
 
        /**
@@ -597,20 +577,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
         */
 
        /**
@@ -623,20 +590,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
         */
 
        /**
@@ -649,20 +603,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
         */
 
        /**
@@ -675,7 +616,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
         */
 
        /**
@@ -691,7 +632,7 @@ new function(){
         *
         * @name blur
         * @type jQuery
-        * @cat Events/UI
+        * @cat Events
         */
 
        /**
@@ -704,24 +645,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
         */
 
        /**
@@ -734,7 +658,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
         */
 
        /**
@@ -747,7 +671,7 @@ new function(){
         *
         * @name select
         * @type jQuery
-        * @cat Events/Form
+        * @cat Events
         */
 
        /**
@@ -760,20 +684,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
         */
 
        /**
@@ -786,20 +697,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
         */
 
        /**
@@ -812,20 +710,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
         */
 
        /**
@@ -838,20 +723,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
         */
 
        /**
@@ -864,20 +736,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
         */
 
        /**
@@ -890,7 +749,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
         */
 
        /**
@@ -903,7 +762,7 @@ new function(){
         *
         * @name click
         * @type jQuery
-        * @cat Events/Mouse
+        * @cat Events
         */
 
        /**
@@ -916,20 +775,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
         */
 
        /**
@@ -942,20 +788,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
         */
 
        /**
@@ -968,20 +801,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
         */
         
        /**
@@ -994,38 +814,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 )
@@ -1087,4 +887,4 @@ if (jQuery.browser.msie)
                                        jQuery.event.remove(els[i-1], type);
                                while (--i);
                }
-       });
\ No newline at end of file
+       });