X-Git-Url: http://git.asbjorn.biz/?a=blobdiff_plain;f=src%2Fevent%2Fevent.js;h=4347ae57a26859a46adbc10cf37951f794237fff;hb=92417f694a5c66cda477bf33e1c2d3ce0765e05f;hp=1a8a6b51968948ac6e59ce1bb65c0b12beb7eff4;hpb=4805a45c0669b298c24005ce6505b49d88f85fe7;p=jquery.git diff --git a/src/event/event.js b/src/event/event.js index 1a8a6b5..4347ae5 100644 --- a/src/event/event.js +++ b/src/event/event.js @@ -22,16 +22,16 @@ jQuery.event = { handler.guid = this.guid++; // Init the element's event structure - if (!element.events) - element.events = {}; + if (!element.$events) + element.$events = {}; // Get the current list of functions bound to this event - var handlers = element.events[type]; + var handlers = element.$events[type]; // If it hasn't been initialized yet if (!handlers) { // Init the event handler queue - handlers = element.events[type] = {}; + handlers = element.$events[type] = {}; // Remember an existing handler, if it's already there if (element["on" + type]) @@ -55,47 +55,73 @@ jQuery.event = { // Detach an event or set of events from an element remove: function(element, type, handler) { - if (element.events) - if ( type && type.type ) - delete element.events[ type.type ][ type.handler.guid ]; - else if (type && element.events[type]) + if (element.$events) { + var i,j,k; + if ( type && type.type ) { // type is actually an event object here + handler = type.handler; + type = type.type; + } + + if (type && element.$events[type]) + // remove the given handler for the given type if ( handler ) - delete element.events[type][handler.guid]; + delete element.$events[type][handler.guid]; + + // remove all handlers for the given type else - for ( var i in element.events[type] ) - delete element.events[type][i]; + for ( i in element.$events[type] ) + delete element.$events[type][i]; + + // remove all handlers else - for ( var j in element.events ) + for ( j in element.$events ) this.remove( element, j ); + + // remove event handler if no more handlers exist + for ( k in element.$events[type] ) + if (k) { + k = true; + break; + } + if (!k) element["on" + type] = null; + } }, - trigger: function(type,data,element) { + trigger: function(type, data, element) { // Clone the incoming data, if any 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 { + else { + var handler = element["on" + type ], val, + fn = jQuery.isFunction( element[ type ] ); + + if ( handler ) { // Pass along a fake event data.unshift( this.fix({ type: type, target: element }) ); // Trigger the event - element["on" + type].apply( element, data ); + if ( (val = handler.apply( element, data )) !== false ) + this.triggered = true; } + + if ( fn && val !== false ) + element[ type ](); + + this.triggered = false; } }, handle: function(event) { - if ( typeof jQuery == "undefined" ) return false; + // 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; // Empty object is for triggered events with no data event = jQuery.event.fix( event || window.event || {} ); @@ -103,7 +129,7 @@ jQuery.event = { // returned undefined or false var returnValue; - var c = this.events[event.type]; + var c = this.$events[event.type]; var args = [].slice.call( arguments, 1 ); args.unshift( event ); @@ -133,14 +159,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; @@ -184,35 +210,35 @@ jQuery.fn.extend({ * * In most cases, you can define your event handlers as anonymous functions * (see first example). In cases where that is not possible, you can pass additional - * data as the second paramter (and the handler function as the third), see + * data as the second parameter (and the handler function as the third), see * second example. * - * @example $("p").bind( "click", function() { + * @example $("p").bind("click", function(){ * alert( $(this).text() ); - * } ) + * }); * @before

Hello

* @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 +267,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

Hello

* @result alert("Hello") * @@ -265,43 +291,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

Hello

* @result [

Hello

] * - * @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

Hello

* @result [

Hello

] * - * @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

Hello

