X-Git-Url: http://git.asbjorn.biz/?a=blobdiff_plain;f=src%2Fjquery%2Fjquery.js;h=c4ed21b95ce8ece5b58f340f8dc9ee2f0fbc198c;hb=f153dec20c7827c7ec5016f24c85e999950bc33c;hp=467c0748168d18f5daa439c587007e1404b83d8e;hpb=c8009abcce562198cbc3930ed11f74dd62eba531;p=jquery.git diff --git a/src/jquery/jquery.js b/src/jquery/jquery.js index 467c074..c4ed21b 100644 --- a/src/jquery/jquery.js +++ b/src/jquery/jquery.js @@ -2,7 +2,7 @@ * jQuery - New Wave Javascript * * Copyright (c) 2006 John Resig (jquery.com) - * Dual licensed under the MIT (MIT-LICENSE.txt) + * Dual licensed under the MIT (MIT-LICENSE.txt) * and GPL (GPL-LICENSE.txt) licenses. * * $Date$ @@ -44,7 +44,7 @@ function jQuery(a,c) { // Watch for when a jQuery object is passed at the context if ( c && c.jquery ) return jQuery( c ).find(a); - + // If the context is global, return a new object if ( window == this ) return new jQuery(a,c); @@ -63,7 +63,7 @@ function jQuery(a,c) { // See if an extra function was provided var fn = arguments[ arguments.length - 1 ]; - + // If so, execute it in context if ( fn && fn.constructor == Function ) this.each(fn); @@ -72,21 +72,21 @@ function jQuery(a,c) { // Map over the $ in case of overwrite if ( typeof $ != "undefined" ) jQuery._$ = $; - + /** - * This function accepts a string containing a CSS selector, + * This function accepts a string containing a CSS selector, * basic XPath, or raw HTML, which is then used to match a set of elements. * The HTML string is different from the traditional selectors in that * it creates the DOM elements representing that HTML string, on the fly, * to be (assumedly) inserted into the document later. * - * The core functionality of jQuery centers around this function. - * Everything in jQuery is based upon this, or uses this in some way. - * The most basic use of this function is to pass in an expression - * (usually consisting of CSS or XPath), which then finds all matching + * The core functionality of jQuery centers around this function. + * Everything in jQuery is based upon this, or uses this in some way. + * The most basic use of this function is to pass in an expression + * (usually consisting of CSS or XPath), which then finds all matching * elements and remembers them for later use. * - * By default, $() looks for DOM elements within the context of the + * By default, $() looks for DOM elements within the context of the * current HTML document. * * @example $("div > p") @@ -102,7 +102,7 @@ if ( typeof $ != "undefined" ) * @cat Core * @type jQuery */ - + /** * This function accepts a string containing a CSS selector, or * basic XPath, which is then used to match a set of elements with the @@ -117,7 +117,7 @@ if ( typeof $ != "undefined" ) * @cat Core * @type jQuery */ - + /** * Wrap jQuery functionality around a specific DOM Element. * This function also accepts XML Documents and Window objects @@ -127,16 +127,15 @@ if ( typeof $ != "undefined" ) * @before
one
two
three
* @result [two
] * - * @example $(document).ready( loaded ); - * @desc Executes the "loaded" function when the DOM is ready to - * be manipulated. + * @example $(document.body).background( "black" ); + * @desc Sets the background color of the page to black. * * @name $ * @param Element elem A DOM element to be encapsulated by a jQuery object. * @cat Core * @type jQuery */ - + /** * Wrap jQuery functionality around a set of DOM Elements. * @@ -148,26 +147,33 @@ if ( typeof $ != "undefined" ) * @cat Core * @type jQuery */ - + /** * A shorthand for $(document).ready(), allowing you to bind a function - * to be executed when the DOM document has finished loading. + * 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. * - * @example $( loaded ) - * @desc Executes the function "loaded" when the DOM is ready to be used. + * @example $(function(){ + * // Document is ready + * }); + * @desc Executes the function when the DOM is ready to be used. * * @name $ * @param Function fn The function to execute when the DOM is ready. * @cat Core * @type jQuery */ - + /** - * A means of creating a duplicate copy of a jQuery object. + * A means of creating a cloned copy of a jQuery object. This function + * copies the set of matched elements from one jQuery object and creates + * another, new, jQuery object containing the same elements. * * @example var div = $("div"); - * $( div ).find("p") - * @desc Locates all p elements with all div elements, without disrupting the original jQuery object contained in 'div'. + * $( div ).find("p"); + * @desc Locates all p elements with all div elements, without disrupting the original jQuery object contained in 'div' (as would normally be the case if a simple div.find("p") was done). * * @name $ * @param jQuery obj The jQuery object to be cloned. @@ -189,7 +195,7 @@ jQuery.fn = jQuery.prototype = { * @cat Core */ jquery: "$Rev$", - + /** * The number of elements currently matched. * @@ -204,7 +210,7 @@ jQuery.fn = jQuery.prototype = { * @type Number * @cat Core */ - + /** * The number of elements currently matched. * @@ -221,7 +227,7 @@ jQuery.fn = jQuery.prototype = { size: function() { return this.length; }, - + /** * Access all matched elements. This serves as a backwards-compatible * way of accessing all matched elements (other than the jQuery object @@ -237,9 +243,9 @@ jQuery.fn = jQuery.prototype = { * @type ArrayTest 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. + * + * @test ok( $('#foo').css("display") == 'block', 'Check for css property "display"'); * * @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 @@ -439,18 +508,32 @@ jQuery.fn = jQuery.prototype = { * @beforeTest Paragraph.
* @resultTest Paragraph.
* + * @test ok( $('#foo').is(':visible'), 'Modifying CSS display: Assert element is visible'); + * @test $('#foo').css({display: 'none'}); + * ok( !$('#foo').is(':visible'), 'Modified CSS display: Assert element is hidden'); + * @test $('#foo').css({display: 'block'}); + * ok( $('#foo').is(':visible'), 'Modified CSS display: Assert element is visible'); + * * @name css * @type jQuery * @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 + * + * + * @test ok( $('#foo').is(':visible'), 'Modifying CSS display: Assert element is visible'); + * @test $('#foo').css('display', 'none'); + * ok( !$('#foo').is(':visible'), 'Modified CSS display: Assert element is hidden'); + * @test $('#foo').css('display', 'block'); + * ok( $('#foo').is(':visible'), 'Modified CSS display: Assert element is visible'); * * @name css * @type jQuery @@ -461,9 +544,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. * @@ -471,6 +554,9 @@ jQuery.fn = jQuery.prototype = { * @beforeTest Paragraph.
* @result Test Paragraph. * + * @test var expected = "This link has class=\"blog\": Simon Willison's Weblog"; + * ok( $('#sap').text() == expected, 'Check for merged text of more then one element.' ); + * * @name text * @type String * @cat DOM @@ -487,36 +573,46 @@ 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. * * @example $("p").wrap(""); * @beforeTest Paragraph.
* @resultTest Paragraph.
I would like to say:
* @resultI would like to say: Hello
* + * @test var defaultText = 'Try them out:' + * var result = $('#first').append('buga'); + * ok( result.text() == defaultText + 'buga', 'Check if text appending works' ); + * * @name append * @type jQuery * @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
* + * @test var expected = "This link has class=\"blog\": Simon Willison's WeblogTry them out:"; + * $('#sap').append(document.getElementById('first')); + * ok( expected == $('#sap').text(), "Check for appending of element" ); + * * @name append * @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 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
* + * @test var expected = "This link has class=\"blog\": Simon Willison's WeblogTry them out:Yahoo"; + * $('#sap').append([document.getElementById('first'), document.getElementById('yahoo')]); + * ok( expected == $('#sap').text(), "Check for appending of array of elements" ); + * * @name append * @type jQuery * @param ArrayI would like to say:
* @resultHelloI would like to say:
* + * @test var defaultText = 'Try them out:' + * var result = $('#first').prepend('buga'); + * ok( result.text() == 'buga' + defaultText, 'Check if text prepending works' ); + * * @name prepend * @type jQuery * @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:
+ * + * @test var expected = "Try them out:This link has class=\"blog\": Simon Willison's Weblog"; + * $('#sap').prepend(document.getElementById('first')); + * ok( expected == $('#sap').text(), "Check for prepending of element" ); * * @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:
* + * @test var expected = "Try them out:YahooThis link has class=\"blog\": Simon Willison's Weblog"; + * $('#sap').prepend([document.getElementById('first'), document.getElementById('yahoo')]); + * ok( expected == $('#sap').text(), "Check for prepending of array of elements" ); + * * @name prepend * @type jQuery * @param ArrayI would like to say:
* @result HelloI would like to say:
* + * @test var expected = 'This is a normal link: bugaYahoo'; + * $('#yahoo').before('buga'); + * ok( expected == $('#en').text(), 'Insert String before' ); + * * @name before * @type jQuery * @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:
* + * @test var expected = "This is a normal link: Try them out:Yahoo"; + * $('#yahoo').before(document.getElementById('first')); + * ok( expected == $('#en').text(), "Insert element before" ); + * * @name before * @type jQuery * @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:
* + * @test var expected = "This is a normal link: Try them out:diveintomarkYahoo"; + * $('#yahoo').before([document.getElementById('first'), document.getElementById('mark')]); + * ok( expected == $('#en').text(), "Insert array of elements before" ); + * * @name before * @type jQuery * @param ArrayI would like to say:
* @resultI would like to say:
Hello * + * @test var expected = 'This is a normal link: Yahoobuga'; + * $('#yahoo').after('buga'); + * ok( expected == $('#en').text(), 'Insert String after' ); + * * @name after * @type jQuery * @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 * + * @test var expected = "This is a normal link: YahooTry them out:"; + * $('#yahoo').after(document.getElementById('first')); + * ok( expected == $('#en').text(), "Insert element after" ); + * * @name after * @type jQuery * @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 * + * @test var expected = "This is a normal link: YahooTry them out:diveintomark"; + * $('#yahoo').after([document.getElementById('first'), document.getElementById('mark')]); + * ok( expected == $('#en').text(), "Insert array of elements after" ); + * * @name after * @type jQuery * @param ArrayHello, how are you?
* @result $("p").find("span").end() == [...
] * + * @test ok( 'Yahoo' == $('#yahoo').parent().end().text(), 'Check for end' ); + * * @name end * @type jQuery * @cat DOM/Traversing @@ -757,19 +903,21 @@ jQuery.fn = jQuery.prototype = { end: function() { 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"); * @beforeHello, how are you?
* @result $("p").find("span") == [ Hello ] * + * @test ok( 'Yahoo' == $('#foo').find('.blogTest').text(), 'Check for find' ); + * * @name find * @type jQuery * @param String expr An expression to search with. @@ -781,24 +929,46 @@ 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?
+ * + * @test ok( 'This is a normal link: Yahoo' == $('#en').text(), 'Assert text for #en' ); + * var clone = $('#yahoo').clone(); + * ok( 'Try them out:Yahoo' == $('#first').append(clone).text(), 'Check for clone' ); + * ok( 'This is a normal link: Yahoo' == $('#en').text(), 'Reassert text for #en' ); + * + * @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
] * + * @test isSet( $("input").filter(":checked").get(), q("radio2", "check1"), "Filter elements" ); + * * @name filter * @type jQuery * @param String expr An expression to search with. @@ -807,8 +977,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 @@ -840,7 +1010,7 @@ jQuery.fn = jQuery.prototype = { 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,7 +1029,7 @@ 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
] @@ -921,23 +1091,61 @@ jQuery.fn = jQuery.prototype = { return this.pushStack( jQuery.merge( this, t.constructor == 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. * - * @member jQuery - * @param {String} expr The expression with which to filter + * @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. + * + * @test ok( $('#form').is('form'), 'Check for element: A form must be a form' ); + * @test ok( !$('#form').is('div'), 'Check for element: A form is not a div' ); + * @test ok( $('#mark').is('.blog'), 'Check for class: Expected class "blog"' ); + * @test ok( !$('#mark').is('.link'), 'Check for class: Did not expect class "link"' ); + * @test ok( $('#simon').is('.blog.link'), 'Check for multiple classes: Expected classes "blog" and "link"' ); + * @test ok( !$('#simon').is('.blogTest'), 'Check for multiple classes: Expected classes "blog" and "link", but not "blogTest"' ); + * @test ok( $('#en').is('[@lang="en"]'), 'Check for attribute: Expected attribute lang to be "en"' ); + * @test ok( !$('#en').is('[@lang="de"]'), 'Check for attribute: Expected attribute lang to be "en", not "de"' ); + * @test ok( $('#text1').is('[@type="text"]'), 'Check for attribute: Expected attribute type to be "text"' ); + * @test ok( !$('#text1').is('[@type="radio"]'), 'Check for attribute: Expected attribute type to be "text", not "radio"' ); + * @test ok( $('#text2').is(':disabled'), 'Check for pseudoclass: Expected to be disabled' ); + * @test ok( !$('#text1').is(':disabled'), 'Check for pseudoclass: Expected not disabled' ); + * @test ok( $('#radio2').is(':checked'), 'Check for pseudoclass: Expected to be checked' ); + * @test ok( !$('#radio1').is(':checked'), 'Check for pseudoclass: Expected not checked' ); + * @test ok( $('#foo').is('[p]'), 'Check for child: Expected a child "p" element' ); + * @test ok( !$('#foo').is('[ul]'), 'Check for child: Did not expect "ul" element' ); + * @test ok( $('#foo').is('[p][a][code]'), 'Check for childs: Expected "p", "a" and "code" child elements' ); + * @test ok( !$('#foo').is('[p][a][code][ol]'), 'Check for childs: Expected "p", "a" and "code" child elements, but no "ol"' ); + * @test ok( !$('#foo').is(0), 'Expected false for an invalid expression - 0' ); + * @test ok( !$('#foo').is(null), 'Expected false for an invalid expression - null' ); + * @test ok( !$('#foo').is(''), 'Expected false for an invalid expression - ""' ); + * @test ok( !$('#foo').is(undefined), 'Expected false for an invalid expression - undefined' ); + * + * @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,10 +1159,10 @@ 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" ) { var tbody = this.getElementsByTagName("tbody"); @@ -971,9 +1179,9 @@ jQuery.fn = jQuery.prototype = { } }); }, - + /** - * + * * * @private * @name pushStack @@ -1002,7 +1210,7 @@ jQuery.fn = jQuery.prototype = { }; /** - * + * * * @private * @name extend @@ -1010,10 +1218,23 @@ 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" } + * + * @test var settings = { xnumber1: 5, xnumber2: 7, xstring1: "peter", xstring2: "pan" }; + * var options = { xnumber2: 1, xstring2: "x", xxx: "newstring" }; + * var optionsCopy = { xnumber2: 1, xstring2: "x", xxx: "newstring" }; + * var merged = { xnumber1: 5, xnumber2: 1, xstring1: "peter", xstring2: "x", xxx: "newstring" }; + * jQuery.extend(settings, options); + * isSet( settings, merged, "Check if extended: settings must be extended" ); + * isSet ( options, optionsCopy, "Check if not modified: options must not be modified" ); * * @name $.extend * @param Object obj The object to extend @@ -1036,7 +1257,7 @@ 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); @@ -1045,7 +1266,7 @@ jQuery.extend({ return this.pushStack( ret, arguments ); }; }); - + jQuery.each( jQuery.macros.to, function(i,n){ jQuery.fn[ i ] = function(){ var a = arguments; @@ -1055,7 +1276,7 @@ jQuery.extend({ }); }; }); - + jQuery.each( jQuery.macros.each, function(i,n){ jQuery.fn[ i ] = function() { return this.each( n, arguments ); @@ -1067,7 +1288,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 +1297,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 +1305,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 */ @@ -1106,7 +1339,7 @@ jQuery.extend({ fn.apply( obj[i], args || [i, obj[i]] ); return obj; }, - + className: { add: function(o,c){ if (jQuery.className.has(o,c)) return; @@ -1123,7 +1356,7 @@ jQuery.extend({ return new RegExp("(^|\\s)" + a + "(\\s|$)").test(e); } }, - + /** * Swap in/out style options. * @private @@ -1137,32 +1370,39 @@ jQuery.extend({ for ( var i in o ) e.style[i] = e.style["old"+i]; }, - + css: function(e,p) { if ( p == "height" || p == "width" ) { var old = {}, oHeight, oWidth, d = ["Top","Bottom","Right","Left"]; - + for ( var i in d ) { old["padding" + d[i]] = 0; old["border" + d[i] + "Width"] = 0; } - + jQuery.swap( e, old, function() { if (jQuery.css(e,"display") != "none") { oHeight = e.offsetHeight; oWidth = e.offsetWidth; } else { e = jQuery(e.cloneNode(true)).css({ - visibility: "hidden", position: "absolute", display: "block" + visibility: "hidden", position: "absolute", display: "block", right: "0", left: "0" }).appendTo(e.parentNode)[0]; + var parPos = jQuery.css(e.parentNode,"position"); + if ( parPos == "" || parPos == "static" ) + e.parentNode.style.position = "relative"; + oHeight = e.clientHeight; oWidth = e.clientWidth; - + + if ( parPos == "" || parPos == "static" ) + e.parentNode.style.position = "static"; + e.parentNode.removeChild(e); } }); - + return p == "height" ? oHeight : oWidth; } else if ( p == "opacity" && jQuery.browser.msie ) return parseFloat( jQuery.curCSS(e,"filter").replace(/[^0-9.]/,"") ) || 1; @@ -1172,14 +1412,14 @@ jQuery.extend({ curCSS: function(elem, prop, force) { var ret; - + if (!force && elem.style[prop]) { ret = elem.style[prop]; } else if (elem.currentStyle) { - var newProp = prop.replace(/\-(\w)/g,function(m,c){return c.toUpperCase()}); + var newProp = prop.replace(/\-(\w)/g,function(m,c){return c.toUpperCase();}); ret = elem.currentStyle[prop] || elem.currentStyle[newProp]; } else if (document.defaultView && document.defaultView.getComputedStyle) { @@ -1197,17 +1437,17 @@ jQuery.extend({ }); } - + return ret; }, - + clean: function(a) { var r = []; for ( var i = 0; i < a.length; i++ ) { if ( a[i].constructor == String ) { var table = ""; - + if ( !a[i].indexOf("" + a[i] + ""; @@ -1218,16 +1458,16 @@ jQuery.extend({ table = "td"; a[i] = "I would like to say:
* @resultI would like to say:
I would like to say:
I would like to say:
HelloI would like to say:
* @resultI would like to say:
I would like to say:
I would like to say:
@@ -1962,10 +2240,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 +2252,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 +2267,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 +2279,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 +2294,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 +2306,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 +2321,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 +2333,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 +2348,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 +2360,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 +2373,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 +2385,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 +2398,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 +2410,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 +2423,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 +2435,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 +2448,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,41 +2473,107 @@ 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" * + * @test ok( $("#text1").val() == "Test", "Check for value of input element" ); + * @test ok( !$("#text1").val() == "", "Check for value of input element" ); + * * @name val * @type String * @cat DOM/Attributes */ - + /** * Set the value of every matched element. - * + * * @example $("input").value("test"); * @before * @result * + * @test document.getElementById('text1').value = "bla"; + * ok( $("#text1").val() == "bla", "Check for modified value of input element" ); + * $("#text1").val('test'); + * ok ( document.getElementById('text1').value == "test", "Check for modified (via val(String)) value of input element" ); + * * @name val * @type jQuery * @param String val Set the property to the specified value. * @cat DOM/Attributes */ val: "value", - + /** * Get the html contents of the first matched element. - * + * * @example $("div").html(); * @before * @result @@ -2238,10 +2582,10 @@ jQuery.macros = { * @type String * @cat DOM/Attributes */ - + /** * Set the html contents of every matched element. - * + * * @example $("div").html("new stuff"); * @before * @resultHello
Hello AgainHello
] + * @result [ ...,Hello
] * * @name ancestors * @type jQuery @@ -2466,7 +2810,7 @@ jQuery.macros = { * * @example $("span").ancestors("p") * @beforeHello
Hello AgainHello
] + * @result [Hello
] * * @name ancestors * @type jQuery @@ -2474,14 +2818,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 AgainHello
] + * @result [ ...,Hello
] * * @name parents * @type jQuery @@ -2494,7 +2838,7 @@ jQuery.macros = { * * @example $("span").ancestors("p") * @beforeHello
Hello AgainHello
] + * @result [Hello
] * * @name parents * @type jQuery @@ -2504,9 +2848,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 +2863,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,9 +2880,9 @@ 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() @@ -2551,9 +2895,9 @@ 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") @@ -2568,38 +2912,43 @@ 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() * @beforeHello
And Again
* @result [Hello
,And Again
] * + * @test isSet( $("#en").siblings().get(), q("sndp", "sap"), "Check for siblings" ); + * * @name siblings * @type jQuery * @cat DOM/Traversing */ /** - * 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") * @beforeHello Again
And Again
* @result [Hello Again
] * + * @test isSet( $("#sndp").siblings("[code]").get(), q("sap"), "Check for filtered siblings (has code child element)" ); + * @test isSet( $("#sndp").siblings("[a]").get(), q("en", "sap"), "Check for filtered siblings (has anchor child element)" ); + * * @name siblings * @type jQuery * @param String expr An expression to filter the sibling Elements with * @cat DOM/Traversing */ siblings: jQuery.sibling, - - + + /** - * 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
And Again
* @result [ Hello Again ] @@ -2610,7 +2959,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,13 +2976,25 @@ 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
] @@ -2677,7 +3038,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 +3055,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. * @@ -2709,7 +3070,7 @@ jQuery.macros = { * 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 +3079,7 @@ jQuery.macros = { addClass: function(c){ jQuery.className.add(this,c); }, - + /** * Removes the specified class from the set of matched elements. * @@ -2742,7 +3103,7 @@ 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. @@ -2759,7 +3120,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 +3133,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 +3152,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 +3168,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 @@ -2839,10 +3207,10 @@ jQuery.macros = { 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 +3223,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 +3237,7 @@ jQuery.macros = { * @param String type An event type * @cat Events */ - + /** * Removes all bound events from each of the matched elements. * @@ -2884,7 +3252,7 @@ jQuery.macros = { unbind: function( type, fn ) { jQuery.event.remove( this, type, fn ); }, - + /** * Trigger a type of event on every matched element. *