2 * A number of helper functions used for managing events.
3 * Many of the ideas behind this code orignated from
4 * Dean Edwards' addEvent library.
8 // Bind an event to an element
9 // Original by Dean Edwards
10 add: function(element, type, handler, data) {
11 // For whatever reason, IE has trouble passing the window object
12 // around, causing it to be cloned in the process
13 if ( jQuery.browser.msie && element.setInterval != undefined )
16 // if data is passed, bind to handler
20 // Make sure that the function being executed has a unique ID
22 handler.guid = this.guid++;
24 // Init the element's event structure
28 // Get the current list of functions bound to this event
29 var handlers = element.events[type];
31 // If it hasn't been initialized yet
33 // Init the event handler queue
34 handlers = element.events[type] = {};
36 // Remember an existing handler, if it's already there
37 if (element["on" + type])
38 handlers[0] = element["on" + type];
41 // Add the function to the element's handler list
42 handlers[handler.guid] = handler;
44 // And bind the global event handler to the element
45 element["on" + type] = this.handle;
47 // Remember the function in a global list (for triggering)
48 if (!this.global[type])
49 this.global[type] = [];
50 this.global[type].push( element );
56 // Detach an event or set of events from an element
57 remove: function(element, type, handler) {
59 if ( type && type.type )
60 delete element.events[ type.type ][ type.handler.guid ];
61 else if (type && element.events[type])
63 delete element.events[type][handler.guid];
65 for ( var i in element.events[type] )
66 delete element.events[type][i];
68 for ( var j in element.events )
69 this.remove( element, j );
72 trigger: function(type,data,element) {
73 // Clone the incoming data, if any
74 data = jQuery.makeArray(data || []);
76 // Handle a global trigger
78 var g = this.global[type];
80 for ( var i = 0, gl = g.length; i < gl; i++ )
81 this.trigger( type, data, g[i] );
83 // Handle triggering a single element
84 } else if ( element["on" + type] ) {
85 if ( element[ type ] && element[ type ].constructor == Function )
88 // Pass along a fake event
89 data.unshift( this.fix({ type: type, target: element }) );
92 element["on" + type].apply( element, data );
97 handle: function(event) {
98 if ( typeof jQuery == "undefined" ) return false;
100 // Empty object is for triggered events with no data
101 event = jQuery.event.fix( event || window.event || {} );
103 // returned undefined or false
106 var c = this.events[event.type];
108 var args = [].slice.call( arguments, 1 );
109 args.unshift( event );
112 // Pass in a reference to the handler function itself
113 // So that we can later remove it
114 args[0].handler = c[j];
115 args[0].data = c[j].data;
117 if ( c[j].apply( this, args ) === false ) {
118 event.preventDefault();
119 event.stopPropagation();
124 // Clean up added properties in IE to prevent memory leak
125 if (jQuery.browser.msie) event.target = event.preventDefault = event.stopPropagation = event.handler = event.data = null;
130 fix: function(event) {
131 // Fix target property, if necessary
132 if ( !event.target && event.srcElement )
133 event.target = event.srcElement;
135 // Calculate pageX/Y if missing and clientX/Y available
136 if ( typeof event.pageX == "undefined" && typeof event.clientX != "undefined" ) {
137 var e = document.documentElement, b = document.body;
138 event.pageX = event.clientX + (e.scrollLeft || b.scrollLeft);
139 event.pageY = event.clientY + (e.scrollTop || b.scrollTop);
142 // check if target is a textnode (safari)
143 if (jQuery.browser.safari && event.target.nodeType == 3) {
144 // store a copy of the original event object
145 // and clone because target is read only
146 var originalEvent = event;
147 event = jQuery.extend({}, originalEvent);
149 // get parentnode from textnode
150 event.target = originalEvent.target.parentNode;
152 // add preventDefault and stopPropagation since
153 // they will not work on the clone
154 event.preventDefault = function() {
155 return originalEvent.preventDefault();
157 event.stopPropagation = function() {
158 return originalEvent.stopPropagation();
162 // fix preventDefault and stopPropagation
163 if (!event.preventDefault)
164 event.preventDefault = function() {
165 this.returnValue = false;
168 if (!event.stopPropagation)
169 event.stopPropagation = function() {
170 this.cancelBubble = true;
180 * Binds a handler to a particular event (like click) for each matched element.
181 * The event handler is passed an event object that you can use to prevent
182 * default behaviour. To stop both default action and event bubbling, your handler
183 * has to return false.
185 * In most cases, you can define your event handlers as anonymous functions
186 * (see first example). In cases where that is not possible, you can pass additional
187 * data as the second paramter (and the handler function as the third), see
190 * @example $("p").bind("click", function(){
191 * alert( $(this).text() );
193 * @before <p>Hello</p>
194 * @result alert("Hello")
196 * @example function handler(event) {
197 * alert(event.data.foo);
199 * $("p").bind("click", {foo: "bar"}, handler)
200 * @result alert("bar")
201 * @desc Pass some additional data to the event handler.
203 * @example $("form").bind("submit", function() { return false; })
204 * @desc Cancel a default action and prevent it from bubbling by returning false
205 * from your function.
207 * @example $("form").bind("submit", function(event){
208 * event.preventDefault();
210 * @desc Cancel only the default action by using the preventDefault method.
213 * @example $("form").bind("submit", function(event){
214 * event.stopPropagation();
216 * @desc Stop only an event from bubbling by using the stopPropagation method.
220 * @param String type An event type
221 * @param Object data (optional) Additional data passed to the event handler as event.data
222 * @param Function fn A function to bind to the event on each of the set of matched elements
225 bind: function( type, data, fn ) {
226 return this.each(function(){
227 jQuery.event.add( this, type, fn || data, data );
232 * Binds a handler to a particular event (like click) for each matched element.
233 * The handler is executed only once for each element. Otherwise, the same rules
234 * as described in bind() apply.
235 The event handler is passed an event object that you can use to prevent
236 * default behaviour. To stop both default action and event bubbling, your handler
237 * has to return false.
239 * In most cases, you can define your event handlers as anonymous functions
240 * (see first example). In cases where that is not possible, you can pass additional
241 * data as the second paramter (and the handler function as the third), see
244 * @example $("p").one("click", function(){
245 * alert( $(this).text() );
247 * @before <p>Hello</p>
248 * @result alert("Hello")
252 * @param String type An event type
253 * @param Object data (optional) Additional data passed to the event handler as event.data
254 * @param Function fn A function to bind to the event on each of the set of matched elements
257 one: function( type, data, fn ) {
258 return this.each(function(){
259 jQuery.event.add( this, type, function(event) {
260 jQuery(this).unbind(event);
261 return (fn || data).apply( this, arguments);
267 * The opposite of bind, removes a bound event from each of the matched
270 * Without any arguments, all bound events are removed.
272 * If the type is provided, all bound events of that type are removed.
274 * If the function that was passed to bind is provided as the second argument,
275 * only that specific event handler is removed.
277 * @example $("p").unbind()
278 * @before <p onclick="alert('Hello');">Hello</p>
279 * @result [ <p>Hello</p> ]
281 * @example $("p").unbind( "click" )
282 * @before <p onclick="alert('Hello');">Hello</p>
283 * @result [ <p>Hello</p> ]
285 * @example $("p").unbind( "click", function() { alert("Hello"); } )
286 * @before <p onclick="alert('Hello');">Hello</p>
287 * @result [ <p>Hello</p> ]
291 * @param String type (optional) An event type
292 * @param Function fn (optional) A function to unbind from the event on each of the set of matched elements
295 unbind: function( type, fn ) {
296 return this.each(function(){
297 jQuery.event.remove( this, type, fn );
302 * Trigger a type of event on every matched element.
304 * @example $("p").trigger("click")
305 * @before <p click="alert('hello')">Hello</p>
306 * @result alert('hello')
310 * @param String type An event type to trigger.
313 trigger: function( type, data ) {
314 return this.each(function(){
315 jQuery.event.trigger( type, data, this );
320 * Toggle between two function calls every other click.
321 * Whenever a matched element is clicked, the first specified function
322 * is fired, when clicked again, the second is fired. All subsequent
323 * clicks continue to rotate through the two functions.
325 * Use unbind("click") to remove.
327 * @example $("p").toggle(function(){
328 * $(this).addClass("selected");
330 * $(this).removeClass("selected");
335 * @param Function even The function to execute on every even click.
336 * @param Function odd The function to execute on every odd click.
340 // Save reference to arguments for access in closure
343 return this.click(function(e) {
344 // Figure out which function to execute
345 this.lastToggle = this.lastToggle == 0 ? 1 : 0;
347 // Make sure that clicks stop
350 // and execute the function
351 return a[this.lastToggle].apply( this, [e] ) || false;
356 * A method for simulating hovering (moving the mouse on, and off,
357 * an object). This is a custom method which provides an 'in' to a
360 * Whenever the mouse cursor is moved over a matched
361 * element, the first specified function is fired. Whenever the mouse
362 * moves off of the element, the second specified function fires.
363 * Additionally, checks are in place to see if the mouse is still within
364 * the specified element itself (for example, an image inside of a div),
365 * and if it is, it will continue to 'hover', and not move out
366 * (a common error in using a mouseout event handler).
368 * @example $("p").hover(function(){
369 * $(this).addClass("over");
371 * $(this).addClass("out");
376 * @param Function over The function to fire whenever the mouse is moved over a matched element.
377 * @param Function out The function to fire whenever the mouse is moved off of a matched element.
380 hover: function(f,g) {
382 // A private function for handling mouse 'hovering'
383 function handleHover(e) {
384 // Check if mouse(over|out) are still within the same parent element
385 var p = (e.type == "mouseover" ? e.fromElement : e.toElement) || e.relatedTarget;
387 // Traverse up the tree
388 while ( p && p != this ) try { p = p.parentNode } catch(e) { p = this; };
390 // If we actually just moused on to a sub-element, ignore it
391 if ( p == this ) return false;
393 // Execute the right function
394 return (e.type == "mouseover" ? f : g).apply(this, [e]);
397 // Bind the function to the two event listeners
398 return this.mouseover(handleHover).mouseout(handleHover);
402 * Bind a function to be executed whenever the DOM is ready to be
403 * traversed and manipulated. This is probably the most important
404 * function included in the event module, as it can greatly improve
405 * the response times of your web applications.
407 * In a nutshell, this is a solid replacement for using window.onload,
408 * and attaching a function to that. By using this method, your bound Function
409 * will be called the instant the DOM is ready to be read and manipulated,
410 * which is exactly what 99.99% of all Javascript code needs to run.
412 * There is one argument passed to the ready event handler: A reference to
413 * the jQuery function. You can name that argument whatever you like, and
414 * can therefore stick with the $ alias without risc of naming collisions.
416 * Please ensure you have no code in your <body> onload event handler,
417 * otherwise $(document).ready() may not fire.
419 * You can have as many $(document).ready events on your page as you like.
420 * The functions are then executed in the order they were added.
422 * @example $(document).ready(function(){ Your code here... });
424 * @example jQuery(function($) {
425 * // Your code using failsafe $ alias here...
427 * @desc Uses both the shortcut for $(document).ready() and the argument
428 * to write failsafe jQuery code using the $ alias, without relying on the
433 * @param Function fn The function to be executed when the DOM is ready.
435 * @see $.noConflict()
439 // If the DOM is already ready
440 if ( jQuery.isReady )
441 // Execute the function immediately
442 f.apply( document, [jQuery] );
444 // Otherwise, remember the function for later
446 // Add the function to the wait list
447 jQuery.readyList.push( function() { return f.apply(this, [jQuery]) } );
456 * All the code that makes DOM Ready work nicely.
461 // Handle when the DOM is ready
463 // Make sure that the DOM is not already loaded
464 if ( !jQuery.isReady ) {
465 // Remember that the DOM is ready
466 jQuery.isReady = true;
468 // If there are functions bound, to execute
469 if ( jQuery.readyList ) {
470 // Execute all of them
471 for ( var i = 0; i < jQuery.readyList.length; i++ )
472 jQuery.readyList[i].apply( document );
474 // Reset the list of functions
475 jQuery.readyList = null;
477 // Remove event lisenter to avoid memory leak
478 if ( jQuery.browser.mozilla || jQuery.browser.opera )
479 document.removeEventListener( "DOMContentLoaded", jQuery.ready, false );
487 * Bind a function to the scroll event of each matched element.
489 * @example $("p").scroll( function() { alert("Hello"); } );
490 * @before <p>Hello</p>
491 * @result <p onscroll="alert('Hello');">Hello</p>
495 * @param Function fn A function to bind to the scroll event on each of the matched elements.
500 * Bind a function to the submit event of each matched element.
502 * @example $("#myform").submit( function() {
503 * return $("input", this).val().length > 0;
505 * @before <form id="myform"><input /></form>
506 * @desc Prevents the form submission when the input has no value entered.
510 * @param Function fn A function to bind to the submit event on each of the matched elements.
515 * Trigger the submit event of each matched element. This causes all of the functions
516 * that have been bound to thet submit event to be executed.
518 * Note: This does not execute the submit method of the form element! If you need to
519 * submit the form via code, you have to use the DOM method, eg. $("form")[0].submit();
521 * @example $("form").submit();
522 * @desc Triggers all submit events registered for forms, but does not submit the form
530 * Bind a function to the focus event of each matched element.
532 * @example $("p").focus( function() { alert("Hello"); } );
533 * @before <p>Hello</p>
534 * @result <p onfocus="alert('Hello');">Hello</p>
538 * @param Function fn A function to bind to the focus event on each of the matched elements.
543 * Trigger the focus event of each matched element. This causes all of the functions
544 * that have been bound to thet focus event to be executed.
546 * Note: This does not execute the focus method of the underlying elements! If you need to
547 * focus an element via code, you have to use the DOM method, eg. $("#myinput")[0].focus();
549 * @example $("p").focus();
550 * @before <p onfocus="alert('Hello');">Hello</p>
551 * @result alert('Hello');
559 * Bind a function to the keydown event of each matched element.
561 * @example $("p").keydown( function() { alert("Hello"); } );
562 * @before <p>Hello</p>
563 * @result <p onkeydown="alert('Hello');">Hello</p>
567 * @param Function fn A function to bind to the keydown event on each of the matched elements.
572 * Bind a function to the dblclick event of each matched element.
574 * @example $("p").dblclick( function() { alert("Hello"); } );
575 * @before <p>Hello</p>
576 * @result <p ondblclick="alert('Hello');">Hello</p>
580 * @param Function fn A function to bind to the dblclick event on each of the matched elements.
585 * Bind a function to the keypress event of each matched element.
587 * @example $("p").keypress( function() { alert("Hello"); } );
588 * @before <p>Hello</p>
589 * @result <p onkeypress="alert('Hello');">Hello</p>
593 * @param Function fn A function to bind to the keypress event on each of the matched elements.
598 * Bind a function to the error event of each matched element.
600 * @example $("p").error( function() { alert("Hello"); } );
601 * @before <p>Hello</p>
602 * @result <p onerror="alert('Hello');">Hello</p>
606 * @param Function fn A function to bind to the error event on each of the matched elements.
611 * Bind a function to the blur event of each matched element.
613 * @example $("p").blur( function() { alert("Hello"); } );
614 * @before <p>Hello</p>
615 * @result <p onblur="alert('Hello');">Hello</p>
619 * @param Function fn A function to bind to the blur event on each of the matched elements.
624 * Trigger the blur event of each matched element. This causes all of the functions
625 * that have been bound to thet blur event to be executed.
627 * Note: This does not execute the blur method of the underlying elements! If you need to
628 * blur an element via code, you have to use the DOM method, eg. $("#myinput")[0].blur();
630 * @example $("p").blur();
631 * @before <p onblur="alert('Hello');">Hello</p>
632 * @result alert('Hello');
640 * Bind a function to the load event of each matched element.
642 * @example $("p").load( function() { alert("Hello"); } );
643 * @before <p>Hello</p>
644 * @result <p onload="alert('Hello');">Hello</p>
648 * @param Function fn A function to bind to the load event on each of the matched elements.
653 * Bind a function to the select event of each matched element.
655 * @example $("p").select( function() { alert("Hello"); } );
656 * @before <p>Hello</p>
657 * @result <p onselect="alert('Hello');">Hello</p>
661 * @param Function fn A function to bind to the select event on each of the matched elements.
666 * Trigger the select event of each matched element. This causes all of the functions
667 * that have been bound to thet select event to be executed.
669 * @example $("p").select();
670 * @before <p onselect="alert('Hello');">Hello</p>
671 * @result alert('Hello');
679 * Bind a function to the mouseup event of each matched element.
681 * @example $("p").mouseup( function() { alert("Hello"); } );
682 * @before <p>Hello</p>
683 * @result <p onmouseup="alert('Hello');">Hello</p>
687 * @param Function fn A function to bind to the mouseup event on each of the matched elements.
692 * Bind a function to the unload event of each matched element.
694 * @example $("p").unload( function() { alert("Hello"); } );
695 * @before <p>Hello</p>
696 * @result <p onunload="alert('Hello');">Hello</p>
700 * @param Function fn A function to bind to the unload event on each of the matched elements.
705 * Bind a function to the change event of each matched element.
707 * @example $("p").change( function() { alert("Hello"); } );
708 * @before <p>Hello</p>
709 * @result <p onchange="alert('Hello');">Hello</p>
713 * @param Function fn A function to bind to the change event on each of the matched elements.
718 * Bind a function to the mouseout event of each matched element.
720 * @example $("p").mouseout( function() { alert("Hello"); } );
721 * @before <p>Hello</p>
722 * @result <p onmouseout="alert('Hello');">Hello</p>
726 * @param Function fn A function to bind to the mouseout event on each of the matched elements.
731 * Bind a function to the keyup event of each matched element.
733 * @example $("p").keyup( function() { alert("Hello"); } );
734 * @before <p>Hello</p>
735 * @result <p onkeyup="alert('Hello');">Hello</p>
739 * @param Function fn A function to bind to the keyup event on each of the matched elements.
744 * Bind a function to the click event of each matched element.
746 * @example $("p").click( function() { alert("Hello"); } );
747 * @before <p>Hello</p>
748 * @result <p onclick="alert('Hello');">Hello</p>
752 * @param Function fn A function to bind to the click event on each of the matched elements.
757 * Trigger the click event of each matched element. This causes all of the functions
758 * that have been bound to thet click event to be executed.
760 * @example $("p").click();
761 * @before <p onclick="alert('Hello');">Hello</p>
762 * @result alert('Hello');
770 * Bind a function to the resize event of each matched element.
772 * @example $("p").resize( function() { alert("Hello"); } );
773 * @before <p>Hello</p>
774 * @result <p onresize="alert('Hello');">Hello</p>
778 * @param Function fn A function to bind to the resize event on each of the matched elements.
783 * Bind a function to the mousemove event of each matched element.
785 * @example $("p").mousemove( function() { alert("Hello"); } );
786 * @before <p>Hello</p>
787 * @result <p onmousemove="alert('Hello');">Hello</p>
791 * @param Function fn A function to bind to the mousemove event on each of the matched elements.
796 * Bind a function to the mousedown event of each matched element.
798 * @example $("p").mousedown( function() { alert("Hello"); } );
799 * @before <p>Hello</p>
800 * @result <p onmousedown="alert('Hello');">Hello</p>
804 * @param Function fn A function to bind to the mousedown event on each of the matched elements.
809 * Bind a function to the mouseover event of each matched element.
811 * @example $("p").mouseover( function() { alert("Hello"); } );
812 * @before <p>Hello</p>
813 * @result <p onmouseover="alert('Hello');">Hello</p>
817 * @param Function fn A function to bind to the mousedown event on each of the matched elements.
820 jQuery.each( ("blur,focus,load,resize,scroll,unload,click,dblclick," +
821 "mousedown,mouseup,mousemove,mouseover,mouseout,change,select," +
822 "submit,keydown,keypress,keyup,error").split(","), function(i,o){
824 // Handle event binding
825 jQuery.fn[o] = function(f){
826 return f ? this.bind(o, f) : this.trigger(o);
831 // If Mozilla is used
832 if ( jQuery.browser.mozilla || jQuery.browser.opera )
833 // Use the handy event callback
834 document.addEventListener( "DOMContentLoaded", jQuery.ready, false );
836 // If IE is used, use the excellent hack by Matthias Miller
837 // http://www.outofhanwell.com/blog/index.php?title=the_window_onload_problem_revisited
838 else if ( jQuery.browser.msie ) {
840 // Only works if you document.write() it
841 document.write("<scr" + "ipt id=__ie_init defer=true " +
842 "src=//:><\/script>");
844 // Use the defer script hack
845 var script = document.getElementById("__ie_init");
847 // script does not exist if jQuery is loaded dynamically
849 script.onreadystatechange = function() {
850 if ( this.readyState != "complete" ) return;
851 this.parentNode.removeChild( this );
859 } else if ( jQuery.browser.safari )
860 // Continually check to see if the document.readyState is valid
861 jQuery.safariTimer = setInterval(function(){
862 // loaded and complete are both valid states
863 if ( document.readyState == "loaded" ||
864 document.readyState == "complete" ) {
866 // If either one are found, remove the timer
867 clearInterval( jQuery.safariTimer );
868 jQuery.safariTimer = null;
870 // and execute any waiting functions
875 // A fallback to window.onload, that will always work
876 jQuery.event.add( window, "load", jQuery.ready );
880 // Clean up after IE to avoid memory leaks
881 if (jQuery.browser.msie)
882 jQuery(window).one("unload", function() {
883 var global = jQuery.event.global;
884 for ( var type in global ) {
885 var els = global[type], i = els.length;
886 if ( i && type != 'unload' )
888 jQuery.event.remove(els[i-1], type);