Added a number of additional speed gains (we now hold our own against Dojo and DOMQue...
[jquery.git] / src / jquery / jquery.js
index e2a2a22..ddb08a4 100644 (file)
@@ -76,8 +76,12 @@ var $ = jQuery;
  * (usually consisting of CSS or XPath), which then finds all matching
  * elements.
  *
- * By default, $() looks for DOM elements within the context of the
- * current HTML document.
+ * By default, if no context is specified, $() looks for DOM elements within the context of the
+ * current HTML document. If you do specify a context, such as a DOM
+ * element or jQuery object, the expression will be matched against
+ * the contents of that context.
+ *
+ * See [[DOM/Traversing/Selectors]] for the allowed CSS/XPath syntax for expressions.
  *
  * @example $("div > p")
  * @desc Finds all p elements that are children of a div element.
@@ -102,10 +106,10 @@ var $ = jQuery;
 /**
  * Create DOM elements on-the-fly from the provided String of raw HTML.
  *
- * @example $("<div><p>Hello</p></div>").appendTo("#body")
+ * @example $("<div><p>Hello</p></div>").appendTo("body")
  * @desc Creates a div element (and all of its contents) dynamically, 
- * and appends it to the element with the ID of body. Internally, an
- * element is created and it's innerHTML property set to the given markup.
+ * and appends it to the body element. Internally, an
+ * element is created and its innerHTML property set to the given markup.
  * It is therefore both quite flexible and limited. 
  *
  * @name $
@@ -121,7 +125,7 @@ var $ = jQuery;
  * This function also accepts XML Documents and Window objects
  * as valid arguments (even though they are not DOM Elements).
  *
- * @example $(document.body).background( "black" );
+ * @example $(document.body).css( "background", "black" );
  * @desc Sets the background color of the page to black.
  *
  * @example $( myForm.elements ).hide()
@@ -137,8 +141,10 @@ var $ = jQuery;
  * A shorthand for $(document).ready(), allowing you to bind a function
  * to be executed when the DOM document has finished loading. This function
  * behaves just like $(document).ready(), in that it should be used to wrap
- * all of the other $() operations on your page. While this function is,
- * technically, chainable - there really isn't much use for chaining against it.
+ * other $() operations on your page that depend on the DOM being ready to be
+ * operated on. While this function is, technically, chainable - there really
+ * isn't much use for chaining against it.
+ *
  * You can have as many $(document).ready events on your page as you like.
  *
  * See ready(Function) for details about the ready event. 
@@ -175,7 +181,7 @@ jQuery.fn = jQuery.prototype = {
        jquery: "@VERSION",
 
        /**
-        * The number of elements currently matched.
+        * The number of elements currently matched. The size function will return the same value.
         *
         * @example $("img").length;
         * @before <img src="test1.jpg"/> <img src="test2.jpg"/>
@@ -188,7 +194,8 @@ jQuery.fn = jQuery.prototype = {
         */
 
        /**
-        * The number of elements currently matched.
+        * Get the number of elements currently matched. This returns the same
+        * number as the 'length' property of the jQuery object.
         *
         * @example $("img").size();
         * @before <img src="test1.jpg"/> <img src="test2.jpg"/>
@@ -205,10 +212,12 @@ jQuery.fn = jQuery.prototype = {
        length: 0,
 
        /**
-        * Access all matched elements. This serves as a backwards-compatible
+        * Access all matched DOM elements. This serves as a backwards-compatible
         * way of accessing all matched elements (other than the jQuery object
         * itself, which is, in fact, an array of elements).
         *
+        * It is useful if you need to operate on the DOM elements themselves instead of using built-in jQuery functions.
+        *
         * @example $("img").get();
         * @before <img src="test1.jpg"/> <img src="test2.jpg"/>
         * @result [ <img src="test1.jpg"/> <img src="test2.jpg"/> ]
@@ -220,12 +229,13 @@ jQuery.fn = jQuery.prototype = {
         */
 
        /**
-        * Access a single matched element. num is used to access the
-        * Nth element matched.
+        * Access a single matched DOM element at a specified index in the matched set.
+        * This allows you to extract the actual DOM element and operate on it
+        * directly without necessarily using jQuery functionality on it.
         *
         * @example $("img").get(0);
         * @before <img src="test1.jpg"/> <img src="test2.jpg"/>
-        * @result [ <img src="test1.jpg"/> ]
+        * @result <img src="test1.jpg"/>
         * @desc Selects all images in the document and returns the first one
         *
         * @name get
@@ -286,11 +296,11 @@ jQuery.fn = jQuery.prototype = {
         * Execute a function within the context of every matched element.
         * This means that every time the passed-in function is executed
         * (which is once for every element matched) the 'this' keyword
-        * points to the specific element.
+        * points to the specific DOM element.
         *
         * Additionally, the function, when executed, is passed a single
         * argument representing the position of the element in the matched
-        * set.
+        * set (integer, zero-index).
         *
         * @example $("img").each(function(i){
         *   this.src = "test" + i + ".jpg";
@@ -346,6 +356,9 @@ jQuery.fn = jQuery.prototype = {
         * This method makes it easy to retrieve a property value
         * from the first matched element.
         *
+        * If the element does not have an attribute with such a
+        * name, undefined is returned.
+        *
         * @example $("img").attr("src");
         * @before <img src="test.jpg"/>
         * @result test.jpg
@@ -377,8 +390,6 @@ jQuery.fn = jQuery.prototype = {
        /**
         * Set a single property to a value, on all matched elements.
         *
-        * Can compute values provided as ${formula}, see second example.
-        *
         * Note that you can't set the name property of input elements in IE.
         * Use $(html) or .append(html) or .html(html) to create elements
         * on the fly including the name property.
@@ -388,11 +399,6 @@ jQuery.fn = jQuery.prototype = {
         * @result <img src="test.jpg"/>
         * @desc Sets src attribute to all images.
         *
-        * @example $("img").attr("title", "${this.src}");
-        * @before <img src="test.jpg" />
-        * @result <img src="test.jpg" title="test.jpg" />
-        * @desc Sets title attribute from src attribute, a shortcut for attr(String,Function)
-        *
         * @name attr
         * @type jQuery
         * @param String key The name of the property to set.
@@ -403,7 +409,9 @@ jQuery.fn = jQuery.prototype = {
        /**
         * Set a single property to a computed value, on all matched elements.
         *
-        * Instead of a value, a function is provided, that computes the value.
+        * Instead of supplying a string value as described
+        * [[DOM/Attributes#attr.28_key.2C_value_.29|above]],
+        * a function is provided that computes the value.
         *
         * @example $("img").attr("title", function() { return this.src });
         * @before <img src="test.jpg" />
@@ -606,10 +614,13 @@ jQuery.fn = jQuery.prototype = {
         */
        wrap: function() {
                // The elements to wrap the target around
-               var a = jQuery.clean(arguments);
+               var a, args = arguments;
 
                // Wrap each of the matched elements individually
                return this.each(function(){
+                       if ( !a )
+                               a = jQuery.clean(args, this.ownerDocument);
+
                        // Clone the structure that we're using to wrap
                        var b = a[0].cloneNode(true);
 
@@ -760,12 +771,17 @@ jQuery.fn = jQuery.prototype = {
        },
 
        /**
-        * End the most recent 'destructive' operation, reverting the list of matched elements
-        * back to its previous state. After an end operation, the list of matched elements will
-        * revert to the last state of matched elements.
+        * Revert the most recent 'destructive' operation, changing the set of matched elements
+        * to its previous state (right before the destructive operation).
         *
         * If there was no destructive operation before, an empty set is returned.
         *
+        * A 'destructive' operation is any operation that changes the set of
+        * matched jQuery elements. These functions are: <code>add</code>,
+        * <code>children</code>, <code>clone</code>, <code>filter</code>,
+        * <code>find</code>, <code>not</code>, <code>next</code>,
+        * <code>parent</code>, <code>parents</code>, <code>prev</code> and <code>siblings</code>.
+        *
         * @example $("p").find("span").end();
         * @before <p><span>Hello</span>, how are you?</p>
         * @result [ <p>...</p> ]
@@ -801,9 +817,9 @@ jQuery.fn = jQuery.prototype = {
         * @cat DOM/Traversing
         */
        find: function(t) {
-               return this.pushStack( jQuery.map( this, function(a){
+               return this.pushStack( jQuery.unique( jQuery.map( this, function(a){
                        return jQuery.find(t,a);
-               }), t );
+               }) ), t );
        },
 
        /**
@@ -824,7 +840,9 @@ jQuery.fn = jQuery.prototype = {
         */
        clone: function(deep) {
                return this.pushStack( jQuery.map( this, function(a){
-                       return a.cloneNode( deep != undefined ? deep : true );
+                       var a = a.cloneNode( deep != undefined ? deep : true );
+                       a.$events = null; // drop $events expando to avoid firing incorrect events
+                       return a;
                }) );
        },
 
@@ -914,6 +932,9 @@ jQuery.fn = jQuery.prototype = {
         * of matched elements. This method is used to remove one or more
         * elements from a jQuery object.
         *
+        * Please note: the expression cannot use a reference to the
+        * element name. See the two examples below.
+        *
         * @example $("p").not( $("div p.selected") )
         * @before <div><p>Hello</p><p class="selected">Hello Again</p></div>
         * @result [ <p>Hello</p> ]
@@ -942,8 +963,12 @@ jQuery.fn = jQuery.prototype = {
         * to the set of matched elements.
         *
         * @example $("p").add("span")
-        * @before <p>Hello</p><span>Hello Again</span>
-        * @result [ <p>Hello</p>, <span>Hello Again</span> ]
+        * @before (HTML) <p>Hello</p><span>Hello Again</span>
+        * @result (jQuery object matching 2 elements) [ <p>Hello</p>, <span>Hello Again</span> ]
+        * @desc Compare the above result to the result of <code>$('p')</code>,
+        * which would just result in <code><nowiki>[ <p>Hello</p> ]</nowiki></code>.
+        * Using add(), matched elements of <code>$('span')</code> are simply
+        * added to the returned jQuery-object.
         *
         * @name add
         * @type jQuery
@@ -1016,11 +1041,18 @@ jQuery.fn = jQuery.prototype = {
         * @cat DOM/Traversing
         */
        is: function(expr) {
-               return expr ? jQuery.filter(expr,this).r.length > 0 : false;
+               return expr ? jQuery.multiFilter(expr,this).length > 0 : false;
        },
        
        /**
-        * Get the current value of the first matched element.
+        * Get the content of the value attribute of the first matched element.
+        *
+        * Use caution when relying on this function to check the value of
+        * multiple-select elements and checkboxes in a form. While it will
+        * still work as intended, it may not accurately represent the value
+        * the server will receive because these elements may send an array
+        * of values. For more robust handling of field values, see the
+        * [http://www.malsup.com/jquery/form/#fields fieldValue function of the Form Plugin].
         *
         * @example $("input").val();
         * @before <input type="text" value="some text"/>
@@ -1032,7 +1064,7 @@ jQuery.fn = jQuery.prototype = {
         */
        
        /**
-        * Set the value of every matched element.
+        *      Set the value attribute of every matched element.
         *
         * @example $("input").val("test");
         * @before <input type="text" value="some text"/>
@@ -1092,12 +1124,15 @@ jQuery.fn = jQuery.prototype = {
         * @cat Core
         */
        domManip: function(args, table, dir, fn){
-               var clone = this.length > 1; 
-               var a = jQuery.clean(args);
-               if ( dir < 0 )
-                       a.reverse();
+               var clone = this.length > 1, a; 
 
                return this.each(function(){
+                       if ( !a ) {
+                               a = jQuery.clean(args, this.ownerDocument);
+                               if ( dir < 0 )
+                                       a.reverse();
+                       }
+
                        var obj = this;
 
                        if ( table && jQuery.nodeName(this, "table") && jQuery.nodeName(a[0], "tr") )
@@ -1113,7 +1148,7 @@ jQuery.fn = jQuery.prototype = {
 
 /**
  * Extends the jQuery object itself. Can be used to add functions into
- * the jQuery namespace and to add plugin methods (plugins).
+ * the jQuery namespace and to [[Plugins/Authoring|add plugin methods]] (plugins).
  * 
  * @example jQuery.fn.extend({
  *   check: function() {
@@ -1225,8 +1260,13 @@ jQuery.extend({
        // This may seem like some crazy code, but trust me when I say that this
        // is the only cross-browser way to do this. --John
        isFunction: function( fn ) {
-               return !!fn && typeof fn != "string" &&
-                       typeof fn[0] == "undefined" && /function/i.test( fn + "" );
+               return !!fn && typeof fn != "string" && !fn.nodeName && 
+                       fn.constructor != Array && /function/i.test( fn + "" );
+       },
+       
+       // check if an element is in a XML document
+       isXMLDoc: function(elem) {
+               return elem.tagName && elem.ownerDocument && !elem.ownerDocument.body;
        },
 
        nodeName: function( elem, name ) {
@@ -1234,7 +1274,7 @@ jQuery.extend({
        },
 
        /**
-        * A generic iterator function, which can be used to seemlessly
+        * A generic iterator function, which can be used to seamlessly
         * iterate over both objects and arrays. This function is not the same
         * as $().each() - which is used to iterate, exclusively, over a jQuery
         * object. This function can be used to iterate over anything.
@@ -1275,16 +1315,15 @@ jQuery.extend({
        prop: function(elem, value, type, index, prop){
                        // Handle executable functions
                        if ( jQuery.isFunction( value ) )
-                               return value.call( elem, [index] );
+                               value = value.call( elem, [index] );
                                
                        // exclude the following css properties to add px
                        var exclude = /z-?index|font-?weight|opacity|zoom|line-?height/i;
 
                        // Handle passing in a number to a CSS property
-                       if ( value && value.constructor == Number && type == "curCSS" && !exclude.test(prop) )
-                               return value + "px";
-
-                       return value;
+                       return value && value.constructor == Number && type == "curCSS" && !exclude.test(prop) ?
+                               value + "px" :
+                               value;
        },
 
        className: {
@@ -1306,8 +1345,7 @@ jQuery.extend({
 
                // internal only, use is(".class")
                has: function( t, c ) {
-                       t = t.className || t;
-                       return t && new RegExp("(^|\\s)" + c + "(\\s|$)").test( t );
+                       return jQuery.inArray( c, (t.className || t).toString().split(/\s+/) ) > -1;
                }
        },
 
@@ -1367,12 +1405,14 @@ jQuery.extend({
 
        curCSS: function(elem, prop, force) {
                var ret;
+
+               if (prop == "opacity" && jQuery.browser.msie) {
+                       ret = jQuery.attr(elem.style, "opacity");
+                       return ret == "" ? "1" : ret;
+               }
                
-               if (prop == "opacity" && jQuery.browser.msie)
-                       return jQuery.attr(elem.style, "opacity");
-                       
                if (prop == "float" || prop == "cssFloat")
-                   prop = jQuery.browser.msie ? "styleFloat" : "cssFloat";
+                       prop = jQuery.browser.msie ? "styleFloat" : "cssFloat";
 
                if (!force && elem.style[prop])
                        ret = elem.style[prop];
@@ -1396,17 +1436,16 @@ jQuery.extend({
                                });
 
                } else if (elem.currentStyle) {
-
                        var newProp = prop.replace(/\-(\w)/g,function(m,c){return c.toUpperCase();});
                        ret = elem.currentStyle[prop] || elem.currentStyle[newProp];
-                       
                }
 
                return ret;
        },
        
-       clean: function(a) {
+       clean: function(a, doc) {
                var r = [];
+               doc = doc || document;
 
                jQuery.each( a, function(i,arg){
                        if ( !arg ) return;
@@ -1417,7 +1456,7 @@ jQuery.extend({
                         // Convert html string into DOM nodes
                        if ( typeof arg == "string" ) {
                                // Trim whitespace, otherwise indexOf won't work as expected
-                               var s = jQuery.trim(arg), div = document.createElement("div"), tb = [];
+                               var s = jQuery.trim(arg), div = doc.createElement("div"), tb = [];
 
                                var wrap =
                                         // option or optgroup
@@ -1437,7 +1476,7 @@ jQuery.extend({
                                        [0,"",""];
 
                                // Go to html and back, then peel off extra wrappers
-                               div.innerHTML = wrap[1] + s + wrap[2];
+                               div.innerHTML = wrap[1] + arg + wrap[2];
                                
                                // Move to the right depth
                                while ( wrap[0]-- )
@@ -1460,13 +1499,13 @@ jQuery.extend({
                                        
                                }
                                
-                               arg = div.childNodes;
+                               arg = jQuery.makeArray( div.childNodes );
                        }
 
-                       if ( arg.length === 0 )
+                       if ( arg.length === 0 && !jQuery.nodeName(arg, "form") )
                                return;
                        
-                       if ( arg[0] == undefined )
+                       if ( arg[0] == undefined || jQuery.nodeName(arg, "form") )
                                r.push( arg );
                        else
                                r = jQuery.merge( r, arg );
@@ -1477,7 +1516,7 @@ jQuery.extend({
        },
        
        attr: function(elem, name, value){
-               var fix = {
+               var fix = jQuery.isXMLDoc(elem) ? {} : {
                        "for": "htmlFor",
                        "class": "className",
                        "float": jQuery.browser.msie ? "styleFloat" : "cssFloat",
@@ -1492,23 +1531,21 @@ jQuery.extend({
                };
                
                // IE actually uses filters for opacity ... elem is actually elem.style
-               if ( name == "opacity" && jQuery.browser.msie && value != undefined ) {
-                       // IE has trouble with opacity if it does not have layout
-                       // Force it by setting the zoom level
-                       elem.zoom = 1; 
-
-                       // Set the alpha filter to set the opacity
-                       return elem.filter = elem.filter.replace(/alpha\([^\)]*\)/gi,"") +
-                               ( value == 1 ? "" : "alpha(opacity=" + value * 100 + ")" );
+               if ( name == "opacity" && jQuery.browser.msie ) {
+                       if ( value != undefined ) {
+                               // IE has trouble with opacity if it does not have layout
+                               // Force it by setting the zoom level
+                               elem.zoom = 1; 
+
+                               // Set the alpha filter to set the opacity
+                               elem.filter = (elem.filter || "").replace(/alpha\([^)]*\)/,"") +
+                                       (parseFloat(value).toString() == "NaN" ? "" : "alpha(opacity=" + value * 100 + ")");
+                       }
 
-               } else if ( name == "opacity" && jQuery.browser.msie )
                        return elem.filter ? 
-                               parseFloat( elem.filter.match(/alpha\(opacity=(.*)\)/)[1] ) / 100 : 1;
+                               (parseFloat( elem.filter.match(/opacity=([^)]*)/)[1] ) / 100).toString() : "";
+               }
                
-               // Mozilla doesn't play well with opacity 1
-               if ( name == "opacity" && jQuery.browser.mozilla && value == 1 )
-                       value = 0.9999;
-
                // Certain attributes only work when accessed via the old DOM 0 way
                if ( fix[name] ) {
                        if ( value != undefined ) elem[fix[name]] = value;
@@ -1520,8 +1557,11 @@ jQuery.extend({
                // IE elem.getAttribute passes even for style
                else if ( elem.tagName ) {
                        if ( value != undefined ) elem.setAttribute( name, value );
+                       if ( jQuery.browser.msie && /href|src/.test(name) && !jQuery.isXMLDoc(elem) ) 
+                               return elem.getAttribute( name, 2 );
                        return elem.getAttribute( name );
 
+               // elem is actually elem.style ... set the style
                } else {
                        name = name.replace(/-([a-z])/ig,function(z,b){return b.toUpperCase();});
                        if ( value != undefined ) elem[name] = value;
@@ -1547,7 +1587,8 @@ jQuery.extend({
        makeArray: function( a ) {
                var r = [];
 
-               if ( a.constructor != Array )
+               // Need to use typeof to fight Safari childNodes crashes
+               if ( typeof a != "array" )
                        for ( var i = 0, al = a.length; i < al; i++ )
                                r.push( a[i] );
                else
@@ -1585,19 +1626,27 @@ jQuery.extend({
         * @cat JavaScript
         */
        merge: function(first, second) {
-               var r = [].slice.call( first, 0 );
+               // We have to loop this way because IE & Opera overwrite the length
+               // expando of getElementsByTagName
+               for ( var i = 0; second[i]; i++ )
+                       first.push(second[i]);
+               return first;
+       },
 
-               // Now check for duplicates between the two arrays
-               // and only add the unique items
-               for ( var i = 0, sl = second.length; i < sl; i++ )
-                       // Check for duplicates
-                       if ( jQuery.inArray( second[i], r ) == -1 )
-                               // The item is unique, add it
-                               first.push( second[i] );
+       unique: function(first) {
+               var r = [], num = jQuery.mergeNum++;
 
-               return first;
+               for ( var i = 0, fl = first.length; i < fl; i++ )
+                       if ( first[i].mergeNum != num ) {
+                               first[i].mergeNum = num;
+                               r.push(first[i]);
+                       }
+
+               return r;
        },
 
+       mergeNum: 0,
+
        /**
         * Filter items out of an array, by using a filter function.
         *
@@ -1691,17 +1740,7 @@ jQuery.extend({
                        }
                }
 
-               var r = result.length ? [ result[0] ] : [];
-
-               check: for ( var i = 1, rl = result.length; i < rl; i++ ) {
-                       for ( var j = 0; j < i; j++ )
-                               if ( result[i] == r[j] )
-                                       continue check;
-
-                       r.push( result[i] );
-               }
-
-               return r;
+               return result;
        }
 });
 
@@ -1756,7 +1795,7 @@ new function() {
  * Get a set of elements containing the unique parents of the matched
  * set of elements.
  *
- * Can be filtered with an optional expressions.
+ * You may use an optional expression to filter the set of parent elements that will match.
  *
  * @example $("p").parent()
  * @before <div><p>Hello</p><p>Hello</p></div>
@@ -1778,7 +1817,7 @@ new function() {
  * Get a set of elements containing the unique ancestors of the matched
  * set of elements (except for the root element).
  *
- * Can be filtered with an optional expressions.
+ * The matched elements can be filtered with an optional expression.
  *
  * @example $("span").parents()
  * @before <html><body><div><p><span>Hello</span></p><span>Hello Again</span></div></body></html>
@@ -1800,9 +1839,10 @@ new function() {
  * Get a set of elements containing the unique next siblings of each of the
  * matched set of elements.
  *
- * It only returns the very next sibling, not all next siblings.
+ * It only returns the very next sibling for each element, not all
+ * next siblings.
  *
- * Can be filtered with an optional expressions.
+ * You may provide an optional expression to filter the match.
  *
  * @example $("p").next()
  * @before <p>Hello</p><p>Hello Again</p><div><span>And Again</span></div>
@@ -1824,9 +1864,9 @@ new function() {
  * Get a set of elements containing the unique previous siblings of each of the
  * matched set of elements.
  *
- * Can be filtered with an optional expressions.
+ * Use an optional expression to filter the matched set.
  *
- * It only returns the immediately previous sibling, not all previous siblings.
+ *     Only the immediately previous sibling is returned, not all previous siblings.
  *
  * @example $("p").prev()
  * @before <p>Hello</p><div><span>Hello Again</span></div><p>And Again</p>
@@ -1870,7 +1910,8 @@ new function() {
  * Get a set of elements containing all of the unique children of each of the
  * matched set of elements.
  *
- * Can be filtered with an optional expressions.
+ * This set can be filtered with an optional expression that will cause
+ * only elements matching the selector to be collected.
  *
  * @example $("div").children()
  * @before <p>Hello</p><div><span>Hello Again</span></div><p>And Again</p>
@@ -2223,7 +2264,7 @@ jQuery.each( [ "eq", "lt", "gt", "contains" ], function(i,n){
  */
 
 /**
- * Set the CSS width of every matched element. If no explicit unit
+ * Set the CSS height of every matched element. If no explicit unit
  * was specified (like 'em' or '%') then "px" is added to the width.
  *
  * @example $("p").height(20);