* @property
* @name jquery
* @type String
+ * @cat Core
*/
jquery: "$Rev$",
* @property
* @name length
* @type Number
+ * @cat Core
*/
/**
*
* @name size
* @type Number
+ * @cat Core
*/
size: function() {
return this.length;
*
* @name get
* @type Array<Element>
+ * @cat Core
*/
/**
- * Access a single matched element. <tt>num</tt> is used to access the
- * <tt>num</tt>th element matched.
+ * Access a single matched element. num is used to access the
+ * Nth element matched.
*
* @example $("img").get(1);
* @before <img src="test1.jpg"/> <img src="test2.jpg"/>
*
* @name get
* @type Element
- * @param Number num Access the element in the <tt>num</tt>th position.
+ * @param Number num Access the element in the Nth position.
+ * @cat Core
*/
/**
* @name get
* @type jQuery
* @param Elements elems An array of elements
+ * @cat Core
*/
get: function( num ) {
// Watch for when an array (of elements) is passed in
* @name each
* @type jQuery
* @param Function fn A function to execute
+ * @cat Core
*/
each: function( fn, args ) {
return jQuery.each( this, fn, args );
* @name attr
* @type Object
* @param String name The name of the property to access.
+ * @cat DOM
*/
/**
* @name attr
* @type jQuery
* @param Hash prop A set of key/value pairs to set as object properties.
+ * @cat DOM
*/
/**
* @type jQuery
* @param String key The name of the property to set.
* @param Object value The value to set the property to.
+ * @cat DOM
*/
attr: function( key, value, type ) {
// Check to see if we're setting style values
- return key.constructor != String || value ?
+ return key.constructor != String || value != undefined ?
this.each(function(){
// See if we're setting a hash of styles
if ( value == undefined )
* @name css
* @type Object
* @param String name The name of the property to access.
+ * @cat CSS
*/
/**
* @name css
* @type jQuery
* @param Hash prop A set of key/value pairs to set as style properties.
+ * @cat CSS
*/
/**
* @type jQuery
* @param String key The name of the property to set.
* @param Object value The value to set the property to.
+ * @cat CSS
*/
css: function( key, value ) {
return this.attr( key, value, "curCSS" );
*
* @name text
* @type String
+ * @cat DOM
*/
text: function(e) {
e = e || this;
* @any Element elem A DOM element that will be wrapped.
* @any Array<Element> elems An array of elements, the first of which will be wrapped.
* @any Object obj Any object, converted to a string, then a text node.
+ * @cat DOM/Manipulation
*/
wrap: function() {
// The elements to wrap the target around
/**
* Append any number of elements to the inside of all matched elements.
- * This operation is similar to doing an <tt>appendChild</tt> 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>Hello</b>");
* @any Element elem A DOM element that will be appended.
* @any Array<Element> elems An array of elements, all of which will be appended.
* @any Object obj Any object, converted to a string, then a text node.
+ * @cat DOM/Manipulation
*/
append: function() {
return this.domManip(arguments, true, 1, function(a){
* @any Element elem A DOM element that will be prepended.
* @any Array<Element> elems An array of elements, all of which will be prepended.
* @any Object obj Any object, converted to a string, then a text node.
+ * @cat DOM/Manipulation
*/
prepend: function() {
return this.domManip(arguments, true, -1, function(a){
* @any Element elem A DOM element that will beinserted.
* @any Array<Element> elems An array of elements, all of which will be inserted.
* @any Object obj Any object, converted to a string, then a text node.
+ * @cat DOM/Manipulation
*/
before: function() {
return this.domManip(arguments, false, 1, function(a){
* @any Element elem A DOM element that will beinserted.
* @any Array<Element> elems An array of elements, all of which will be inserted.
* @any Object obj Any object, converted to a string, then a text node.
+ * @cat DOM/Manipulation
*/
after: function() {
return this.domManip(arguments, false, -1, function(a){
*
* @name end
* @type jQuery
+ * @cat DOM/Traversing
*/
end: function() {
return this.get( this.stack.pop() );
* @name find
* @type jQuery
* @param String expr An expression to search with.
+ * @cat DOM/Traversing
*/
find: function(t) {
return this.pushStack( jQuery.map( this, function(a){
* @name filter
* @type jQuery
* @param String expr An expression to search with.
+ * @cat DOM/Traversing
*/
/**
* @name filter
* @type jQuery
* @param Array<String> exprs A set of expressions to evaluate against
+ * @cat DOM/Traversing
*/
filter: function(t) {
return this.pushStack(
* @name not
* @type jQuery
* @param Element el An element to remove from the set
+ * @cat DOM/Traversing
*/
/**
* @name not
* @type jQuery
* @param String expr An expression with which to remove matching elements
+ * @cat DOM/Traversing
*/
not: function(t) {
return this.pushStack( t.constructor == String ?
* @name add
* @type jQuery
* @param String expr An expression whose matched elements are added
+ * @cat DOM/Traversing
*/
/**
* @name add
* @type jQuery
* @param Array<Element> els An array of Elements to add
+ * @cat jQuery
*/
/**
* @name add
* @type jQuery
* @param Element el An Element to add
+ * @cat jQuery
*/
add: function(t) {
return this.pushStack( jQuery.merge( this, t.constructor == String ?
* @member jQuery
* @param {String} expr The expression with which to filter
* @type Boolean
+ * @cat jQuery
*/
is: function(expr) {
return expr ? jQuery.filter(expr,this).r.length > 0 : this.length > 0;
}
};
+/**
+ *
+ *
+ * @private
+ * @name extend
+ * @param Object obj
+ * @param Object prop
+ * @type Object
+ */
+
+/**
+ * Extend one object with another, returning the original,
+ * modified, object. This is a great utility for simple inheritance.
+ *
+ * @name $.extend
+ * @param Object obj The object to extend
+ * @param Object prop The object that will be merged into the first.
+ * @type Object
+ * @cat Javascript
+ */
jQuery.extend = jQuery.fn.extend = function(obj,prop) {
if ( !prop ) { prop = obj; obj = this; }
for ( var i in prop ) obj[i] = prop[i];
};
jQuery.extend({
+ /**
+ *
+ *
+ * @private
+ * @name init
+ * @type undefined
+ */
init: function(){
jQuery.initDone = true;
return this.pushStack( ret, arguments );
};
});
-
- // appendTo, prependTo, beforeTo, afterTo
jQuery.each( jQuery.macros.to, function(i,n){
- jQuery.fn[ n + "To" ] = function(){
+ jQuery.fn[ i ] = function(){
var a = arguments;
return this.each(function(){
- for ( var i = 0; i < a.length; i++ )
- $(a[i])[n]( this );
+ for ( var j = 0; j < a.length; j++ )
+ $(a[j])[n]( this );
});
};
});
return this.each( n, arguments );
};
});
+
+ jQuery.each( jQuery.macros.filter, function(i,n){
+ jQuery.fn[ n ] = function(num,fn) {
+ return this.filter( ":" + n + "(" + num + ")", fn );
+ };
+ });
jQuery.each( jQuery.macros.attr, function(i,n){
n = n || i;
},
+ /**
+ * A generic iterator function, which can be used to seemlessly
+ * iterate over both objects and arrays.
+ *
+ * @name $.each
+ * @param Object obj The object, or array, to iterate over.
+ * @param Object fn The function that will be executed on every object.
+ * @type Object
+ * @cat Javascript
+ */
each: function( obj, fn, args ) {
if ( obj.length == undefined )
for ( var i in obj )
};
jQuery.macros = {
- to: ["append","prepend","before","after"],
+ to: {
+ /**
+ * Append all of the matched elements to another, specified, set of elements.
+ * This operation is, essentially, the reverse of doing a regular
+ * $(A).append(B), in that instead of appending B to A, you're appending
+ * A to B.
+ *
+ * @example $("p").appendTo("#foo");
+ * @before <p>I would like to say: </p><div id="foo"></div>
+ * @result <div id="foo"><p>I would like to say: </p></div>
+ *
+ * @name appendTo
+ * @type jQuery
+ * @param String expr A jQuery expression of elements to match.
+ * @cat DOM/Manipulation
+ */
+ appendTo: "append",
+
+ /**
+ * Prepend all of the matched elements to another, specified, set of elements.
+ * This operation is, essentially, the reverse of doing a regular
+ * $(A).prepend(B), in that instead of prepending B to A, you're prepending
+ * A to B.
+ *
+ * @example $("p").prependTo("#foo");
+ * @before <p>I would like to say: </p><div id="foo"><b>Hello</b></div>
+ * @result <div id="foo"><p>I would like to say: </p><b>Hello</b></div>
+ *
+ * @name prependTo
+ * @type jQuery
+ * @param String expr A jQuery expression of elements to match.
+ * @cat DOM/Manipulation
+ */
+ prependTo: "prepend",
+
+ /**
+ * Insert all of the matched elements before another, specified, set of elements.
+ * This operation is, essentially, the reverse of doing a regular
+ * $(A).before(B), in that instead of inserting B before A, you're inserting
+ * A before B.
+ *
+ * @example $("p").insertBefore("#foo");
+ * @before <div id="foo">Hello</div><p>I would like to say: </p>
+ * @result <p>I would like to say: </p><div id="foo">Hello</div>
+ *
+ * @name insertBefore
+ * @type jQuery
+ * @param String expr A jQuery expression of elements to match.
+ * @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 <p>I would like to say: </p><div id="foo">Hello</div>
+ * @result <div id="foo">Hello</div><p>I would like to say: </p>
+ *
+ * @name insertAfter
+ * @type jQuery
+ * @param String expr A jQuery expression of elements to match.
+ * @cat DOM/Manipulation
+ */
+ insertAfter: "after"
+ },
+
+ /**
+ * Get the current CSS width of the first matched element.
+ *
+ * @example $("p").width();
+ * @before <p>This is just a test.</p>
+ * @result "300px"
+ *
+ * @name width
+ * @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
+ * specify, otherwise you might get strange results.
+ *
+ * @example $("p").width("20px");
+ * @before <p>This is just a test.</p>
+ * @result <p style="width:20px;">This is just a test.</p>
+ *
+ * @name width
+ * @type jQuery
+ * @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();
+ * @before <p>This is just a test.</p>
+ * @result "14px"
+ *
+ * @name height
+ * @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
+ * specify, otherwise you might get strange results.
+ *
+ * @example $("p").height("20px");
+ * @before <p>This is just a test.</p>
+ * @result <p style="height:20px;">This is just a test.</p>
+ *
+ * @name height
+ * @type jQuery
+ * @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();
+ * @before <p>This is just a test.</p>
+ * @result "0px"
+ *
+ * @name top
+ * @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
+ * specify, otherwise you might get strange results.
+ *
+ * @example $("p").top("20px");
+ * @before <p>This is just a test.</p>
+ * @result <p style="top:20px;">This is just a test.</p>
+ *
+ * @name top
+ * @type jQuery
+ * @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();
+ * @before <p>This is just a test.</p>
+ * @result "0px"
+ *
+ * @name left
+ * @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
+ * specify, otherwise you might get strange results.
+ *
+ * @example $("p").left("20px");
+ * @before <p>This is just a test.</p>
+ * @result <p style="left:20px;">This is just a test.</p>
+ *
+ * @name left
+ * @type jQuery
+ * @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();
+ * @before <p>This is just a test.</p>
+ * @result "static"
+ *
+ * @name position
+ * @type String
+ * @cat CSS
+ */
+
+ /**
+ * Set the CSS position of every matched element.
+ *
+ * @example $("p").position("relative");
+ * @before <p>This is just a test.</p>
+ * @result <p style="position:relative;">This is just a test.</p>
+ *
+ * @name position
+ * @type jQuery
+ * @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();
+ * @before <p>This is just a test.</p>
+ * @result "none"
+ *
+ * @name float
+ * @type String
+ * @cat CSS
+ */
+
+ /**
+ * Set the CSS float of every matched element.
+ *
+ * @example $("p").float("left");
+ * @before <p>This is just a test.</p>
+ * @result <p style="float:left;">This is just a test.</p>
+ *
+ * @name float
+ * @type jQuery
+ * @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();
+ * @before <p>This is just a test.</p>
+ * @result "none"
+ *
+ * @name overflow
+ * @type String
+ * @cat CSS
+ */
+
+ /**
+ * Set the CSS overflow of every matched element.
+ *
+ * @example $("p").overflow("auto");
+ * @before <p>This is just a test.</p>
+ * @result <p style="overflow:auto;">This is just a test.</p>
+ *
+ * @name overflow
+ * @type jQuery
+ * @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();
+ * @before <p>This is just a test.</p>
+ * @result "black"
+ *
+ * @name color
+ * @type String
+ * @cat CSS
+ */
+
+ /**
+ * Set the CSS color of every matched element.
+ *
+ * @example $("p").color("blue");
+ * @before <p>This is just a test.</p>
+ * @result <p style="color:blue;">This is just a test.</p>
+ *
+ * @name color
+ * @type jQuery
+ * @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();
+ * @before <p>This is just a test.</p>
+ * @result ""
+ *
+ * @name background
+ * @type String
+ * @cat CSS
+ */
+
+ /**
+ * Set the CSS background of every matched element.
+ *
+ * @example $("p").background("blue");
+ * @before <p>This is just a test.</p>
+ * @result <p style="background:blue;">This is just a test.</p>
+ *
+ * @name background
+ * @type jQuery
+ * @param String val Set the CSS property to the specified value.
+ * @cat CSS
+ */
+
css: "width,height,top,left,position,float,overflow,color,background".split(","),
+
+ filter: [ "eq", "lt", "gt", "contains" ],
+
attr: {
+ /**
+ * Get the current value of the first matched element.
+ *
+ * @example $("input").val();
+ * @before <input type="text" value="some text"/>
+ * @result "some text"
+ *
+ * @name val
+ * @type String
+ * @cat DOM/Attributes
+ */
+
+ /**
+ * Set the value of every matched element.
+ *
+ * @example $("input").value("test");
+ * @before <input type="text" value="some text"/>
+ * @result <input type="text" value="test"/>
+ *
+ * @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 <div><input/></div>
+ * @result <input/>
+ *
+ * @name html
+ * @type String
+ * @cat DOM/Attributes
+ */
+
+ /**
+ * Set the html contents of every matched element.
+ *
+ * @example $("div").html("<b>new stuff</b>");
+ * @before <div><input/></div>
+ * @result <div><b>new stuff</b></div>
+ *
+ * @name html
+ * @type jQuery
+ * @param String val Set the html contents to the specified value.
+ * @cat DOM/Attributes
+ */
html: "innerHTML",
- value: null,
+
+ /**
+ * Get the current id of the first matched element.
+ *
+ * @example $("input").id();
+ * @before <input type="text" id="test" value="some text"/>
+ * @result "test"
+ *
+ * @name id
+ * @type String
+ * @cat DOM/Attributes
+ */
+
+ /**
+ * Set the id of every matched element.
+ *
+ * @example $("input").id("newid");
+ * @before <input type="text" id="test" value="some text"/>
+ * @result <input type="text" id="newid" value="some text"/>
+ *
+ * @name id
+ * @type jQuery
+ * @param String val Set the property to the specified value.
+ * @cat DOM/Attributes
+ */
id: null,
+
+ /**
+ * Get the current title of the first matched element.
+ *
+ * @example $("img").title();
+ * @before <img src="test.jpg" title="my image"/>
+ * @result "my image"
+ *
+ * @name title
+ * @type String
+ * @cat DOM/Attributes
+ */
+
+ /**
+ * Set the title of every matched element.
+ *
+ * @example $("img").title("new title");
+ * @before <img src="test.jpg" title="my image"/>
+ * @result <img src="test.jpg" title="new image"/>
+ *
+ * @name title
+ * @type jQuery
+ * @param String val Set the property to the specified value.
+ * @cat DOM/Attributes
+ */
title: null,
+
+ /**
+ * Get the current name of the first matched element.
+ *
+ * @example $("input").name();
+ * @before <input type="text" name="username"/>
+ * @result "username"
+ *
+ * @name name
+ * @type String
+ * @cat DOM/Attributes
+ */
+
+ /**
+ * Set the name of every matched element.
+ *
+ * @example $("input").name("user");
+ * @before <input type="text" name="username"/>
+ * @result <input type="text" name="user"/>
+ *
+ * @name name
+ * @type jQuery
+ * @param String val Set the property to the specified value.
+ * @cat DOM/Attributes
+ */
name: null,
+
+ /**
+ * Get the current href of the first matched element.
+ *
+ * @example $("a").href();
+ * @before <a href="test.html">my link</a>
+ * @result "test.html"
+ *
+ * @name href
+ * @type String
+ * @cat DOM/Attributes
+ */
+
+ /**
+ * Set the href of every matched element.
+ *
+ * @example $("a").href("test2.html");
+ * @before <a href="test.html">my link</a>
+ * @result <a href="test2.html">my link</a>
+ *
+ * @name href
+ * @type jQuery
+ * @param String val Set the property to the specified value.
+ * @cat DOM/Attributes
+ */
href: null,
+
+ /**
+ * Get the current src of the first matched element.
+ *
+ * @example $("img").src();
+ * @before <img src="test.jpg" title="my image"/>
+ * @result "test.jpg"
+ *
+ * @name src
+ * @type String
+ * @cat DOM/Attributes
+ */
+
+ /**
+ * Set the src of every matched element.
+ *
+ * @example $("img").src("test2.jpg");
+ * @before <img src="test.jpg" title="my image"/>
+ * @result <img src="test2.jpg" title="my image"/>
+ *
+ * @name src
+ * @type jQuery
+ * @param String val Set the property to the specified value.
+ * @cat DOM/Attributes
+ */
src: null,
+
+ /**
+ * Get the current rel of the first matched element.
+ *
+ * @example $("a").rel();
+ * @before <a href="test.html" rel="nofollow">my link</a>
+ * @result "nofollow"
+ *
+ * @name rel
+ * @type String
+ * @cat DOM/Attributes
+ */
+
+ /**
+ * Set the rel of every matched element.
+ *
+ * @example $("a").rel("nofollow");
+ * @before <a href="test.html">my link</a>
+ * @result <a href="test.html" rel="nofollow">my link</a>
+ *
+ * @name rel
+ * @type jQuery
+ * @param String val Set the property to the specified value.
+ * @cat DOM/Attributes
+ */
rel: null
},
+
axis: {
/**
* Get a set of elements containing the unique parents of the matched
*
* @name parent
* @type jQuery
+ * @cat DOM/Traversing
*/
/**
* @name parent
* @type jQuery
* @param String expr An expression to filter the parents with
+ * @cat DOM/Traversing
*/
parent: "a.parentNode",
*
* @name ancestors
* @type jQuery
+ * @cat DOM/Traversing
*/
/**
* @name ancestors
* @type jQuery
* @param String expr An expression to filter the ancestors with
+ * @cat DOM/Traversing
*/
ancestors: jQuery.parents,
/**
- * A synonym for ancestors
+ * Get a set of elements containing the unique ancestors of the matched
+ * set of elements.
+ *
+ * @example $("span").ancestors()
+ * @before <html><body><div><p><span>Hello</span></p><span>Hello Again</span></div></body></html>
+ * @result [ <body>...</body>, <div>...</div>, <p><span>Hello</span></p> ]
+ *
+ * @name parents
+ * @type jQuery
+ * @cat DOM/Traversing
+ */
+
+ /**
+ * Get a set of elements containing the unique ancestors of the matched
+ * set of elements, and filtered by an expression.
+ *
+ * @example $("span").ancestors("p")
+ * @before <html><body><div><p><span>Hello</span></p><span>Hello Again</span></div></body></html>
+ * @result [ <p><span>Hello</span></p> ]
+ *
+ * @name parents
+ * @type jQuery
+ * @param String expr An expression to filter the ancestors with
+ * @cat DOM/Traversing
*/
parents: jQuery.parents,
*
* @name next
* @type jQuery
+ * @cat DOM/Traversing
*/
/**
* @name next
* @type jQuery
* @param String expr An expression to filter the next Elements with
+ * @cat DOM/Traversing
*/
next: "jQuery.sibling(a).next",
*
* @name prev
* @type jQuery
+ * @cat DOM/Traversing
*/
/**
*
* It only returns the immediately previous sibling, not all previous siblings.
*
- * @example $("p").previous("selected")
+ * @example $("p").previous(".selected")
* @before <div><span>Hello</span></div><p class="selected">Hello Again</p><p>And Again</p>
* @result [ <div><span>Hello</span></div> ]
*
* @name prev
* @type jQuery
* @param String expr An expression to filter the previous Elements with
+ * @cat DOM/Traversing
*/
prev: "jQuery.sibling(a).prev",
*
* @name siblings
* @type jQuery
+ * @cat DOM/Traversing
*/
/**
* 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")
+ * @example $("div").siblings(".selected")
* @before <div><span>Hello</span></div><p class="selected">Hello Again</p><p>And Again</p>
* @result [ <p class="selected">Hello Again</p> ]
*
* @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
+ * matched set of elements.
+ *
+ * @example $("div").children()
+ * @before <p>Hello</p><div><span>Hello Again</span></div><p>And Again</p>
+ * @result [ <span>Hello Again</span> ]
+ *
+ * @name children
+ * @type jQuery
+ * @cat DOM/Traversing
+ */
+
+ /**
+ * 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")
+ * @before <div><span>Hello</span><p class="selected">Hello Again</p><p>And Again</p></div>
+ * @result [ <p class="selected">Hello Again</p> ]
+ *
+ * @name children
+ * @type jQuery
+ * @param String expr An expression to filter the child Elements with
+ * @cat DOM/Traversing
*/
- siblings: jQuery.sibling
+ children: "a.childNodes"
},
each: {
*
* @name show
* @type jQuery
+ * @cat Effects
*/
- show: function(){
+ _show: function(){
this.style.display = this.oldblock ? this.oldblock : "";
if ( jQuery.css(this,"display") == "none" )
this.style.display = "block";
*
* @name hide
* @type jQuery
+ * @cat Effects
*/
- hide: function(){
+ _hide: function(){
this.oldblock = this.oldblock || jQuery.css(this,"display");
if ( this.oldblock == "none" )
this.oldblock = "block";
*
* @name toggle
* @type jQuery
+ * @cat Effects
*/
- toggle: function(){
+ _toggle: function(){
var d = jQuery.css(this,"display");
$(this)[ !d || d == "none" ? "show" : "hide" ]();
},
/**
* Adds the specified class to each of the set of matched elements.
*
- * @example ("p").addClass("selected")
+ * @example $("p").addClass("selected")
* @before <p>Hello</p>
* @result [ <p class="selected">Hello</p> ]
*
* @name addClass
* @type jQuery
* @param String class A CSS class to add to the elements
+ * @cat DOM
*/
addClass: function(c){
jQuery.className.add(this,c);
},
/**
- * The opposite of addClass. Removes the specified class from the
- * set of matched elements.
+ * Removes the specified class from the set of matched elements.
*
- * @example ("p").removeClass("selected")
+ * @example $("p").removeClass("selected")
* @before <p class="selected">Hello</p>
* @result [ <p>Hello</p> ]
*
* @name removeClass
* @type jQuery
* @param String class A CSS class to remove from the elements
+ * @cat DOM
*/
removeClass: function(c){
jQuery.className.remove(this,c);
},
/**
- * Adds the specified class if it is present. Remove it if it is
+ * Adds the specified class if it is present, removes it if it is
* not present.
*
- * @example ("p").toggleClass("selected")
+ * @example $("p").toggleClass("selected")
* @before <p>Hello</p><p class="selected">Hello Again</p>
* @result [ <p class="selected">Hello</p>, <p>Hello Again</p> ]
*
* @name toggleClass
* @type jQuery
* @param String class A CSS class with which to toggle the elements
+ * @cat DOM
*/
toggleClass: function( c ){
jQuery.className[ jQuery.className.has(this,c) ? "remove" : "add" ](this,c);
},
/**
- * TODO: Document
+ * Removes all matched elements from the DOM. This does NOT remove them from the
+ * jQuery object, allowing you to use the matched elements further.
+ *
+ * @example $("p").remove();
+ * @before <p>Hello</p> how are <p>you?</p>
+ * @result how are
+ *
+ * @name remove
+ * @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
+ * jQuery object, allowing you to use the matched elements further.
+ *
+ * @example $("p").remove(".hello");
+ * @before <p class="hello">Hello</p> how are <p>you?</p>
+ * @result how are <p>you?</p>
+ *
+ * @name remove
+ * @type jQuery
+ * @param String expr A jQuery expression to filter elements by.
+ * @cat DOM/Manipulation
*/
remove: function(a){
if ( !a || jQuery.filter( [this], a ).r )
/**
* Removes all child nodes from the set of matched elements.
*
- * @example ("p").empty()
+ * @example $("p").empty()
* @before <p>Hello, <span>Person</span> <a href="#">and person</a></p>
* @result [ <p></p> ]
*
* @name empty
* @type jQuery
+ * @cat DOM/Manipulation
*/
empty: function(){
while ( this.firstChild )
* @type jQuery
* @param String type An event type
* @param Function fn A function to bind to the event on each of the set of matched elements
+ * @cat Events
*/
bind: function( type, fn ) {
if ( fn.constructor == String )
},
/**
- * The opposite of bind. Removes a bound event from each of a set of matched
+ * The opposite of bind, removes a bound event from each of the matched
* elements. You must pass the identical function that was used in the original
* bind method.
*
* @example $("p").unbind( "click", function() { alert("Hello"); } )
- * @before <p>Hello</p>
+ * @before <p onclick="alert('Hello');">Hello</p>
* @result [ <p>Hello</p> ]
*
* @name unbind
* @type jQuery
* @param String type An event type
* @param Function fn A function to unbind from the event on each of the set of matched elements
+ * @cat Events
+ */
+
+ /**
+ * Removes all bound events of a particular type from each of the matched
+ * elements.
+ *
+ * @example $("p").unbind( "click" )
+ * @before <p onclick="alert('Hello');">Hello</p>
+ * @result [ <p>Hello</p> ]
+ *
+ * @name unbind
+ * @type jQuery
+ * @param String type An event type
+ * @cat Events
+ */
+
+ /**
+ * Removes all bound events from each of the matched elements.
+ *
+ * @example $("p").unbind()
+ * @before <p onclick="alert('Hello');">Hello</p>
+ * @result [ <p>Hello</p> ]
+ *
+ * @name unbind
+ * @type jQuery
+ * @cat Events
*/
unbind: function( type, fn ) {
jQuery.event.remove( this, type, fn );
},
/**
- * Trigger a particular event.
+ * Trigger a type of event on every matched element.
*
* @example $("p").trigger("click")
- * @before <p>Hello</p>
- * @result [ <p>Hello</p> ]
+ * @before <p click="alert('hello')">Hello</p>
+ * @result alert('hello')
*
* @name trigger
* @type jQuery
- * @param String type An event type
+ * @param String type An event type to trigger.
+ * @cat Events
*/
trigger: function( type, data ) {
jQuery.event.trigger( type, data, this );
}
}
-};
\ No newline at end of file
+};