Test Paragraph.
* @result [ ]
*
- * @test cmpOK( $("div").get(0), "==", document.getElementById("main"), "Get A Single Element" );
- *
* @name get
* @type Element
* @param Number num Access the element in the Nth position.
* @cat Core
*/
-
+
/**
* Set the jQuery object to an array of elements.
*
@@ -274,13 +272,13 @@ jQuery.fn = jQuery.prototype = {
// look and feel like an array
this.length = 0;
[].push.apply( this, num );
-
+
return this;
} else
return num == undefined ?
// Return a 'clean' array
- jQuery.map( this, function(a){ return a } ) :
+ jQuery.merge( this, [] ) :
// Return just the object
this[num];
@@ -308,14 +306,6 @@ jQuery.fn = jQuery.prototype = {
* @before 
*
- * @test var div = $("div");
- * div.each(function(){this.foo = 'zoo';});
- * var pass = true;
- * for ( var i = 0; i < div.size(); i++ ) {
- * if ( div.get(i).foo != "zoo" ) pass = false;
- * }
- * ok( pass, "Execute a function, Relative" );
- *
* @name each
* @type jQuery
* @param Function fn A function to execute
@@ -325,6 +315,28 @@ jQuery.fn = jQuery.prototype = {
return jQuery.each( this, fn, args );
},
+ /**
+ * Searches every matched element for the object and returns
+ * the index of the element, if found, starting with zero.
+ * Returns -1 if the object wasn't found.
+ *
+ * @example $("*").index(document.getElementById('foobar'))
+ * @before
+ * @result 0
+ *
+ * @example $("*").index(document.getElementById('foo'))
+ * @before
+ * @result 2
+ *
+ * @example $("*").index(document.getElementById('bar'))
+ * @before
+ * @result -1
+ *
+ * @name index
+ * @type Number
+ * @param Object obj Object to search for
+ * @cat Core
+ */
index: function( obj ) {
var pos = -1;
this.each(function(i){
@@ -332,10 +344,10 @@ jQuery.fn = jQuery.prototype = {
});
return pos;
},
-
+
/**
* Access a property on the first matched element.
- * This method makes it easy to retreive a property value
+ * This method makes it easy to retrieve a property value
* from the first matched element.
*
* @example $("img").attr("src");
@@ -347,7 +359,7 @@ jQuery.fn = jQuery.prototype = {
* @param String name The name of the property to access.
* @cat DOM
*/
-
+
/**
* Set a hash of key/value object properties to all matched elements.
* This serves as the best way to set a large number of properties
@@ -357,18 +369,12 @@ jQuery.fn = jQuery.prototype = {
* @before
*
- * @test var pass = true;
- * $("div").attr({foo: 'baz', zoo: 'ping'}).each(function(){
- * if ( this.getAttribute('foo') != "baz" && this.getAttribute('zoo') != "ping" ) pass = false;
- * });
- * ok( pass, "Set Multiple Attributes" );
- *
* @name attr
* @type jQuery
* @param Hash prop A set of key/value pairs to set as object properties.
* @cat DOM
*/
-
+
/**
* Set a single property to a value, on all matched elements.
*
@@ -376,14 +382,6 @@ jQuery.fn = jQuery.prototype = {
* @before
*
- * @test var div = $("div");
- * div.attr("foo", "bar");
- * var pass = true;
- * for ( var i = 0; i < div.size(); i++ ) {
- * if ( div.get(i).getAttribute('foo') != "bar" ) pass = false;
- * }
- * ok( pass, "Set Attribute" );
- *
* @name attr
* @type jQuery
* @param String key The name of the property to set.
@@ -402,7 +400,7 @@ jQuery.fn = jQuery.prototype = {
type ? this.style : this,
prop, key[prop]
);
-
+
// See if we're setting a single key/value style
else
jQuery.attr(
@@ -410,26 +408,37 @@ jQuery.fn = jQuery.prototype = {
key, value
);
}) :
-
+
// Look for the case where we're accessing a style value
jQuery[ type || "attr" ]( this[0], key );
},
/**
* Access a style property on the first matched element.
- * This method makes it easy to retreive a style property value
+ * This method makes it easy to retrieve a style property value
* from the first matched element.
*
- * @example $("p").css("red");
+ * @example $("p").css("color");
* @before Test Paragraph.
* @result red + * @desc Retrieves the color style of the first paragraph + * + * @example $("p").css("fontWeight"); + * @beforeTest Paragraph.
+ * @result bold + * @desc Retrieves the font-weight style of the first paragraph. + * Note that for all style properties with a dash (like 'font-weight'), you have to + * write it in camelCase. In other words: Every time you have a '-' in a + * property, remove it and replace the next character with an uppercase + * representation of itself. Eg. fontWeight, fontSize, fontFamily, borderWidth, + * borderStyle, borderBottomWidth etc. * * @name css * @type Object * @param String name The name of the property to access. * @cat CSS */ - + /** * Set a hash of key/value style properties to all matched elements. * This serves as the best way to set a large number of style properties @@ -444,13 +453,14 @@ jQuery.fn = jQuery.prototype = { * @param Hash prop A set of key/value pairs to set as style properties. * @cat CSS */ - + /** * Set a single style property to a value, on all matched elements. * * @example $("p").css("color","red"); * @beforeTest Paragraph.
* @resultTest Paragraph.
+ * @desc Changes the color of all paragraphs to red * * @name css * @type jQuery @@ -461,9 +471,9 @@ jQuery.fn = jQuery.prototype = { css: function( key, value ) { return this.attr( key, value, "curCSS" ); }, - + /** - * Retreive the text contents of all matched elements. The result is + * Retrieve the text contents of all matched elements. The result is * a string that contains the combined text contents of all matched * elements. This method works on both HTML and XML documents. * @@ -487,41 +497,47 @@ jQuery.fn = jQuery.prototype = { } return t; }, - + /** * Wrap all matched elements with a structure of other elements. * This wrapping process is most useful for injecting additional * stucture into a document, without ruining the original semantic * qualities of a document. * - * This works by going through the first element + * This works by going through the first element * provided (which is generated, on the fly, from the provided HTML) - * and finds the deepest ancestor element within its + * and finds the deepest ancestor element within its * structure - it is that element that will en-wrap everything else. * + * This does not work with elements that contain text. Any necessary text + * must be added after the wrapping is done. + * * @example $("p").wrap(""); * @beforeTest Paragraph.
* @resultTest Paragraph.
Test Paragraph.
- * @resultTest Paragraph.
Test Paragraph.
+ * @result
*
* @name wrap
* @type jQuery
@@ -531,30 +547,30 @@ jQuery.fn = jQuery.prototype = {
wrap: function() {
// The elements to wrap the target around
var a = jQuery.clean(arguments);
-
+
// Wrap each of the matched elements individually
return this.each(function(){
// Clone the structure that we're using to wrap
var b = a[0].cloneNode(true);
-
+
// Insert it before the element to be wrapped
this.parentNode.insertBefore( b, this );
-
- // Find he deepest point in the wrap structure
+
+ // Find the deepest point in the wrap structure
while ( b.firstChild )
b = b.firstChild;
-
+
// Move the matched element to within the wrap structure
b.appendChild( this );
});
},
-
+
/**
* Append any number of elements to the inside of every matched elements,
* generated from the provided HTML.
- * This operation is similar to doing an appendChild to all the
+ * This operation is similar to doing an appendChild to all the
* specified elements, adding them into the document.
- *
+ *
* @example $("p").append("Hello");
* @before
I would like to say:
* @resultI would like to say: Hello
@@ -564,12 +580,12 @@ jQuery.fn = jQuery.prototype = { * @param String html A string of HTML, that will be created on the fly and appended to the target. * @cat DOM/Manipulation */ - + /** * Append an element to the inside of all matched elements. - * This operation is similar to doing an appendChild to all the + * This operation is similar to doing an appendChild to all the * specified elements, adding them into the document. - * + * * @example $("p").append( $("#foo")[0] ); * @beforeI would like to say:
Hello * @resultI would like to say: Hello
@@ -579,12 +595,12 @@ jQuery.fn = jQuery.prototype = { * @param Element elem A DOM element that will be appended. * @cat DOM/Manipulation */ - + /** * Append any number of elements to the inside of all matched elements. - * This operation is similar to doing an appendChild to all the + * This operation is similar to doing an appendChild to all the * specified elements, adding them into the document. - * + * * @example $("p").append( $("b") ); * @beforeI would like to say:
Hello * @resultI would like to say: Hello
@@ -599,13 +615,13 @@ jQuery.fn = jQuery.prototype = { this.appendChild( a ); }); }, - + /** * Prepend any number of elements to the inside of every matched elements, * generated from the provided HTML. - * This operation is the best way to insert dynamically created elements + * This operation is the best way to insert dynamically created elements * inside, at the beginning, of all the matched element. - * + * * @example $("p").prepend("Hello"); * @beforeI would like to say:
* @resultHelloI would like to say:
@@ -615,27 +631,27 @@ jQuery.fn = jQuery.prototype = { * @param String html A string of HTML, that will be created on the fly and appended to the target. * @cat DOM/Manipulation */ - + /** - * Append an element to the inside of all matched elements. - * This operation is the best way to insert an element inside, at the + * Prepend an element to the inside of all matched elements. + * This operation is the best way to insert an element inside, at the * beginning, of all the matched element. - * + * * @example $("p").prepend( $("#foo")[0] ); * @beforeI would like to say:
Hello * @resultHelloI would like to say:
- * + * * @name prepend * @type jQuery * @param Element elem A DOM element that will be appended. * @cat DOM/Manipulation */ - + /** - * Append any number of elements to the inside of all matched elements. - * This operation is the best way to insert a set of elements inside, at the + * Prepend any number of elements to the inside of all matched elements. + * This operation is the best way to insert a set of elements inside, at the * beginning, of all the matched element. - * + * * @example $("p").prepend( $("b") ); * @beforeI would like to say:
Hello * @resultHelloI would like to say:
@@ -650,11 +666,11 @@ jQuery.fn = jQuery.prototype = { this.insertBefore( a, this.firstChild ); }); }, - + /** - * Insert any number of dynamically generated elements before each of the + * Insert any number of dynamically generated elements before each of the * matched elements. - * + * * @example $("p").before("Hello"); * @beforeI would like to say:
* @result HelloI would like to say:
@@ -664,10 +680,10 @@ jQuery.fn = jQuery.prototype = { * @param String html A string of HTML, that will be created on the fly and appended to the target. * @cat DOM/Manipulation */ - + /** * Insert an element before each of the matched elements. - * + * * @example $("p").before( $("#foo")[0] ); * @beforeI would like to say:
Hello * @result HelloI would like to say:
@@ -677,10 +693,10 @@ jQuery.fn = jQuery.prototype = { * @param Element elem A DOM element that will be appended. * @cat DOM/Manipulation */ - + /** * Insert any number of elements before each of the matched elements. - * + * * @example $("p").before( $("b") ); * @beforeI would like to say:
Hello * @result HelloI would like to say:
@@ -695,11 +711,11 @@ jQuery.fn = jQuery.prototype = { this.parentNode.insertBefore( a, this ); }); }, - + /** - * Insert any number of dynamically generated elements after each of the + * Insert any number of dynamically generated elements after each of the * matched elements. - * + * * @example $("p").after("Hello"); * @beforeI would like to say:
* @resultI would like to say:
Hello @@ -709,10 +725,10 @@ jQuery.fn = jQuery.prototype = { * @param String html A string of HTML, that will be created on the fly and appended to the target. * @cat DOM/Manipulation */ - + /** * Insert an element after each of the matched elements. - * + * * @example $("p").after( $("#foo")[0] ); * @before HelloI would like to say:
* @resultI would like to say:
Hello @@ -722,10 +738,10 @@ jQuery.fn = jQuery.prototype = { * @param Element elem A DOM element that will be appended. * @cat DOM/Manipulation */ - + /** * Insert any number of elements after each of the matched elements. - * + * * @example $("p").after( $("b") ); * @before HelloI would like to say:
* @resultI would like to say:
Hello @@ -740,10 +756,10 @@ jQuery.fn = jQuery.prototype = { this.parentNode.insertBefore( a, this.nextSibling ); }); }, - + /** * 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 + * back to its previous state. After an end operation, the list of matched elements will * revert to the last state of matched elements. * * @example $("p").find("span").end(); @@ -755,15 +771,17 @@ jQuery.fn = jQuery.prototype = { * @cat DOM/Traversing */ end: function() { + if( !(this.stack && this.stack.length) ) + return this; return this.get( this.stack.pop() ); }, - + /** * Searches for all elements that match the specified expression. * This method is the optimal way of finding additional descendant * elements with which to process. * - * All searching is done using a jQuery expression. The expression can be + * All searching is done using a jQuery expression. The expression can be * written using CSS 1-3 Selector syntax, or basic XPath. * * @example $("p").find("span"); @@ -781,20 +799,35 @@ jQuery.fn = jQuery.prototype = { }), arguments ); }, + /** + * Create cloned copies of all matched DOM Elements. This does + * not create a cloned copy of this particular jQuery object, + * instead it creates duplicate copies of all DOM Elements. + * This is useful for moving copies of the elements to another + * location in the DOM. + * + * @example $("b").clone().prependTo("p"); + * @before Hello, how are you?
+ * @result HelloHello, how are you?
+ * + * @name clone + * @type jQuery + * @cat DOM/Manipulation + */ clone: function(deep) { return this.pushStack( jQuery.map( this, function(a){ return a.cloneNode( deep != undefined ? deep : true ); }), arguments ); }, - + /** - * Removes all elements from the set of matched elements that do not + * Removes all elements from the set of matched elements that do not * match the specified expression. This method is used to narrow down * the results of a search. * * All searching is done using a jQuery expression. The expression * can be written using CSS 1-3 Selector syntax, or basic XPath. - * + * * @example $("p").filter(".selected") * @beforeHello
How are you?
* @result $("p").filter(".selected") == [Hello
] @@ -807,8 +840,8 @@ jQuery.fn = jQuery.prototype = { /** * Removes all elements from the set of matched elements that do not - * match at least one of the expressions passed to the function. This - * method is used when you want to filter the set of matched elements + * match at least one of the expressions passed to the function. This + * method is used when you want to filter the set of matched elements * through more than one expression. * * Elements will be retained in the jQuery object if they match at @@ -830,17 +863,18 @@ jQuery.fn = jQuery.prototype = { for ( var i = 0; i < t.length; i++ ) if ( jQuery.filter(t[i],[a]).r.length ) return a; + return null; }) || t.constructor == Boolean && ( t ? this.get() : [] ) || - t.constructor == Function && + typeof t == "function" && jQuery.grep( this, t ) || jQuery.filter(t,this).r, arguments ); }, - + /** * Removes the specified Element from the set of matched elements. This * method is used to remove a single Element from a jQuery object. @@ -859,11 +893,10 @@ jQuery.fn = jQuery.prototype = { * Removes elements matching the specified expression from the set * of matched elements. This method is used to remove one or more * elements from a jQuery object. - * + * * @example $("p").not("#selected") * @beforeHello
Hello Again
* @result [Hello
] - * @test cmpOK($("#main > p#ap > a").not("#google").length, "==", 2, ".not") * * @name not * @type jQuery @@ -871,7 +904,7 @@ jQuery.fn = jQuery.prototype = { * @cat DOM/Traversing */ not: function(t) { - return this.pushStack( t.constructor == String ? + return this.pushStack( typeof t == "string" ? jQuery.filter(t,this,false).r : jQuery.grep(this,function(a){ return a != t; }), arguments ); }, @@ -918,26 +951,41 @@ jQuery.fn = jQuery.prototype = { * @cat DOM/Traversing */ add: function(t) { - return this.pushStack( jQuery.merge( this, t.constructor == String ? + return this.pushStack( jQuery.merge( this, typeof t == "string" ? jQuery.find(t) : t.constructor == Array ? t : [t] ), arguments ); }, - + /** - * A wrapper function for each() to be used by append and prepend. - * Handles cases where you're trying to modify the inner contents of - * a table, when you actually need to work with the tbody. + * Checks the current selection against an expression and returns true, + * if the selection fits the given expression. Does return false, if the + * selection does not fit or the expression is not valid. + * + * @example $("input[@type='checkbox']").parent().is("form") + * @before + * @result true + * @desc Returns true, because the parent of the input is a form element + * + * @example $("input[@type='checkbox']").parent().is("form") + * @before + * @result false + * @desc Returns false, because the parent of the input is a p element + * + * @example $("form").is(null) + * @before + * @result false + * @desc An invalid expression always returns false. * - * @member jQuery - * @param {String} expr The expression with which to filter + * @name is * @type Boolean + * @param String expr The expression with which to filter * @cat DOM/Traversing */ is: function(expr) { - return expr ? jQuery.filter(expr,this).r.length > 0 : this.length > 0; + return expr ? jQuery.filter(expr,this).r.length > 0 : false; }, /** - * + * * * @private * @name domManip @@ -951,11 +999,11 @@ jQuery.fn = jQuery.prototype = { domManip: function(args, table, dir, fn){ var clone = this.size() > 1; var a = jQuery.clean(args); - + return this.each(function(){ var obj = this; - - if ( table && this.nodeName == "TABLE" && a[0].nodeName != "THEAD" ) { + + if ( table && this.nodeName.toUpperCase() == "TABLE" && a[0].nodeName.toUpperCase() != "THEAD" ) { var tbody = this.getElementsByTagName("tbody"); if ( !tbody.length ) { @@ -971,9 +1019,9 @@ jQuery.fn = jQuery.prototype = { } }); }, - + /** - * + * * * @private * @name pushStack @@ -984,17 +1032,23 @@ jQuery.fn = jQuery.prototype = { */ pushStack: function(a,args) { var fn = args && args[args.length-1]; + var fn2 = args && args[args.length-2]; + + if ( fn && fn.constructor != Function ) fn = null; + if ( fn2 && fn2.constructor != Function ) fn2 = null; - if ( !fn || fn.constructor != Function ) { + if ( !fn ) { if ( !this.stack ) this.stack = []; this.stack.push( this.get() ); this.get( a ); } else { var old = this.get(); this.get( a ); - if ( fn.constructor == Function ) - this.each( fn ); - this.get( old ); + + if ( fn2 && a.length || !fn2 ) + this.each( fn2 || fn ).get( old ); + else + this.get( old ).each( fn ); } return this; @@ -1002,7 +1056,20 @@ jQuery.fn = jQuery.prototype = { }; /** + * Extends the jQuery object itself. Can be used to add both static + * functions and plugin methods. * + * @example $.fn.extend({ + * check: function() { + * this.each(function() { this.checked = true; }); + * ), + * uncheck: function() { + * this.each(function() { this.checked = false; }); + * } + * }); + * $("input[@type=checkbox]").check(); + * $("input[@type=radio]").uncheck(); + * @desc Adds two plugin methods. * * @private * @name extend @@ -1010,10 +1077,15 @@ jQuery.fn = jQuery.prototype = { * @type Object * @cat Core */ - + /** * Extend one object with another, returning the original, * modified, object. This is a great utility for simple inheritance. + * + * @example var settings = { validate: false, limit: 5, name: "foo" }; + * var options = { validate: true, name: "bar" }; + * jQuery.extend(settings, options); + * @result settings == { validate: true, limit: 5, name: "bar" } * * @name $.extend * @param Object obj The object to extend @@ -1022,8 +1094,17 @@ jQuery.fn = jQuery.prototype = { * @cat Javascript */ jQuery.extend = jQuery.fn.extend = function(obj,prop) { + // Watch for the case where null or undefined gets passed in by accident + if ( arguments.length > 1 && (prop === null || prop == undefined) ) + return obj; + + // If no property object was provided, then we're extending jQuery if ( !prop ) { prop = obj; obj = this; } + + // Extend the base object for ( var i in prop ) obj[i] = prop[i]; + + // Return the modified object return obj; }; @@ -1036,16 +1117,16 @@ jQuery.extend({ */ init: function(){ jQuery.initDone = true; - + jQuery.each( jQuery.macros.axis, function(i,n){ jQuery.fn[ i ] = function(a) { var ret = jQuery.map(this,n); - if ( a && a.constructor == String ) + if ( a && typeof a == "string" ) ret = jQuery.filter(a,ret).r; return this.pushStack( ret, arguments ); }; }); - + jQuery.each( jQuery.macros.to, function(i,n){ jQuery.fn[ i ] = function(){ var a = arguments; @@ -1055,7 +1136,7 @@ jQuery.extend({ }); }; }); - + jQuery.each( jQuery.macros.each, function(i,n){ jQuery.fn[ i ] = function() { return this.each( n, arguments ); @@ -1067,7 +1148,7 @@ jQuery.extend({ return this.filter( ":" + n + "(" + num + ")", fn ); }; }); - + jQuery.each( jQuery.macros.attr, function(i,n){ n = n || i; jQuery.fn[ i ] = function(h) { @@ -1076,7 +1157,7 @@ jQuery.extend({ this.attr( n, h ); }; }); - + jQuery.each( jQuery.macros.css, function(i,n){ jQuery.fn[ n ] = function(h) { return h == undefined ? @@ -1084,16 +1165,28 @@ jQuery.extend({ this.css( n, h ); }; }); - + }, - + /** * A generic iterator function, which can be used to seemlessly - * iterate over both objects and arrays. + * 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. + * + * @example $.each( [0,1,2], function(i){ + * alert( "Item #" + i + ": " + this ); + * }); + * @desc This is an example of iterating over the items in an array, accessing both the current item and its index. + * + * @example $.each( { name: "John", lang: "JS" }, function(i){ + * alert( "Name: " + i + ", Value: " + this ); + * }); + * @desc This is an example of iterating over the properties in an Object, accessing both the current item and its key. * * @name $.each * @param Object obj The object, or array, to iterate over. - * @param Object fn The function that will be executed on every object. + * @param Function fn The function that will be executed on every object. * @type Object * @cat Javascript */ @@ -1103,19 +1196,28 @@ jQuery.extend({ fn.apply( obj[i], args || [i, obj[i]] ); else for ( var i = 0; i < obj.length; i++ ) - fn.apply( obj[i], args || [i, obj[i]] ); + if ( fn.apply( obj[i], args || [i, obj[i]] ) === false ) break; return obj; }, - + className: { add: function(o,c){ if (jQuery.className.has(o,c)) return; o.className += ( o.className ? " " : "" ) + c; }, remove: function(o,c){ - o.className = !c ? "" : - o.className.replace( - new RegExp("(^|\\s*\\b[^-])"+c+"($|\\b(?=[^-]))", "g"), ""); + if( !c ) { + o.className = ""; + } else { + var classes = o.className.split(" "); + for(var i=0; iI would like to say:
* @resultI would like to say:
I would like to say:
Hello
* @result I would like to say:
HelloHello
I would like to say:
* @resultI would like to say:
Hello
@@ -1944,13 +2079,13 @@ jQuery.macros = {
* @cat DOM/Manipulation
*/
insertBefore: "before",
-
+
/**
* Insert all of the matched elements after another, specified, set of elements.
* This operation is, essentially, the reverse of doing a regular
* $(A).after(B), in that instead of inserting B after A, you're inserting
* A after B.
- *
+ *
* @example $("p").insertAfter("#foo");
* @before I would like to say:
Hello
* @result Hello
I would like to say:
@@ -1962,10 +2097,10 @@ jQuery.macros = { */ insertAfter: "after" }, - + /** * Get the current CSS width of the first matched element. - * + * * @example $("p").width(); * @beforeThis is just a test.
* @result "300px" @@ -1974,12 +2109,12 @@ jQuery.macros = { * @type String * @cat CSS */ - + /** * Set the CSS width of every matched element. Be sure to include - * the "px" (or other unit of measurement) after the number that you + * the "px" (or other unit of measurement) after the number that you * specify, otherwise you might get strange results. - * + * * @example $("p").width("20px"); * @beforeThis is just a test.
* @resultThis is just a test.
@@ -1989,10 +2124,10 @@ jQuery.macros = { * @param String val Set the CSS property to the specified value. * @cat CSS */ - + /** * Get the current CSS height of the first matched element. - * + * * @example $("p").height(); * @beforeThis is just a test.
* @result "14px" @@ -2001,12 +2136,12 @@ jQuery.macros = { * @type String * @cat CSS */ - + /** * Set the CSS height of every matched element. Be sure to include - * the "px" (or other unit of measurement) after the number that you + * the "px" (or other unit of measurement) after the number that you * specify, otherwise you might get strange results. - * + * * @example $("p").height("20px"); * @beforeThis is just a test.
* @resultThis is just a test.
@@ -2016,10 +2151,10 @@ jQuery.macros = { * @param String val Set the CSS property to the specified value. * @cat CSS */ - + /** * Get the current CSS top of the first matched element. - * + * * @example $("p").top(); * @beforeThis is just a test.
* @result "0px" @@ -2028,12 +2163,12 @@ jQuery.macros = { * @type String * @cat CSS */ - + /** * Set the CSS top of every matched element. Be sure to include - * the "px" (or other unit of measurement) after the number that you + * the "px" (or other unit of measurement) after the number that you * specify, otherwise you might get strange results. - * + * * @example $("p").top("20px"); * @beforeThis is just a test.
* @resultThis is just a test.
@@ -2043,10 +2178,10 @@ jQuery.macros = { * @param String val Set the CSS property to the specified value. * @cat CSS */ - + /** * Get the current CSS left of the first matched element. - * + * * @example $("p").left(); * @beforeThis is just a test.
* @result "0px" @@ -2055,12 +2190,12 @@ jQuery.macros = { * @type String * @cat CSS */ - + /** * Set the CSS left of every matched element. Be sure to include - * the "px" (or other unit of measurement) after the number that you + * the "px" (or other unit of measurement) after the number that you * specify, otherwise you might get strange results. - * + * * @example $("p").left("20px"); * @beforeThis is just a test.
* @resultThis is just a test.
@@ -2070,10 +2205,10 @@ jQuery.macros = { * @param String val Set the CSS property to the specified value. * @cat CSS */ - + /** * Get the current CSS position of the first matched element. - * + * * @example $("p").position(); * @beforeThis is just a test.
* @result "static" @@ -2082,10 +2217,10 @@ jQuery.macros = { * @type String * @cat CSS */ - + /** * Set the CSS position of every matched element. - * + * * @example $("p").position("relative"); * @beforeThis is just a test.
* @resultThis is just a test.
@@ -2095,10 +2230,10 @@ jQuery.macros = { * @param String val Set the CSS property to the specified value. * @cat CSS */ - + /** * Get the current CSS float of the first matched element. - * + * * @example $("p").float(); * @beforeThis is just a test.
* @result "none" @@ -2107,10 +2242,10 @@ jQuery.macros = { * @type String * @cat CSS */ - + /** * Set the CSS float of every matched element. - * + * * @example $("p").float("left"); * @beforeThis is just a test.
* @resultThis is just a test.
@@ -2120,10 +2255,10 @@ jQuery.macros = { * @param String val Set the CSS property to the specified value. * @cat CSS */ - + /** * Get the current CSS overflow of the first matched element. - * + * * @example $("p").overflow(); * @beforeThis is just a test.
* @result "none" @@ -2132,10 +2267,10 @@ jQuery.macros = { * @type String * @cat CSS */ - + /** * Set the CSS overflow of every matched element. - * + * * @example $("p").overflow("auto"); * @beforeThis is just a test.
* @resultThis is just a test.
@@ -2145,10 +2280,10 @@ jQuery.macros = { * @param String val Set the CSS property to the specified value. * @cat CSS */ - + /** * Get the current CSS color of the first matched element. - * + * * @example $("p").color(); * @beforeThis is just a test.
* @result "black" @@ -2157,10 +2292,10 @@ jQuery.macros = { * @type String * @cat CSS */ - + /** * Set the CSS color of every matched element. - * + * * @example $("p").color("blue"); * @beforeThis is just a test.
* @resultThis is just a test.
@@ -2170,22 +2305,22 @@ jQuery.macros = { * @param String val Set the CSS property to the specified value. * @cat CSS */ - + /** * Get the current CSS background of the first matched element. - * + * * @example $("p").background(); - * @beforeThis is just a test.
- * @result "" + * @beforeThis is just a test.
+ * @result "blue" * * @name background * @type String * @cat CSS */ - + /** * Set the CSS background of every matched element. - * + * * @example $("p").background("blue"); * @beforeThis is just a test.
* @resultThis is just a test.
@@ -2195,15 +2330,73 @@ jQuery.macros = { * @param String val Set the CSS property to the specified value. * @cat CSS */ - + css: "width,height,top,left,position,float,overflow,color,background".split(","), + /** + * Reduce the set of matched elements to a single element. + * The position of the element in the set of matched elements + * starts at 0 and goes to length - 1. + * + * @example $("p").eq(1) + * @beforeThis is just a test.
So is this
+ * @result [So is this
] + * + * @name eq + * @type jQuery + * @param Number pos The index of the element that you wish to limit to. + * @cat Core + */ + + /** + * Reduce the set of matched elements to all elements before a given position. + * The position of the element in the set of matched elements + * starts at 0 and goes to length - 1. + * + * @example $("p").lt(1) + * @beforeThis is just a test.
So is this
+ * @result [This is just a test.
] + * + * @name lt + * @type jQuery + * @param Number pos Reduce the set to all elements below this position. + * @cat Core + */ + + /** + * Reduce the set of matched elements to all elements after a given position. + * The position of the element in the set of matched elements + * starts at 0 and goes to length - 1. + * + * @example $("p").gt(0) + * @beforeThis is just a test.
So is this
+ * @result [So is this
] + * + * @name gt + * @type jQuery + * @param Number pos Reduce the set to all elements after this position. + * @cat Core + */ + + /** + * Filter the set of elements to those that contain the specified text. + * + * @example $("p").contains("test") + * @beforeThis is just a test.
So is this
+ * @result [This is just a test.
] + * + * @name contains + * @type jQuery + * @param String str The string that will be contained within the text of an element. + * @cat DOM/Traversing + */ + filter: [ "eq", "lt", "gt", "contains" ], attr: { /** * Get the current value of the first matched element. - * + * * @example $("input").val(); * @before * @result "some text" @@ -2212,11 +2405,11 @@ jQuery.macros = { * @type String * @cat DOM/Attributes */ - + /** * Set the value of every matched element. - * - * @example $("input").value("test"); + * + * @example $("input").val("test"); * @before * @result * @@ -2226,10 +2419,10 @@ jQuery.macros = { * @cat DOM/Attributes */ val: "value", - + /** * Get the html contents of the first matched element. - * + * * @example $("div").html(); * @before * @result @@ -2238,32 +2431,24 @@ jQuery.macros = { * @type String * @cat DOM/Attributes */ - + /** * Set the html contents of every matched element. - * + * * @example $("div").html("new stuff"); * @before * @resultnew stuff
*
- * @test var div = $("div");
- * div.html("test");
- * var pass = true;
- * for ( var i = 0; i < div.size(); i++ ) {
- * if ( div.get(i).childNodes.length == 0 ) pass = false;
- * }
- * ok( pass, "Set HTML" );
- *
* @name html
* @type jQuery
* @param String val Set the html contents to the specified value.
* @cat DOM/Attributes
*/
html: "innerHTML",
-
+
/**
* Get the current id of the first matched element.
- *
+ *
* @example $("input").id();
* @before
* @result "test"
@@ -2272,10 +2457,10 @@ jQuery.macros = {
* @type String
* @cat DOM/Attributes
*/
-
+
/**
* Set the id of every matched element.
- *
+ *
* @example $("input").id("newid");
* @before
* @result
@@ -2286,10 +2471,10 @@ jQuery.macros = {
* @cat DOM/Attributes
*/
id: null,
-
+
/**
* Get the current title of the first matched element.
- *
+ *
* @example $("img").title();
* @before
* @result "my image"
@@ -2298,10 +2483,10 @@ jQuery.macros = {
* @type String
* @cat DOM/Attributes
*/
-
+
/**
* Set the title of every matched element.
- *
+ *
* @example $("img").title("new title");
* @before
* @result
@@ -2312,10 +2497,10 @@ jQuery.macros = {
* @cat DOM/Attributes
*/
title: null,
-
+
/**
* Get the current name of the first matched element.
- *
+ *
* @example $("input").name();
* @before
* @result "username"
@@ -2324,10 +2509,10 @@ jQuery.macros = {
* @type String
* @cat DOM/Attributes
*/
-
+
/**
* Set the name of every matched element.
- *
+ *
* @example $("input").name("user");
* @before
* @result
@@ -2338,10 +2523,10 @@ jQuery.macros = {
* @cat DOM/Attributes
*/
name: null,
-
+
/**
* Get the current href of the first matched element.
- *
+ *
* @example $("a").href();
* @before my link
* @result "test.html"
@@ -2350,10 +2535,10 @@ jQuery.macros = {
* @type String
* @cat DOM/Attributes
*/
-
+
/**
* Set the href of every matched element.
- *
+ *
* @example $("a").href("test2.html");
* @before my link
* @result my link
@@ -2364,10 +2549,10 @@ jQuery.macros = {
* @cat DOM/Attributes
*/
href: null,
-
+
/**
* Get the current src of the first matched element.
- *
+ *
* @example $("img").src();
* @before
* @result "test.jpg"
@@ -2376,10 +2561,10 @@ jQuery.macros = {
* @type String
* @cat DOM/Attributes
*/
-
+
/**
* Set the src of every matched element.
- *
+ *
* @example $("img").src("test2.jpg");
* @before
* @result
@@ -2390,10 +2575,10 @@ jQuery.macros = {
* @cat DOM/Attributes
*/
src: null,
-
+
/**
* Get the current rel of the first matched element.
- *
+ *
* @example $("a").rel();
* @before my link
* @result "nofollow"
@@ -2402,10 +2587,10 @@ jQuery.macros = {
* @type String
* @cat DOM/Attributes
*/
-
+
/**
* Set the rel of every matched element.
- *
+ *
* @example $("a").rel("nofollow");
* @before my link
* @result my link
@@ -2417,7 +2602,7 @@ jQuery.macros = {
*/
rel: null
},
-
+
axis: {
/**
* Get a set of elements containing the unique parents of the matched
@@ -2453,7 +2638,7 @@ jQuery.macros = {
*
* @example $("span").ancestors()
* @before Hello
Hello Again...
, Hello
] + * @result [ ...,...
, Hello
] * * @name ancestors * @type jQuery @@ -2466,7 +2651,7 @@ jQuery.macros = { * * @example $("span").ancestors("p") * @beforeHello
Hello AgainHello
] + * @result [Hello
] * * @name ancestors * @type jQuery @@ -2474,14 +2659,14 @@ jQuery.macros = { * @cat DOM/Traversing */ ancestors: jQuery.parents, - + /** * Get a set of elements containing the unique ancestors of the matched * set of elements (except for the root element). * * @example $("span").ancestors() * @beforeHello
Hello Again...
, Hello
] + * @result [ ...,...
, Hello
] * * @name parents * @type jQuery @@ -2494,7 +2679,7 @@ jQuery.macros = { * * @example $("span").ancestors("p") * @beforeHello
Hello AgainHello
] + * @result [Hello
] * * @name parents * @type jQuery @@ -2504,9 +2689,9 @@ jQuery.macros = { parents: jQuery.parents, /** - * Get a set of elements containing the unique next siblings of each of the + * 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. * * @example $("p").next() @@ -2519,9 +2704,9 @@ jQuery.macros = { */ /** - * Get a set of elements containing the unique next siblings of each of the + * Get a set of elements containing the unique next siblings of each of the * matched set of elements, and filtered by an expression. - * + * * It only returns the very next sibling, not all next siblings. * * @example $("p").next(".selected") @@ -2536,12 +2721,12 @@ jQuery.macros = { next: "jQuery.sibling(a).next", /** - * Get a set of elements containing the unique previous siblings of each of the + * Get a set of elements containing the unique previous siblings of each of the * matched set of elements. - * + * * It only returns the immediately previous sibling, not all previous siblings. * - * @example $("p").previous() + * @example $("p").prev() * @beforeHello
Hello Again
And Again
* @result [Hello Again
]
*
@@ -2551,12 +2736,12 @@ jQuery.macros = {
*/
/**
- * Get a set of elements containing the unique previous siblings of each of the
+ * Get a set of elements containing the unique previous siblings of each of the
* matched set of elements, and filtered by an expression.
- *
+ *
* It only returns the immediately previous sibling, not all previous siblings.
*
- * @example $("p").previous(".selected")
+ * @example $("p").prev(".selected")
* @before Hello
Hello Again
And Again
* @result [Hello
]
*
@@ -2568,9 +2753,9 @@ jQuery.macros = {
prev: "jQuery.sibling(a).prev",
/**
- * Get a set of elements containing all of the unique siblings of each of the
+ * Get a set of elements containing all of the unique siblings of each of the
* matched set of elements.
- *
+ *
* @example $("div").siblings()
* @before Hello
Hello Again
And Again
* @result [Hello
,And Again
] @@ -2581,7 +2766,7 @@ jQuery.macros = { */ /** - * Get a set of elements containing all of the unique siblings of each of the + * Get a set of elements containing all of the unique siblings of each of the * matched set of elements, and filtered by an expression. * * @example $("div").siblings(".selected") @@ -2593,13 +2778,13 @@ jQuery.macros = { * @param String expr An expression to filter the sibling Elements with * @cat DOM/Traversing */ - siblings: jQuery.sibling, - - + siblings: "jQuery.sibling(a, null, true)", + + /** - * Get a set of elements containing all of the unique children of each of the + * Get a set of elements containing all of the unique children of each of the * matched set of elements. - * + * * @example $("div").children() * @beforeHello
Hello Again
And Again
* @result [ Hello Again ] @@ -2610,7 +2795,7 @@ jQuery.macros = { */ /** - * Get a set of elements containing all of the unique children of each of the + * Get a set of elements containing all of the unique children of each of the * matched set of elements, and filtered by an expression. * * @example $("div").children(".selected") @@ -2627,23 +2812,29 @@ jQuery.macros = { each: { + /** + * Remove an attribute from each of the matched elements. + * + * @example $("input").removeAttr("disabled") + * @before + * @result + * + * @name removeAttr + * @type jQuery + * @param String name The name of the attribute to remove. + * @cat DOM + */ removeAttr: function( key ) { this.removeAttribute( key ); }, /** * Displays each of the set of matched elements if they are hidden. - * + * * @example $("p").show() * @before * @result [Hello
] * - * @test var pass = true, div = $("div"); - * div.show().each(function(){ - * if ( this.style.display == "none" ) pass = false; - * }); - * ok( pass, "Show" ); - * * @name show * @type jQuery * @cat Effects @@ -2677,7 +2868,7 @@ jQuery.macros = { this.oldblock = "block"; this.style.display = "none"; }, - + /** * Toggles each of the set of matched elements. If they are shown, * toggle makes them hidden. If they are hidden, toggle @@ -2694,7 +2885,7 @@ jQuery.macros = { toggle: function(){ jQuery(this)[ jQuery(this).is(":hidden") ? "show" : "hide" ].apply( jQuery(this), arguments ); }, - + /** * Adds the specified class to each of the set of matched elements. * @@ -2702,14 +2893,6 @@ jQuery.macros = { * @beforeHello
* @result [Hello
] * - * @test var div = $("div"); - * div.addClass("test"); - * var pass = true; - * for ( var i = 0; i < div.size(); i++ ) { - * if ( div.get(i).className.indexOf("test") == -1 ) pass = false; - * } - * ok( pass, "Add Class" ); - * * @name addClass * @type jQuery * @param String class A CSS class to add to the elements @@ -2718,7 +2901,7 @@ jQuery.macros = { addClass: function(c){ jQuery.className.add(this,c); }, - + /** * Removes the specified class from the set of matched elements. * @@ -2726,14 +2909,6 @@ jQuery.macros = { * @beforeHello
* @result [Hello
] * - * @test var div = $("div").addClass("test"); - * div.removeClass("test"); - * var pass = true; - * for ( var i = 0; i < div.size(); i++ ) { - * if ( div.get(i).className.indexOf("test") != -1 ) pass = false; - * } - * ok( pass, "Remove Class" ); - * * @name removeClass * @type jQuery * @param String class A CSS class to remove from the elements @@ -2742,10 +2917,10 @@ jQuery.macros = { removeClass: function(c){ jQuery.className.remove(this,c); }, - + /** - * Adds the specified class if it is present, removes it if it is - * not present. + * Adds the specified class if it is not present, removes it if it is + * present. * * @example $("p").toggleClass("selected") * @beforeHello
Hello Again
@@ -2759,7 +2934,7 @@ jQuery.macros = { toggleClass: function( c ){ jQuery.className[ jQuery.className.has(this,c) ? "remove" : "add" ](this,c); }, - + /** * Removes all matched elements from the DOM. This does NOT remove them from the * jQuery object, allowing you to use the matched elements further. @@ -2772,7 +2947,7 @@ jQuery.macros = { * @type jQuery * @cat DOM/Manipulation */ - + /** * Removes only elements (out of the list of matched elements) that match * the specified jQuery expression. This does NOT remove them from the @@ -2791,7 +2966,7 @@ jQuery.macros = { if ( !a || jQuery.filter( a, [this] ).r ) this.parentNode.removeChild( this ); }, - + /** * Removes all child nodes from the set of matched elements. * @@ -2807,26 +2982,33 @@ jQuery.macros = { while ( this.firstChild ) this.removeChild( this.firstChild ); }, - + /** - * Binds a particular event (like click) to a each of a set of match elements. - * - * @example $("p").bind( "click", function() { alert("Hello"); } ) + * Binds a handler to a particular event (like click) for each matched element. + * The event handler is passed an event object that you can use to prevent + * default behaviour. To stop both default action and event bubbling, your handler + * has to return false. + * + * @example $("p").bind( "click", function() { + * alert( $(this).text() ); + * } ) * @beforeHello
- * @result [Hello
] - * - * Cancel a default action and prevent it from bubbling by returning false - * from your function. + * @result alert("Hello") * * @example $("form").bind( "submit", function() { return false; } ) + * @desc Cancel a default action and prevent it from bubbling by returning false + * from your function. * - * Cancel a default action by using the preventDefault method. - * - * @example $("form").bind( "submit", function() { e.preventDefault(); } ) + * @example $("form").bind( "submit", function(event) { + * event.preventDefault(); + * } ); + * @desc Cancel only the default action by using the preventDefault method. * - * Stop an event from bubbling by using the stopPropogation method. * - * @example $("form").bind( "submit", function() { e.stopPropogation(); } ) + * @example $("form").bind( "submit", function(event) { + * event.stopPropagation(); + * } ) + * @desc Stop only an event from bubbling by using the stopPropagation method. * * @name bind * @type jQuery @@ -2835,14 +3017,12 @@ jQuery.macros = { * @cat Events */ bind: function( type, fn ) { - if ( fn.constructor == String ) - fn = new Function("e", ( !fn.indexOf(".") ? "jQuery(this)" : "return " ) + fn); jQuery.event.add( this, type, fn ); }, - + /** * 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 + * elements. You must pass the identical function that was used in the original * bind method. * * @example $("p").unbind( "click", function() { alert("Hello"); } ) @@ -2855,7 +3035,7 @@ jQuery.macros = { * @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. @@ -2869,7 +3049,7 @@ jQuery.macros = { * @param String type An event type * @cat Events */ - + /** * Removes all bound events from each of the matched elements. * @@ -2884,7 +3064,7 @@ jQuery.macros = { unbind: function( type, fn ) { jQuery.event.remove( this, type, fn ); }, - + /** * Trigger a type of event on every matched element. *