* @result [

Hello

] * * @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 ) { @@ -311,15 +325,35 @@ jQuery.fn.extend({ }, /** - * Trigger a type of event on every matched element. + * Trigger a type of event on every matched element. This will also cause + * the default action of the browser with the same name (if one exists) + * to be executed. For example, passing 'submit' to the trigger() + * function will also cause the browser to submit the form. This + * default action can be prevented by returning false from one of + * the functions bound to the event. + * + * You can also trigger custom events registered with bind. * * @example $("p").trigger("click") * @before

Hello

* @result alert('hello') * + * @example $("p").click(function(event, a, b) { + * // when a normal click fires, a and b are undefined + * // for a trigger like below a refers too "foo" and b refers to "bar" + * }).trigger("click", ["foo", "bar"]); + * @desc Example of how to pass arbitrary data to an event + * + * @example $("p").bind("myEvent",function(event,message1,message2) { + * alert(message1 + ' ' + message2); + * }); + * $("p").trigger("myEvent",["Hello","World"]); + * @result alert('Hello World') // One for each paragraph + * * @name trigger * @type jQuery * @param String type An event type to trigger. + * @param Array data (optional) Additional data to pass as arguments (after the event object) to the event handler * @cat Events */ trigger: function( type, data ) { @@ -328,10 +362,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 +383,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 +395,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 ); + }); }, /** @@ -384,9 +412,9 @@ jQuery.fn.extend({ * (a common error in using a mouseout event handler). * * @example $("p").hover(function(){ - * $(this).addClass("over"); + * $(this).addClass("hover"); * },function(){ - * $(this).addClass("out"); + * $(this).removeClass("hover"); * }); * * @name hover @@ -423,9 +451,13 @@ jQuery.fn.extend({ * the response times of your web applications. * * In a nutshell, this is a solid replacement for using window.onload, - * and attaching a function to that. By using this method, your bound Function + * 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. + * which is when 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 risk of naming collisions. * * Please ensure you have no code in your <body> onload event handler, * otherwise $(document).ready() may not fire. @@ -435,21 +467,30 @@ jQuery.fn.extend({ * * @example $(document).ready(function(){ Your code here... }); * + * @example jQuery(function($) { + * // Your code using failsafe $ alias here... + * }); + * @desc Uses both the [[Core#.24.28_fn_.29|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 +514,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 +540,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

Hello

- * @result alert('Hello'); - * - * @name scroll - * @type jQuery - * @cat Events/Browser + * @cat Events */ /** @@ -526,22 +555,24 @@ 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 */ /** * Trigger the submit event of each matched element. This causes all of the functions - * that have been bound to thet submit event to be executed. + * that have been bound to that submit event to be executed, and calls the browser's + * default submit action on the matching element(s). This default action can be prevented + * by returning false from one of the functions bound to the submit event. * * Note: This does not execute the submit method of the form element! If you need to * submit the form via code, you have to use the DOM method, eg. $("form")[0].submit(); * * @example $("form").submit(); - * @desc Triggers all submit events registered for forms, but does not submit the form + * @desc Triggers all submit events registered to the matched form(s), and submits them. * * @name submit * @type jQuery - * @cat Events/Form + * @cat Events */ /** @@ -554,7 +585,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 +601,7 @@ new function(){ * * @name focus * @type jQuery - * @cat Events/UI + * @cat Events */ /** @@ -583,20 +614,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

Hello

- * @result alert('Hello'); - * - * @name keydown - * @type jQuery - * @cat Events/Keyboard + * @cat Events */ /** @@ -609,20 +627,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

Hello

- * @result alert('Hello'); - * - * @name dblclick - * @type jQuery - * @cat Events/Mouse + * @cat Events */ /** @@ -635,20 +640,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

Hello

- * @result alert('Hello'); - * - * @name keypress - * @type jQuery - * @cat Events/Keyboard + * @cat Events */ /** @@ -661,20 +653,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

Hello

- * @result alert('Hello'); - * - * @name error - * @type jQuery - * @cat Events/Browser + * @cat Events */ /** @@ -687,12 +666,14 @@ 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 */ /** * Trigger the blur event of each matched element. This causes all of the functions - * that have been bound to thet blur event to be executed. + * that have been bound to that blur event to be executed, and calls the browser's + * default blur action on the matching element(s). This default action can be prevented + * by returning false from one of the functions bound to the blur event. * * Note: This does not execute the blur method of the underlying elements! If you need to * blur an element via code, you have to use the DOM method, eg. $("#myinput")[0].blur(); @@ -703,7 +684,7 @@ new function(){ * * @name blur * @type jQuery - * @cat Events/UI + * @cat Events */ /** @@ -716,24 +697,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

Hello

- * @result alert('Hello'); - * - * @name load - * @private - * @type jQuery - * @cat Events/Browser + * @cat Events */ /** @@ -746,12 +710,14 @@ 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 */ /** * Trigger the select event of each matched element. This causes all of the functions - * that have been bound to thet select event to be executed. + * that have been bound to that select event to be executed, and calls the browser's + * default select action on the matching element(s). This default action can be prevented + * by returning false from one of the functions bound to the select event. * * @example $("p").select(); * @before

Hello

@@ -759,7 +725,7 @@ new function(){ * * @name select * @type jQuery - * @cat Events/Form + * @cat Events */ /** @@ -772,20 +738,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

Hello

- * @result alert('Hello'); - * - * @name mouseup - * @type jQuery - * @cat Events/Mouse + * @cat Events */ /** @@ -798,20 +751,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

Hello

- * @result alert('Hello'); - * - * @name unload - * @type jQuery - * @cat Events/Browser + * @cat Events */ /** @@ -824,20 +764,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

Hello

- * @result alert('Hello'); - * - * @name change - * @type jQuery - * @cat Events/Form + * @cat Events */ /** @@ -850,20 +777,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

Hello

- * @result alert('Hello'); - * - * @name mouseout - * @type jQuery - * @cat Events/Mouse + * @cat Events */ /** @@ -876,20 +790,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

Hello

- * @result alert('Hello'); - * - * @name keyup - * @type jQuery - * @cat Events/Keyboard + * @cat Events */ /** @@ -902,7 +803,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 +816,7 @@ new function(){ * * @name click * @type jQuery - * @cat Events/Mouse + * @cat Events */ /** @@ -928,20 +829,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

Hello

- * @result alert('Hello'); - * - * @name resize - * @type jQuery - * @cat Events/Browser + * @cat Events */ /** @@ -954,20 +842,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

Hello

- * @result alert('Hello'); - * - * @name mousemove - * @type jQuery - * @cat Events/Mouse + * @cat Events */ /** @@ -980,20 +855,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

Hello

- * @result alert('Hello'); - * - * @name mousedown - * @type jQuery - * @cat Events/Mouse + * @cat Events */ /** @@ -1006,38 +868,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

Hello

- * @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 +932,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 +941,4 @@ if (jQuery.browser.msie) jQuery.event.remove(els[i-1], type); while (--i); } - }); \ No newline at end of file + });