docs/index.xml

   1 <?xml version='1.0' encoding='ISO-8859-1'?>
   2 <?xml-stylesheet type='text/xsl' href='style/docs.xsl'?>
   3 <docs>
   4 <method property='1' cat='Core' type='String' short='The current SVN version of jQuery.' private='1' name='jquery'>
   5 <desc>The current SVN version of jQuery.</desc>
   6 </method>
   7 <method short='The number of elements currently matched.' property='1' type='Number' name='length' cat='Core'>
   8 <desc>The number of elements currently matched.</desc>
   9 <examples>
  10 <code>$("img").length;</code>
  11 <result>2</result>
  12 <before>&lt;img src="test1.jpg"/&gt; &lt;img src="test2.jpg"/&gt;</before>
  13 </examples>
  14 </method>
  15 <method short='The number of elements currently matched.' type='Number' name='size' cat='Core'>
  16 <desc>The number of elements currently matched.</desc>
  17 <examples>
  18 <code>$("img").size();</code>
  19 <result>2</result>
  20 <before>&lt;img src="test1.jpg"/&gt; &lt;img src="test2.jpg"/&gt;</before>
  21 </examples>
  22 </method>
  23 <method short='Access all matched elements.' type='Array&lt;Element&gt;' name='get' cat='Core'>
  24 <desc>Access all matched elements. This serves as a backwards-compatible
  25 way of accessing all matched elements (other than the jQuery object
  26 itself, which is, in fact, an array of elements).</desc>
  27 <examples>
  28 <code>$("img").get();</code>
  29 <result>[ &lt;img src="test1.jpg"/&gt; &lt;img src="test2.jpg"/&gt; ]</result>
  30 <before>&lt;img src="test1.jpg"/&gt; &lt;img src="test2.jpg"/&gt;</before>
  31 </examples>
  32 </method>
  33 <method short='Access a single matched element.' type='Element' name='get' cat='Core'>
  34 <params type='Number' name='num'>
  35 <desc>Access the element in the Nth position.</desc>
  36 </params>
  37 <desc>Access a single matched element. num is used to access the
  38 Nth element matched.</desc>
  39 <examples>
  40 <code>$("img").get(1);</code>
  41 <result>[ &lt;img src="test1.jpg"/&gt; ]</result>
  42 <before>&lt;img src="test1.jpg"/&gt; &lt;img src="test2.jpg"/&gt;</before>
  43 </examples>
  44 </method>
  45 <method short='Set the jQuery object to an array of elements.' type='jQuery' name='get' private='1' cat='Core'>
  46 <params type='Elements' name='elems'>
  47 <desc>An array of elements</desc>
  48 </params>
  49 <desc>Set the jQuery object to an array of elements.</desc>
  50 <examples>
  51 <code>$("img").get([ document.body ]);</code>
  52 <result>$("img").get() == [ document.body ]</result>
  53 </examples>
  54 </method>
  55 <method short='Execute a function within the context of every matched element.' type='jQuery' name='each' cat='Core'>
  56 <params type='Function' name='fn'>
  57 <desc>A function to execute</desc>
  58 </params>
  59 <desc>Execute a function within the context of every matched element.
  60 This means that every time the passed-in function is executed
  61 (which is once for every element matched) the 'this' keyword
  62 points to the specific element.
  63
  64 Additionally, the function, when executed, is passed a single
  65 argument representing the position of the element in the matched
  66 set.</desc>
  67 <examples>
  68 <code>$("img").each(function(){ this.src = "test.jpg"; });</code>
  69 <result>&lt;img src="test.jpg"/&gt; &lt;img src="test.jpg"/&gt;</result>
  70 <before>&lt;img/&gt; &lt;img/&gt;</before>
  71 </examples>
  72 </method>
  73 <method short='Access a property on the first matched element.' type='Object' name='attr' cat='DOM'>
  74 <params type='String' name='name'>
  75 <desc>The name of the property to access.</desc>
  76 </params>
  77 <desc>Access a property on the first matched element.
  78 This method makes it easy to retreive a property value
  79 from the first matched element.</desc>
  80 <examples>
  81 <code>$("img").attr("src");</code>
  82 <result>test.jpg</result>
  83 <before>&lt;img src="test.jpg"/&gt;</before>
  84 </examples>
  85 </method>
  86 <method short='Set a hash of key/value object properties to all matched elements.' type='jQuery' name='attr' cat='DOM'>
  87 <params type='Hash' name='prop'>
  88 <desc>A set of key/value pairs to set as object properties.</desc>
  89 </params>
  90 <desc>Set a hash of key/value object properties to all matched elements.
  91 This serves as the best way to set a large number of properties
  92 on all matched elements.</desc>
  93 <examples>
  94 <code>$("img").attr({ src: "test.jpg", alt: "Test Image" });</code>
  95 <result>&lt;img src="test.jpg" alt="Test Image"/&gt;</result>
  96 <before>&lt;img/&gt;</before>
  97 </examples>
  98 </method>
  99 <method short='Set a single property to a value, on all matched elements.' type='jQuery' name='attr' cat='DOM'>
 100 <params type='String' name='key'>
 101 <desc>The name of the property to set.</desc>
 102 </params>
 103 <params type='Object' name='value'>
 104 <desc>The value to set the property to.</desc>
 105 </params>
 106 <desc>Set a single property to a value, on all matched elements.</desc>
 107 <examples>
 108 <code>$("img").attr("src","test.jpg");</code>
 109 <result>&lt;img src="test.jpg"/&gt;</result>
 110 <before>&lt;img/&gt;</before>
 111 </examples>
 112 </method>
 113 <method short='Access a style property on the first matched element.' type='Object' name='css' cat='CSS'>
 114 <params type='String' name='name'>
 115 <desc>The name of the property to access.</desc>
 116 </params>
 117 <desc>Access a style property on the first matched element.
 118 This method makes it easy to retreive a style property value
 119 from the first matched element.</desc>
 120 <examples>
 121 <code>$("p").css("red");</code>
 122 <result>red</result>
 123 <before>&lt;p style="color:red;"&gt;Test Paragraph.&lt;/p&gt;</before>
 124 </examples>
 125 </method>
 126 <method short='Set a hash of key/value style properties to all matched elements.' type='jQuery' name='css' cat='CSS'>
 127 <params type='Hash' name='prop'>
 128 <desc>A set of key/value pairs to set as style properties.</desc>
 129 </params>
 130 <desc>Set a hash of key/value style properties to all matched elements.
 131 This serves as the best way to set a large number of style properties
 132 on all matched elements.</desc>
 133 <examples>
 134 <code>$("p").css({ color: "red", background: "blue" });</code>
 135 <result>&lt;p style="color:red; background:blue;"&gt;Test Paragraph.&lt;/p&gt;</result>
 136 <before>&lt;p&gt;Test Paragraph.&lt;/p&gt;</before>
 137 </examples>
 138 </method>
 139 <method short='Set a single style property to a value, on all matched elements.' type='jQuery' name='css' cat='CSS'>
 140 <params type='String' name='key'>
 141 <desc>The name of the property to set.</desc>
 142 </params>
 143 <params type='Object' name='value'>
 144 <desc>The value to set the property to.</desc>
 145 </params>
 146 <desc>Set a single style property to a value, on all matched elements.</desc>
 147 <examples>
 148 <code>$("p").css("color","red");</code>
 149 <result>&lt;p style="color:red;"&gt;Test Paragraph.&lt;/p&gt;</result>
 150 <before>&lt;p&gt;Test Paragraph.&lt;/p&gt;</before>
 151 </examples>
 152 </method>
 153 <method short='Retreive the text contents of all matched elements.' type='String' name='text' cat='DOM'>
 154 <desc>Retreive the text contents of all matched elements. The result is
 155 a string that contains the combined text contents of all matched
 156 elements. This method works on both HTML and XML documents.</desc>
 157 <examples>
 158 <code>$("p").text();</code>
 159 <result>Test Paragraph.</result>
 160 <before>&lt;p&gt;Test Paragraph.&lt;/p&gt;</before>
 161 </examples>
 162 </method>
 163 <method short='Wrap all matched elements with a structure of other elements.' type='jQuery' name='wrap' cat='DOM/Manipulation'>
 164 <params any='1' type='String' name='html'>
 165 <desc>A string of HTML, that will be created on the fly and wrapped around the target.</desc>
 166 </params>
 167 <params any='1' type='Element' name='elem'>
 168 <desc>A DOM element that will be wrapped.</desc>
 169 </params>
 170 <params any='1' type='Array&lt;Element&gt;' name='elems'>
 171 <desc>An array of elements, the first of which will be wrapped.</desc>
 172 </params>
 173 <params any='1' type='Object' name='obj'>
 174 <desc>Any object, converted to a string, then a text node.</desc>
 175 </params>
 176 <desc>Wrap all matched elements with a structure of other elements.
 177 This wrapping process is most useful for injecting additional
 178 stucture into a document, without ruining the original semantic
 179 qualities of a document.
 180
 181 The way that is works is that it goes through the first element argument
 182 provided and finds the deepest element within the structure - it is that
 183 element that will en-wrap everything else.</desc>
 184 <examples>
 185 <code>$("p").wrap("&lt;div class='wrap'&gt;&lt;/div&gt;");</code>
 186 <result>&lt;div class='wrap'&gt;&lt;p&gt;Test Paragraph.&lt;/p&gt;&lt;/div&gt;</result>
 187 <before>&lt;p&gt;Test Paragraph.&lt;/p&gt;</before>
 188 </examples>
 189 </method>
 190 <method short='Append any number of elements to the inside of all matched elements.' type='jQuery' name='append' cat='DOM/Manipulation'>
 191 <params any='1' type='String' name='html'>
 192 <desc>A string of HTML, that will be created on the fly and appended to the target.</desc>
 193 </params>
 194 <params any='1' type='Element' name='elem'>
 195 <desc>A DOM element that will be appended.</desc>
 196 </params>
 197 <params any='1' type='Array&lt;Element&gt;' name='elems'>
 198 <desc>An array of elements, all of which will be appended.</desc>
 199 </params>
 200 <params any='1' type='Object' name='obj'>
 201 <desc>Any object, converted to a string, then a text node.</desc>
 202 </params>
 203 <desc>Append any number of elements to the inside of all matched elements.
 204 This operation is similar to doing an appendChild to all the
 205 specified elements, adding them into the document.</desc>
 206 <examples>
 207 <code>$("p").append("&lt;b&gt;Hello&lt;/b&gt;");</code>
 208 <result>&lt;p&gt;I would like to say: &lt;b&gt;Hello&lt;/b&gt;&lt;/p&gt;</result>
 209 <before>&lt;p&gt;I would like to say: &lt;/p&gt;</before>
 210 </examples>
 211 </method>
 212 <method short='Prepend any number of elements to the inside of all matched elements.' type='jQuery' name='prepend' cat='DOM/Manipulation'>
 213 <params any='1' type='String' name='html'>
 214 <desc>A string of HTML, that will be created on the fly and prepended to the target.</desc>
 215 </params>
 216 <params any='1' type='Element' name='elem'>
 217 <desc>A DOM element that will be prepended.</desc>
 218 </params>
 219 <params any='1' type='Array&lt;Element&gt;' name='elems'>
 220 <desc>An array of elements, all of which will be prepended.</desc>
 221 </params>
 222 <params any='1' type='Object' name='obj'>
 223 <desc>Any object, converted to a string, then a text node.</desc>
 224 </params>
 225 <desc>Prepend any number of elements to the inside of all matched elements.
 226 This operation is the best way to insert a set of elements inside, at the
 227 beginning, of all the matched element.</desc>
 228 <examples>
 229 <code>$("p").prepend("&lt;b&gt;Hello&lt;/b&gt;");</code>
 230 <result>&lt;p&gt;&lt;b&gt;Hello&lt;/b&gt;, how are you?&lt;/p&gt;</result>
 231 <before>&lt;p&gt;, how are you?&lt;/p&gt;</before>
 232 </examples>
 233 </method>
 234 <method short='Insert any number of elements before each of the matched elements.' type='jQuery' name='before' cat='DOM/Manipulation'>
 235 <params any='1' type='String' name='html'>
 236 <desc>A string of HTML, that will be created on the fly and inserted.</desc>
 237 </params>
 238 <params any='1' type='Element' name='elem'>
 239 <desc>A DOM element that will beinserted.</desc>
 240 </params>
 241 <params any='1' type='Array&lt;Element&gt;' name='elems'>
 242 <desc>An array of elements, all of which will be inserted.</desc>
 243 </params>
 244 <params any='1' type='Object' name='obj'>
 245 <desc>Any object, converted to a string, then a text node.</desc>
 246 </params>
 247 <desc>Insert any number of elements before each of the matched elements.</desc>
 248 <examples>
 249 <code>$("p").before("&lt;b&gt;Hello&lt;/b&gt;");</code>
 250 <result>&lt;b&gt;Hello&lt;/b&gt;&lt;p&gt;how are you?&lt;/p&gt;</result>
 251 <before>&lt;p&gt;how are you?&lt;/p&gt;</before>
 252 </examples>
 253 </method>
 254 <method short='Insert any number of elements after each of the matched elements.' type='jQuery' name='after' cat='DOM/Manipulation'>
 255 <params any='1' type='String' name='html'>
 256 <desc>A string of HTML, that will be created on the fly and inserted.</desc>
 257 </params>
 258 <params any='1' type='Element' name='elem'>
 259 <desc>A DOM element that will beinserted.</desc>
 260 </params>
 261 <params any='1' type='Array&lt;Element&gt;' name='elems'>
 262 <desc>An array of elements, all of which will be inserted.</desc>
 263 </params>
 264 <params any='1' type='Object' name='obj'>
 265 <desc>Any object, converted to a string, then a text node.</desc>
 266 </params>
 267 <desc>Insert any number of elements after each of the matched elements.</desc>
 268 <examples>
 269 <code>$("p").after("&lt;p&gt;I'm doing fine.&lt;/p&gt;");</code>
 270 <result>&lt;p&gt;How are you?&lt;/p&gt;&lt;p&gt;I'm doing fine.&lt;/p&gt;</result>
 271 <before>&lt;p&gt;How are you?&lt;/p&gt;</before>
 272 </examples>
 273 </method>
 274 <method short='End the most recent &apos;destructive&apos; operation, reverting the list of matched elements
 275 back to its previous state.' type='jQuery' name='end' cat='DOM/Traversing'>
 276 <desc>End the most recent 'destructive' operation, reverting the list of matched elements
 277 back to its previous state. After an end operation, the list of matched elements will
 278 revert to the last state of matched elements.</desc>
 279 <examples>
 280 <code>$("p").find("span").end();</code>
 281 <result>$("p").find("span").end() == [ &lt;p&gt;...&lt;/p&gt; ]</result>
 282 <before>&lt;p&gt;&lt;span&gt;Hello&lt;/span&gt;, how are you?&lt;/p&gt;</before>
 283 </examples>
 284 </method>
 285 <method short='Searches for all elements that match the specified expression.' type='jQuery' name='find' cat='DOM/Traversing'>
 286 <params type='String' name='expr'>
 287 <desc>An expression to search with.</desc>
 288 </params>
 289 <desc>Searches for all elements that match the specified expression.
 290 This method is the optimal way of finding additional descendant
 291 elements with which to process.
 292
 293 All searching is done using a jQuery expression. The expression can be
 294 written using CSS 1-3 Selector syntax, or basic XPath.</desc>
 295 <examples>
 296 <code>$("p").find("span");</code>
 297 <result>$("p").find("span") == [ &lt;span&gt;Hello&lt;/span&gt; ]</result>
 298 <before>&lt;p&gt;&lt;span&gt;Hello&lt;/span&gt;, how are you?&lt;/p&gt;</before>
 299 </examples>
 300 </method>
 301 <method short='Removes all elements from the set of matched elements that do not
 302 match the specified expression.' type='jQuery' name='filter' cat='DOM/Traversing'>
 303 <params type='String' name='expr'>
 304 <desc>An expression to search with.</desc>
 305 </params>
 306 <desc>Removes all elements from the set of matched elements that do not
 307 match the specified expression. This method is used to narrow down
 308 the results of a search.
 309
 310 All searching is done using a jQuery expression. The expression
 311 can be written using CSS 1-3 Selector syntax, or basic XPath.</desc>
 312 <examples>
 313 <code>$("p").filter(".selected")</code>
 314 <result>$("p").filter(".selected") == [ &lt;p class="selected"&gt;Hello&lt;/p&gt; ]</result>
 315 <before>&lt;p class="selected"&gt;Hello&lt;/p&gt;&lt;p&gt;How are you?&lt;/p&gt;</before>
 316 </examples>
 317 </method>
 318 <method short='Removes all elements from the set of matched elements that do not
 319 match at least one of the expressions passed to the function.' type='jQuery' name='filter' cat='DOM/Traversing'>
 320 <params type='Array&lt;String&gt;' name='exprs'>
 321 <desc>A set of expressions to evaluate against</desc>
 322 </params>
 323 <desc>Removes all elements from the set of matched elements that do not
 324 match at least one of the expressions passed to the function. This
 325 method is used when you want to filter the set of matched elements
 326 through more than one expression.
 327
 328 Elements will be retained in the jQuery object if they match at
 329 least one of the expressions passed.</desc>
 330 <examples>
 331 <code>$("p").filter([".selected", ":first"])</code>
 332 <result>$("p").filter([".selected", ":first"]) == [ &lt;p&gt;Hello&lt;/p&gt;, &lt;p class="selected"&gt;And Again&lt;/p&gt; ]</result>
 333 <before>&lt;p&gt;Hello&lt;/p&gt;&lt;p&gt;Hello Again&lt;/p&gt;&lt;p class="selected"&gt;And Again&lt;/p&gt;</before>
 334 </examples>
 335 </method>
 336 <method short='Removes the specified Element from the set of matched elements.' type='jQuery' name='not' cat='DOM/Traversing'>
 337 <params type='Element' name='el'>
 338 <desc>An element to remove from the set</desc>
 339 </params>
 340 <desc>Removes the specified Element from the set of matched elements. This
 341 method is used to remove a single Element from a jQuery object.</desc>
 342 <examples>
 343 <code>$("p").not( document.getElementById("selected") )</code>
 344 <result>[ &lt;p&gt;Hello&lt;/p&gt; ]</result>
 345 <before>&lt;p&gt;Hello&lt;/p&gt;&lt;p id="selected"&gt;Hello Again&lt;/p&gt;</before>
 346 </examples>
 347 </method>
 348 <method short='Removes elements matching the specified expression from the set
 349 of matched elements.' type='jQuery' name='not' cat='DOM/Traversing'>
 350 <params type='String' name='expr'>
 351 <desc>An expression with which to remove matching elements</desc>
 352 </params>
 353 <desc>Removes elements matching the specified expression from the set
 354 of matched elements. This method is used to remove one or more
 355 elements from a jQuery object.</desc>
 356 <examples>
 357 <code>$("p").not("#selected")</code>
 358 <result>[ &lt;p&gt;Hello&lt;/p&gt; ]</result>
 359 <before>&lt;p&gt;Hello&lt;/p&gt;&lt;p id="selected"&gt;Hello Again&lt;/p&gt;</before>
 360 </examples>
 361 </method>
 362 <method short='Adds the elements matched by the expression to the jQuery object.' type='jQuery' name='add' cat='DOM/Traversing'>
 363 <params type='String' name='expr'>
 364 <desc>An expression whose matched elements are added</desc>
 365 </params>
 366 <desc>Adds the elements matched by the expression to the jQuery object. This
 367 can be used to concatenate the result sets of two expressions.</desc>
 368 <examples>
 369 <code>$("p").add("span")</code>
 370 <result>[ &lt;p&gt;Hello&lt;/p&gt;, &lt;span&gt;Hello Again&lt;/span&gt; ]</result>
 371 <before>&lt;p&gt;Hello&lt;/p&gt;&lt;p&gt;&lt;span&gt;Hello Again&lt;/span&gt;&lt;/p&gt;</before>
 372 </examples>
 373 </method>
 374 <method short='Adds each of the Elements in the array to the set of matched elements.' type='jQuery' name='add' cat='jQuery'>
 375 <params type='Array&lt;Element&gt;' name='els'>
 376 <desc>An array of Elements to add</desc>
 377 </params>
 378 <desc>Adds each of the Elements in the array to the set of matched elements.
 379 This is used to add a set of Elements to a jQuery object.</desc>
 380 <examples>
 381 <code>$("p").add([document.getElementById("a"), document.getElementById("b")])</code>
 382 <result>[ &lt;p&gt;Hello&lt;/p&gt;, &lt;span id="a"&gt;Hello Again&lt;/span&gt;, &lt;span id="b"&gt;And Again&lt;/span&gt; ]</result>
 383 <before>&lt;p&gt;Hello&lt;/p&gt;&lt;p&gt;&lt;span id="a"&gt;Hello Again&lt;/span&gt;&lt;span id="b"&gt;And Again&lt;/span&gt;&lt;/p&gt;</before>
 384 </examples>
 385 </method>
 386 <method short='Adds a single Element to the set of matched elements.' type='jQuery' name='add' cat='jQuery'>
 387 <params type='Element' name='el'>
 388 <desc>An Element to add</desc>
 389 </params>
 390 <desc>Adds a single Element to the set of matched elements. This is used to
 391 add a single Element to a jQuery object.</desc>
 392 <examples>
 393 <code>$("p").add( document.getElementById("a") )</code>
 394 <result>[ &lt;p&gt;Hello&lt;/p&gt;, &lt;span id="a"&gt;Hello Again&lt;/span&gt; ]</result>
 395 <before>&lt;p&gt;Hello&lt;/p&gt;&lt;p&gt;&lt;span id="a"&gt;Hello Again&lt;/span&gt;&lt;/p&gt;</before>
 396 </examples>
 397 </method>
 398 <method type='jQuery' name='domManip' private='1' short=''>
 399 <params type='Array' name='args'>
 400 <desc></desc>
 401 </params>
 402 <params type='Boolean' name='table'>
 403 <desc></desc>
 404 </params>
 405 <params type='Number' name='int'>
 406 <desc></desc>
 407 </params>
 408 <params type='Function' name='fn'>
 409 <desc>The function doing the DOM manipulation.</desc>
 410 </params>
 411 <desc></desc>
 412 </method>
 413 <method type='jQuery' name='pushStack' private='1' short=''>
 414 <params type='Array' name='a'>
 415 <desc></desc>
 416 </params>
 417 <params type='Array' name='args'>
 418 <desc></desc>
 419 </params>
 420 <desc></desc>
 421 </method>
 422 <method type='Object' name='extend' private='1' short=''>
 423 <params type='Object' name='obj'>
 424 <desc></desc>
 425 </params>
 426 <params type='Object' name='prop'>
 427 <desc></desc>
 428 </params>
 429 <desc></desc>
 430 </method>
 431 <method short='Extend one object with another, returning the original,
 432 modified, object.' type='Object' name='$.extend' cat='Javascript'>
 433 <params type='Object' name='obj'>
 434 <desc>The object to extend</desc>
 435 </params>
 436 <params type='Object' name='prop'>
 437 <desc>The object that will be merged into the first.</desc>
 438 </params>
 439 <desc>Extend one object with another, returning the original,
 440 modified, object. This is a great utility for simple inheritance.</desc>
 441 </method>
 442 <method type='undefined' name='init' private='1' short=''>
 443 <desc></desc>
 444 </method>
 445 <method short='A generic iterator function, which can be used to seemlessly
 446 iterate over both objects and arrays.' type='Object' name='$.each' cat='Javascript'>
 447 <params type='Object' name='obj'>
 448 <desc>The object, or array, to iterate over.</desc>
 449 </params>
 450 <params type='Object' name='fn'>
 451 <desc>The function that will be executed on every object.</desc>
 452 </params>
 453 <desc>A generic iterator function, which can be used to seemlessly
 454 iterate over both objects and arrays.</desc>
 455 </method>
 456 <method type='String' name='$.trim' private='1' short='Remove the whitespace from the beginning and end of a string.'>
 457 <params type='String' name='str'>
 458 <desc>The string to trim.</desc>
 459 </params>
 460 <desc>Remove the whitespace from the beginning and end of a string.</desc>
 461 </method>
 462 <method type='Array&lt;Element&gt;' name='$.parents' private='1' short='All ancestors of a given element.'>
 463 <params type='Element' name='elem'>
 464 <desc>The element to find the ancestors of.</desc>
 465 </params>
 466 <desc>All ancestors of a given element.</desc>
 467 </method>
 468 <method type='Array' name='$.sibling' private='1' short='All elements on a specified axis.'>
 469 <params type='Element' name='elem'>
 470 <desc>The element to find all the siblings of (including itself).</desc>
 471 </params>
 472 <desc>All elements on a specified axis.</desc>
 473 </method>
 474 <method type='Array' name='$.merge' private='1' short='Merge two arrays together, removing all duplicates.'>
 475 <params type='Array' name='a'>
 476 <desc>The first array to merge.</desc>
 477 </params>
 478 <params type='Array' name='b'>
 479 <desc>The second array to merge.</desc>
 480 </params>
 481 <desc>Merge two arrays together, removing all duplicates.</desc>
 482 </method>
 483 <method type='Array' name='$.grep' private='1' short='Remove items that aren&apos;t matched in an array.'>
 484 <params type='Array' name='array'>
 485 <desc>The Array to find items in.</desc>
 486 </params>
 487 <params type='Function' name='fn'>
 488 <desc>The function to process each item against.</desc>
 489 </params>
 490 <params type='Boolean' name='inv'>
 491 <desc>Invert the selection - select the opposite of the function.</desc>
 492 </params>
 493 <desc>Remove items that aren't matched in an array. The function passed
 494 in to this method will be passed two arguments: 'a' (which is the
 495 array item) and 'i' (which is the index of the item in the array).</desc>
 496 </method>
 497 <method type='Array' name='$.map' private='1' short='Translate all items in array to another array of items.'>
 498 <params type='Array' name='array'>
 499 <desc>The Array to translate.</desc>
 500 </params>
 501 <params type='Function' name='fn'>
 502 <desc>The function to process each item against.</desc>
 503 </params>
 504 <desc>Translate all items in array to another array of items. The translation function
 505 that is provided to this method is passed one argument: 'a' (the item to be
 506 translated). If an array is returned, that array is mapped out and merged into
 507 the full array. Additionally, returning 'null' or 'undefined' will delete the item
 508 from the array. Both of these changes imply that the size of the array may not
 509 be the same size upon completion, as it was when it started.</desc>
 510 </method>
 511 <method short='Append all of the matched elements to another, specified, set of elements.' type='jQuery' name='appendTo' cat='DOM/Manipulation'>
 512 <params type='String' name='expr'>
 513 <desc>A jQuery expression of elements to match.</desc>
 514 </params>
 515 <desc>Append all of the matched elements to another, specified, set of elements.
 516 This operation is, essentially, the reverse of doing a regular
 517 $(A).append(B), in that instead of appending B to A, you're appending
 518 A to B.</desc>
 519 <examples>
 520 <code>$("p").appendTo("#foo");</code>
 521 <result>&lt;div id="foo"&gt;&lt;p&gt;I would like to say: &lt;/p&gt;&lt;/div&gt;</result>
 522 <before>&lt;p&gt;I would like to say: &lt;/p&gt;&lt;div id="foo"&gt;&lt;/div&gt;</before>
 523 </examples>
 524 </method>
 525 <method short='Prepend all of the matched elements to another, specified, set of elements.' type='jQuery' name='prependTo' cat='DOM/Manipulation'>
 526 <params type='String' name='expr'>
 527 <desc>A jQuery expression of elements to match.</desc>
 528 </params>
 529 <desc>Prepend all of the matched elements to another, specified, set of elements.
 530 This operation is, essentially, the reverse of doing a regular
 531 $(A).prepend(B), in that instead of prepending B to A, you're prepending
 532 A to B.</desc>
 533 <examples>
 534 <code>$("p").prependTo("#foo");</code>
 535 <result>&lt;div id="foo"&gt;&lt;p&gt;I would like to say: &lt;/p&gt;&lt;b&gt;Hello&lt;/b&gt;&lt;/div&gt;</result>
 536 <before>&lt;p&gt;I would like to say: &lt;/p&gt;&lt;div id="foo"&gt;&lt;b&gt;Hello&lt;/b&gt;&lt;/div&gt;</before>
 537 </examples>
 538 </method>
 539 <method short='Insert all of the matched elements before another, specified, set of elements.' type='jQuery' name='insertBefore' cat='DOM/Manipulation'>
 540 <params type='String' name='expr'>
 541 <desc>A jQuery expression of elements to match.</desc>
 542 </params>
 543 <desc>Insert all of the matched elements before another, specified, set of elements.
 544 This operation is, essentially, the reverse of doing a regular
 545 $(A).before(B), in that instead of inserting B before A, you're inserting
 546 A before B.</desc>
 547 <examples>
 548 <code>$("p").insertBefore("#foo");</code>
 549 <result>&lt;p&gt;I would like to say: &lt;/p&gt;&lt;div id="foo"&gt;Hello&lt;/div&gt;</result>
 550 <before>&lt;div id="foo"&gt;Hello&lt;/div&gt;&lt;p&gt;I would like to say: &lt;/p&gt;</before>
 551 </examples>
 552 </method>
 553 <method short='Insert all of the matched elements after another, specified, set of elements.' type='jQuery' name='insertAfter' cat='DOM/Manipulation'>
 554 <params type='String' name='expr'>
 555 <desc>A jQuery expression of elements to match.</desc>
 556 </params>
 557 <desc>Insert all of the matched elements after another, specified, set of elements.
 558 This operation is, essentially, the reverse of doing a regular
 559 $(A).after(B), in that instead of inserting B after A, you're inserting
 560 A after B.</desc>
 561 <examples>
 562 <code>$("p").insertAfter("#foo");</code>
 563 <result>&lt;div id="foo"&gt;Hello&lt;/div&gt;&lt;p&gt;I would like to say: &lt;/p&gt;</result>
 564 <before>&lt;p&gt;I would like to say: &lt;/p&gt;&lt;div id="foo"&gt;Hello&lt;/div&gt;</before>
 565 </examples>
 566 </method>
 567 <method short='Get the current CSS width of the first matched element.' type='String' name='width' cat='CSS'>
 568 <desc>Get the current CSS width of the first matched element.</desc>
 569 <examples>
 570 <code>$("p").width();</code>
 571 <result>"300px"</result>
 572 <before>&lt;p&gt;This is just a test.&lt;/p&gt;</before>
 573 </examples>
 574 </method>
 575 <method short='Set the CSS width of every matched element.' type='jQuery' name='width' cat='CSS'>
 576 <params type='String' name='val'>
 577 <desc>Set the CSS property to the specified value.</desc>
 578 </params>
 579 <desc>Set the CSS width of every matched element. Be sure to include
 580 the "px" (or other unit of measurement) after the number that you
 581 specify, otherwise you might get strange results.</desc>
 582 <examples>
 583 <code>$("p").width("20px");</code>
 584 <result>&lt;p style="width:20px;"&gt;This is just a test.&lt;/p&gt;</result>
 585 <before>&lt;p&gt;This is just a test.&lt;/p&gt;</before>
 586 </examples>
 587 </method>
 588 <method short='Get the current CSS height of the first matched element.' type='String' name='height' cat='CSS'>
 589 <desc>Get the current CSS height of the first matched element.</desc>
 590 <examples>
 591 <code>$("p").height();</code>
 592 <result>"14px"</result>
 593 <before>&lt;p&gt;This is just a test.&lt;/p&gt;</before>
 594 </examples>
 595 </method>
 596 <method short='Set the CSS height of every matched element.' type='jQuery' name='height' cat='CSS'>
 597 <params type='String' name='val'>
 598 <desc>Set the CSS property to the specified value.</desc>
 599 </params>
 600 <desc>Set the CSS height of every matched element. Be sure to include
 601 the "px" (or other unit of measurement) after the number that you
 602 specify, otherwise you might get strange results.</desc>
 603 <examples>
 604 <code>$("p").height("20px");</code>
 605 <result>&lt;p style="height:20px;"&gt;This is just a test.&lt;/p&gt;</result>
 606 <before>&lt;p&gt;This is just a test.&lt;/p&gt;</before>
 607 </examples>
 608 </method>
 609 <method short='Get the current CSS top of the first matched element.' type='String' name='top' cat='CSS'>
 610 <desc>Get the current CSS top of the first matched element.</desc>
 611 <examples>
 612 <code>$("p").top();</code>
 613 <result>"0px"</result>
 614 <before>&lt;p&gt;This is just a test.&lt;/p&gt;</before>
 615 </examples>
 616 </method>
 617 <method short='Set the CSS top of every matched element.' type='jQuery' name='top' cat='CSS'>
 618 <params type='String' name='val'>
 619 <desc>Set the CSS property to the specified value.</desc>
 620 </params>
 621 <desc>Set the CSS top of every matched element. Be sure to include
 622 the "px" (or other unit of measurement) after the number that you
 623 specify, otherwise you might get strange results.</desc>
 624 <examples>
 625 <code>$("p").top("20px");</code>
 626 <result>&lt;p style="top:20px;"&gt;This is just a test.&lt;/p&gt;</result>
 627 <before>&lt;p&gt;This is just a test.&lt;/p&gt;</before>
 628 </examples>
 629 </method>
 630 <method short='Get the current CSS left of the first matched element.' type='String' name='left' cat='CSS'>
 631 <desc>Get the current CSS left of the first matched element.</desc>
 632 <examples>
 633 <code>$("p").left();</code>
 634 <result>"0px"</result>
 635 <before>&lt;p&gt;This is just a test.&lt;/p&gt;</before>
 636 </examples>
 637 </method>
 638 <method short='Set the CSS left of every matched element.' type='jQuery' name='left' cat='CSS'>
 639 <params type='String' name='val'>
 640 <desc>Set the CSS property to the specified value.</desc>
 641 </params>
 642 <desc>Set the CSS left of every matched element. Be sure to include
 643 the "px" (or other unit of measurement) after the number that you
 644 specify, otherwise you might get strange results.</desc>
 645 <examples>
 646 <code>$("p").left("20px");</code>
 647 <result>&lt;p style="left:20px;"&gt;This is just a test.&lt;/p&gt;</result>
 648 <before>&lt;p&gt;This is just a test.&lt;/p&gt;</before>
 649 </examples>
 650 </method>
 651 <method short='Get the current CSS position of the first matched element.' type='String' name='position' cat='CSS'>
 652 <desc>Get the current CSS position of the first matched element.</desc>
 653 <examples>
 654 <code>$("p").position();</code>
 655 <result>"static"</result>
 656 <before>&lt;p&gt;This is just a test.&lt;/p&gt;</before>
 657 </examples>
 658 </method>
 659 <method short='Set the CSS position of every matched element.' type='jQuery' name='position' cat='CSS'>
 660 <params type='String' name='val'>
 661 <desc>Set the CSS property to the specified value.</desc>
 662 </params>
 663 <desc>Set the CSS position of every matched element.</desc>
 664 <examples>
 665 <code>$("p").position("relative");</code>
 666 <result>&lt;p style="position:relative;"&gt;This is just a test.&lt;/p&gt;</result>
 667 <before>&lt;p&gt;This is just a test.&lt;/p&gt;</before>
 668 </examples>
 669 </method>
 670 <method short='Get the current CSS float of the first matched element.' type='String' name='float' cat='CSS'>
 671 <desc>Get the current CSS float of the first matched element.</desc>
 672 <examples>
 673 <code>$("p").float();</code>
 674 <result>"none"</result>
 675 <before>&lt;p&gt;This is just a test.&lt;/p&gt;</before>
 676 </examples>
 677 </method>
 678 <method short='Set the CSS float of every matched element.' type='jQuery' name='float' cat='CSS'>
 679 <params type='String' name='val'>
 680 <desc>Set the CSS property to the specified value.</desc>
 681 </params>
 682 <desc>Set the CSS float of every matched element.</desc>
 683 <examples>
 684 <code>$("p").float("left");</code>
 685 <result>&lt;p style="float:left;"&gt;This is just a test.&lt;/p&gt;</result>
 686 <before>&lt;p&gt;This is just a test.&lt;/p&gt;</before>
 687 </examples>
 688 </method>
 689 <method short='Get the current CSS overflow of the first matched element.' type='String' name='overflow' cat='CSS'>
 690 <desc>Get the current CSS overflow of the first matched element.</desc>
 691 <examples>
 692 <code>$("p").overflow();</code>
 693 <result>"none"</result>
 694 <before>&lt;p&gt;This is just a test.&lt;/p&gt;</before>
 695 </examples>
 696 </method>
 697 <method short='Set the CSS overflow of every matched element.' type='jQuery' name='overflow' cat='CSS'>
 698 <params type='String' name='val'>
 699 <desc>Set the CSS property to the specified value.</desc>
 700 </params>
 701 <desc>Set the CSS overflow of every matched element.</desc>
 702 <examples>
 703 <code>$("p").overflow("auto");</code>
 704 <result>&lt;p style="overflow:auto;"&gt;This is just a test.&lt;/p&gt;</result>
 705 <before>&lt;p&gt;This is just a test.&lt;/p&gt;</before>
 706 </examples>
 707 </method>
 708 <method short='Get the current CSS color of the first matched element.' type='String' name='color' cat='CSS'>
 709 <desc>Get the current CSS color of the first matched element.</desc>
 710 <examples>
 711 <code>$("p").color();</code>
 712 <result>"black"</result>
 713 <before>&lt;p&gt;This is just a test.&lt;/p&gt;</before>
 714 </examples>
 715 </method>
 716 <method short='Set the CSS color of every matched element.' type='jQuery' name='color' cat='CSS'>
 717 <params type='String' name='val'>
 718 <desc>Set the CSS property to the specified value.</desc>
 719 </params>
 720 <desc>Set the CSS color of every matched element.</desc>
 721 <examples>
 722 <code>$("p").color("blue");</code>
 723 <result>&lt;p style="color:blue;"&gt;This is just a test.&lt;/p&gt;</result>
 724 <before>&lt;p&gt;This is just a test.&lt;/p&gt;</before>
 725 </examples>
 726 </method>
 727 <method short='Get the current CSS background of the first matched element.' type='String' name='background' cat='CSS'>
 728 <desc>Get the current CSS background of the first matched element.</desc>
 729 <examples>
 730 <code>$("p").background();</code>
 731 <result>""</result>
 732 <before>&lt;p&gt;This is just a test.&lt;/p&gt;</before>
 733 </examples>
 734 </method>
 735 <method short='Set the CSS background of every matched element.' type='jQuery' name='background' cat='CSS'>
 736 <params type='String' name='val'>
 737 <desc>Set the CSS property to the specified value.</desc>
 738 </params>
 739 <desc>Set the CSS background of every matched element.</desc>
 740 <examples>
 741 <code>$("p").background("blue");</code>
 742 <result>&lt;p style="background:blue;"&gt;This is just a test.&lt;/p&gt;</result>
 743 <before>&lt;p&gt;This is just a test.&lt;/p&gt;</before>
 744 </examples>
 745 </method>
 746 <method short='Get the current value of the first matched element.' type='String' name='val' cat='DOM/Attributes'>
 747 <desc>Get the current value of the first matched element.</desc>
 748 <examples>
 749 <code>$("input").val();</code>
 750 <result>"some text"</result>
 751 <before>&lt;input type="text" value="some text"/&gt;</before>
 752 </examples>
 753 </method>
 754 <method short='Set the value of every matched element.' type='jQuery' name='val' cat='DOM/Attributes'>
 755 <params type='String' name='val'>
 756 <desc>Set the property to the specified value.</desc>
 757 </params>
 758 <desc>Set the value of every matched element.</desc>
 759 <examples>
 760 <code>$("input").value("test");</code>
 761 <result>&lt;input type="text" value="test"/&gt;</result>
 762 <before>&lt;input type="text" value="some text"/&gt;</before>
 763 </examples>
 764 </method>
 765 <method short='Get the html contents of the first matched element.' type='String' name='html' cat='DOM/Attributes'>
 766 <desc>Get the html contents of the first matched element.</desc>
 767 <examples>
 768 <code>$("div").html();</code>
 769 <result>&lt;input/&gt;</result>
 770 <before>&lt;div&gt;&lt;input/&gt;&lt;/div&gt;</before>
 771 </examples>
 772 </method>
 773 <method short='Set the html contents of every matched element.' type='jQuery' name='html' cat='DOM/Attributes'>
 774 <params type='String' name='val'>
 775 <desc>Set the html contents to the specified value.</desc>
 776 </params>
 777 <desc>Set the html contents of every matched element.</desc>
 778 <examples>
 779 <code>$("div").html("&lt;b&gt;new stuff&lt;/b&gt;");</code>
 780 <result>&lt;div&gt;&lt;b&gt;new stuff&lt;/b&gt;&lt;/div&gt;</result>
 781 <before>&lt;div&gt;&lt;input/&gt;&lt;/div&gt;</before>
 782 </examples>
 783 </method>
 784 <method short='Get the current id of the first matched element.' type='String' name='id' cat='DOM/Attributes'>
 785 <desc>Get the current id of the first matched element.</desc>
 786 <examples>
 787 <code>$("input").id();</code>
 788 <result>"test"</result>
 789 <before>&lt;input type="text" id="test" value="some text"/&gt;</before>
 790 </examples>
 791 </method>
 792 <method short='Set the id of every matched element.' type='jQuery' name='id' cat='DOM/Attributes'>
 793 <params type='String' name='val'>
 794 <desc>Set the property to the specified value.</desc>
 795 </params>
 796 <desc>Set the id of every matched element.</desc>
 797 <examples>
 798 <code>$("input").id("newid");</code>
 799 <result>&lt;input type="text" id="newid" value="some text"/&gt;</result>
 800 <before>&lt;input type="text" id="test" value="some text"/&gt;</before>
 801 </examples>
 802 </method>
 803 <method short='Get the current title of the first matched element.' type='String' name='title' cat='DOM/Attributes'>
 804 <desc>Get the current title of the first matched element.</desc>
 805 <examples>
 806 <code>$("img").title();</code>
 807 <result>"my image"</result>
 808 <before>&lt;img src="test.jpg" title="my image"/&gt;</before>
 809 </examples>
 810 </method>
 811 <method short='Set the title of every matched element.' type='jQuery' name='title' cat='DOM/Attributes'>
 812 <params type='String' name='val'>
 813 <desc>Set the property to the specified value.</desc>
 814 </params>
 815 <desc>Set the title of every matched element.</desc>
 816 <examples>
 817 <code>$("img").title("new title");</code>
 818 <result>&lt;img src="test.jpg" title="new image"/&gt;</result>
 819 <before>&lt;img src="test.jpg" title="my image"/&gt;</before>
 820 </examples>
 821 </method>
 822 <method short='Get the current name of the first matched element.' type='String' name='name' cat='DOM/Attributes'>
 823 <desc>Get the current name of the first matched element.</desc>
 824 <examples>
 825 <code>$("input").name();</code>
 826 <result>"username"</result>
 827 <before>&lt;input type="text" name="username"/&gt;</before>
 828 </examples>
 829 </method>
 830 <method short='Set the name of every matched element.' type='jQuery' name='name' cat='DOM/Attributes'>
 831 <params type='String' name='val'>
 832 <desc>Set the property to the specified value.</desc>
 833 </params>
 834 <desc>Set the name of every matched element.</desc>
 835 <examples>
 836 <code>$("input").name("user");</code>
 837 <result>&lt;input type="text" name="user"/&gt;</result>
 838 <before>&lt;input type="text" name="username"/&gt;</before>
 839 </examples>
 840 </method>
 841 <method short='Get the current href of the first matched element.' type='String' name='href' cat='DOM/Attributes'>
 842 <desc>Get the current href of the first matched element.</desc>
 843 <examples>
 844 <code>$("a").href();</code>
 845 <result>"test.html"</result>
 846 <before>&lt;a href="test.html"&gt;my link&lt;/a&gt;</before>
 847 </examples>
 848 </method>
 849 <method short='Set the href of every matched element.' type='jQuery' name='href' cat='DOM/Attributes'>
 850 <params type='String' name='val'>
 851 <desc>Set the property to the specified value.</desc>
 852 </params>
 853 <desc>Set the href of every matched element.</desc>
 854 <examples>
 855 <code>$("a").href("test2.html");</code>
 856 <result>&lt;a href="test2.html"&gt;my link&lt;/a&gt;</result>
 857 <before>&lt;a href="test.html"&gt;my link&lt;/a&gt;</before>
 858 </examples>
 859 </method>
 860 <method short='Get the current src of the first matched element.' type='String' name='src' cat='DOM/Attributes'>
 861 <desc>Get the current src of the first matched element.</desc>
 862 <examples>
 863 <code>$("img").src();</code>
 864 <result>"test.jpg"</result>
 865 <before>&lt;img src="test.jpg" title="my image"/&gt;</before>
 866 </examples>
 867 </method>
 868 <method short='Set the src of every matched element.' type='jQuery' name='src' cat='DOM/Attributes'>
 869 <params type='String' name='val'>
 870 <desc>Set the property to the specified value.</desc>
 871 </params>
 872 <desc>Set the src of every matched element.</desc>
 873 <examples>
 874 <code>$("img").src("test2.jpg");</code>
 875 <result>&lt;img src="test2.jpg" title="my image"/&gt;</result>
 876 <before>&lt;img src="test.jpg" title="my image"/&gt;</before>
 877 </examples>
 878 </method>
 879 <method short='Get the current rel of the first matched element.' type='String' name='rel' cat='DOM/Attributes'>
 880 <desc>Get the current rel of the first matched element.</desc>
 881 <examples>
 882 <code>$("a").rel();</code>
 883 <result>"nofollow"</result>
 884 <before>&lt;a href="test.html" rel="nofollow"&gt;my link&lt;/a&gt;</before>
 885 </examples>
 886 </method>
 887 <method short='Set the rel of every matched element.' type='jQuery' name='rel' cat='DOM/Attributes'>
 888 <params type='String' name='val'>
 889 <desc>Set the property to the specified value.</desc>
 890 </params>
 891 <desc>Set the rel of every matched element.</desc>
 892 <examples>
 893 <code>$("a").rel("nofollow");</code>
 894 <result>&lt;a href="test.html" rel="nofollow"&gt;my link&lt;/a&gt;</result>
 895 <before>&lt;a href="test.html"&gt;my link&lt;/a&gt;</before>
 896 </examples>
 897 </method>
 898 <method short='Get a set of elements containing the unique parents of the matched
 899 set of elements.' type='jQuery' name='parent' cat='DOM/Traversing'>
 900 <desc>Get a set of elements containing the unique parents of the matched
 901 set of elements.</desc>
 902 <examples>
 903 <code>$("p").parent()</code>
 904 <result>[ &lt;div&gt;&lt;p&gt;Hello&lt;/p&gt;&lt;p&gt;Hello&lt;/p&gt;&lt;/div&gt; ]</result>
 905 <before>&lt;div&gt;&lt;p&gt;Hello&lt;/p&gt;&lt;p&gt;Hello&lt;/p&gt;&lt;/div&gt;</before>
 906 </examples>
 907 </method>
 908 <method short='Get a set of elements containing the unique parents of the matched
 909 set of elements, and filtered by an expression.' type='jQuery' name='parent' cat='DOM/Traversing'>
 910 <params type='String' name='expr'>
 911 <desc>An expression to filter the parents with</desc>
 912 </params>
 913 <desc>Get a set of elements containing the unique parents of the matched
 914 set of elements, and filtered by an expression.</desc>
 915 <examples>
 916 <code>$("p").parent(".selected")</code>
 917 <result>[ &lt;div class="selected"&gt;&lt;p&gt;Hello Again&lt;/p&gt;&lt;/div&gt; ]</result>
 918 <before>&lt;div&gt;&lt;p&gt;Hello&lt;/p&gt;&lt;/div&gt;&lt;div class="selected"&gt;&lt;p&gt;Hello Again&lt;/p&gt;&lt;/div&gt;</before>
 919 </examples>
 920 </method>
 921 <method short='Get a set of elements containing the unique ancestors of the matched
 922 set of elements.' type='jQuery' name='ancestors' cat='DOM/Traversing'>
 923 <desc>Get a set of elements containing the unique ancestors of the matched
 924 set of elements.</desc>
 925 <examples>
 926 <code>$("span").ancestors()</code>
 927 <result>[ &lt;body&gt;...&lt;/body&gt;, &lt;div&gt;...&lt;/div&gt;, &lt;p&gt;&lt;span&gt;Hello&lt;/span&gt;&lt;/p&gt; ]</result>
 928 <before>&lt;html&gt;&lt;body&gt;&lt;div&gt;&lt;p&gt;&lt;span&gt;Hello&lt;/span&gt;&lt;/p&gt;&lt;span&gt;Hello Again&lt;/span&gt;&lt;/div&gt;&lt;/body&gt;&lt;/html&gt;</before>
 929 </examples>
 930 </method>
 931 <method short='Get a set of elements containing the unique ancestors of the matched
 932 set of elements, and filtered by an expression.' type='jQuery' name='ancestors' cat='DOM/Traversing'>
 933 <params type='String' name='expr'>
 934 <desc>An expression to filter the ancestors with</desc>
 935 </params>
 936 <desc>Get a set of elements containing the unique ancestors of the matched
 937 set of elements, and filtered by an expression.</desc>
 938 <examples>
 939 <code>$("span").ancestors("p")</code>
 940 <result>[ &lt;p&gt;&lt;span&gt;Hello&lt;/span&gt;&lt;/p&gt; ]</result>
 941 <before>&lt;html&gt;&lt;body&gt;&lt;div&gt;&lt;p&gt;&lt;span&gt;Hello&lt;/span&gt;&lt;/p&gt;&lt;span&gt;Hello Again&lt;/span&gt;&lt;/div&gt;&lt;/body&gt;&lt;/html&gt;</before>
 942 </examples>
 943 </method>
 944 <method short='Get a set of elements containing the unique ancestors of the matched
 945 set of elements.' type='jQuery' name='parents' cat='DOM/Traversing'>
 946 <desc>Get a set of elements containing the unique ancestors of the matched
 947 set of elements.</desc>
 948 <examples>
 949 <code>$("span").ancestors()</code>
 950 <result>[ &lt;body&gt;...&lt;/body&gt;, &lt;div&gt;...&lt;/div&gt;, &lt;p&gt;&lt;span&gt;Hello&lt;/span&gt;&lt;/p&gt; ]</result>
 951 <before>&lt;html&gt;&lt;body&gt;&lt;div&gt;&lt;p&gt;&lt;span&gt;Hello&lt;/span&gt;&lt;/p&gt;&lt;span&gt;Hello Again&lt;/span&gt;&lt;/div&gt;&lt;/body&gt;&lt;/html&gt;</before>
 952 </examples>
 953 </method>
 954 <method short='Get a set of elements containing the unique ancestors of the matched
 955 set of elements, and filtered by an expression.' type='jQuery' name='parents' cat='DOM/Traversing'>
 956 <params type='String' name='expr'>
 957 <desc>An expression to filter the ancestors with</desc>
 958 </params>
 959 <desc>Get a set of elements containing the unique ancestors of the matched
 960 set of elements, and filtered by an expression.</desc>
 961 <examples>
 962 <code>$("span").ancestors("p")</code>
 963 <result>[ &lt;p&gt;&lt;span&gt;Hello&lt;/span&gt;&lt;/p&gt; ]</result>
 964 <before>&lt;html&gt;&lt;body&gt;&lt;div&gt;&lt;p&gt;&lt;span&gt;Hello&lt;/span&gt;&lt;/p&gt;&lt;span&gt;Hello Again&lt;/span&gt;&lt;/div&gt;&lt;/body&gt;&lt;/html&gt;</before>
 965 </examples>
 966 </method>
 967 <method short='Get a set of elements containing the unique next siblings of each of the
 968 matched set of elements.' type='jQuery' name='next' cat='DOM/Traversing'>
 969 <desc>Get a set of elements containing the unique next siblings of each of the
 970 matched set of elements.
 971
 972 It only returns the very next sibling, not all next siblings.</desc>
 973 <examples>
 974 <code>$("p").next()</code>
 975 <result>[ &lt;p&gt;Hello Again&lt;/p&gt;, &lt;div&gt;&lt;span&gt;And Again&lt;/span&gt;&lt;/div&gt; ]</result>
 976 <before>&lt;p&gt;Hello&lt;/p&gt;&lt;p&gt;Hello Again&lt;/p&gt;&lt;div&gt;&lt;span&gt;And Again&lt;/span&gt;&lt;/div&gt;</before>
 977 </examples>
 978 </method>
 979 <method short='Get a set of elements containing the unique next siblings of each of the
 980 matched set of elements, and filtered by an expression.' type='jQuery' name='next' cat='DOM/Traversing'>
 981 <params type='String' name='expr'>
 982 <desc>An expression to filter the next Elements with</desc>
 983 </params>
 984 <desc>Get a set of elements containing the unique next siblings of each of the
 985 matched set of elements, and filtered by an expression.
 986
 987 It only returns the very next sibling, not all next siblings.</desc>
 988 <examples>
 989 <code>$("p").next(".selected")</code>
 990 <result>[ &lt;p class="selected"&gt;Hello Again&lt;/p&gt; ]</result>
 991 <before>&lt;p&gt;Hello&lt;/p&gt;&lt;p class="selected"&gt;Hello Again&lt;/p&gt;&lt;div&gt;&lt;span&gt;And Again&lt;/span&gt;&lt;/div&gt;</before>
 992 </examples>
 993 </method>
 994 <method short='Get a set of elements containing the unique previous siblings of each of the
 995 matched set of elements.' type='jQuery' name='prev' cat='DOM/Traversing'>
 996 <desc>Get a set of elements containing the unique previous siblings of each of the
 997 matched set of elements.
 998
 999 It only returns the immediately previous sibling, not all previous siblings.</desc>
1000 <examples>
1001 <code>$("p").previous()</code>
1002 <result>[ &lt;div&gt;&lt;span&gt;Hello Again&lt;/span&gt;&lt;/div&gt; ]</result>
1003 <before>&lt;p&gt;Hello&lt;/p&gt;&lt;div&gt;&lt;span&gt;Hello Again&lt;/span&gt;&lt;/div&gt;&lt;p&gt;And Again&lt;/p&gt;</before>
1004 </examples>
1005 </method>
1006 <method short='Get a set of elements containing the unique previous siblings of each of the
1007 matched set of elements, and filtered by an expression.' type='jQuery' name='prev' cat='DOM/Traversing'>
1008 <params type='String' name='expr'>
1009 <desc>An expression to filter the previous Elements with</desc>
1010 </params>
1011 <desc>Get a set of elements containing the unique previous siblings of each of the
1012 matched set of elements, and filtered by an expression.
1013
1014 It only returns the immediately previous sibling, not all previous siblings.</desc>
1015 <examples>
1016 <code>$("p").previous(".selected")</code>
1017 <result>[ &lt;div&gt;&lt;span&gt;Hello&lt;/span&gt;&lt;/div&gt; ]</result>
1018 <before>&lt;div&gt;&lt;span&gt;Hello&lt;/span&gt;&lt;/div&gt;&lt;p class="selected"&gt;Hello Again&lt;/p&gt;&lt;p&gt;And Again&lt;/p&gt;</before>
1019 </examples>
1020 </method>
1021 <method short='Get a set of elements containing all of the unique siblings of each of the
1022 matched set of elements.' type='jQuery' name='siblings' cat='DOM/Traversing'>
1023 <desc>Get a set of elements containing all of the unique siblings of each of the
1024 matched set of elements.</desc>
1025 <examples>
1026 <code>$("div").siblings()</code>
1027 <result>[ &lt;p&gt;Hello&lt;/p&gt;, &lt;p&gt;And Again&lt;/p&gt; ]</result>
1028 <before>&lt;p&gt;Hello&lt;/p&gt;&lt;div&gt;&lt;span&gt;Hello Again&lt;/span&gt;&lt;/div&gt;&lt;p&gt;And Again&lt;/p&gt;</before>
1029 </examples>
1030 </method>
1031 <method short='Get a set of elements containing all of the unique siblings of each of the
1032 matched set of elements, and filtered by an expression.' type='jQuery' name='siblings' cat='DOM/Traversing'>
1033 <params type='String' name='expr'>
1034 <desc>An expression to filter the sibling Elements with</desc>
1035 </params>
1036 <desc>Get a set of elements containing all of the unique siblings of each of the
1037 matched set of elements, and filtered by an expression.</desc>
1038 <examples>
1039 <code>$("div").siblings(".selected")</code>
1040 <result>[ &lt;p class="selected"&gt;Hello Again&lt;/p&gt; ]</result>
1041 <before>&lt;div&gt;&lt;span&gt;Hello&lt;/span&gt;&lt;/div&gt;&lt;p class="selected"&gt;Hello Again&lt;/p&gt;&lt;p&gt;And Again&lt;/p&gt;</before>
1042 </examples>
1043 </method>
1044 <method short='Get a set of elements containing all of the unique children of each of the
1045 matched set of elements.' type='jQuery' name='children' cat='DOM/Traversing'>
1046 <desc>Get a set of elements containing all of the unique children of each of the
1047 matched set of elements.</desc>
1048 <examples>
1049 <code>$("div").children()</code>
1050 <result>[ &lt;span&gt;Hello Again&lt;/span&gt; ]</result>
1051 <before>&lt;p&gt;Hello&lt;/p&gt;&lt;div&gt;&lt;span&gt;Hello Again&lt;/span&gt;&lt;/div&gt;&lt;p&gt;And Again&lt;/p&gt;</before>
1052 </examples>
1053 </method>
1054 <method short='Get a set of elements containing all of the unique children of each of the
1055 matched set of elements, and filtered by an expression.' type='jQuery' name='children' cat='DOM/Traversing'>
1056 <params type='String' name='expr'>
1057 <desc>An expression to filter the child Elements with</desc>
1058 </params>
1059 <desc>Get a set of elements containing all of the unique children of each of the
1060 matched set of elements, and filtered by an expression.</desc>
1061 <examples>
1062 <code>$("div").children(".selected")</code>
1063 <result>[ &lt;p class="selected"&gt;Hello Again&lt;/p&gt; ]</result>
1064 <before>&lt;div&gt;&lt;span&gt;Hello&lt;/span&gt;&lt;p class="selected"&gt;Hello Again&lt;/p&gt;&lt;p&gt;And Again&lt;/p&gt;&lt;/div&gt;</before>
1065 </examples>
1066 </method>
1067 <method short='Displays each of the set of matched elements if they are hidden.' type='jQuery' name='show' cat='Effects'>
1068 <desc>Displays each of the set of matched elements if they are hidden.</desc>
1069 <examples>
1070 <code>$("p").show()</code>
1071 <result>[ &lt;p style="display: block"&gt;Hello&lt;/p&gt; ]</result>
1072 <before>&lt;p style="display: none"&gt;Hello&lt;/p&gt;</before>
1073 </examples>
1074 </method>
1075 <method short='Hides each of the set of matched elements if they are shown.' type='jQuery' name='hide' cat='Effects'>
1076 <desc>Hides each of the set of matched elements if they are shown.</desc>
1077 <examples>
1078 <code>$("p").hide()</code>
1079 <result>[ &lt;p style="display: none"&gt;Hello&lt;/p&gt; ]</result>
1080 <before>&lt;p&gt;Hello&lt;/p&gt;</before>
1081 </examples>
1082 </method>
1083 <method short='Toggles each of the set of matched elements.' type='jQuery' name='toggle' cat='Effects'>
1084 <desc>Toggles each of the set of matched elements. If they are shown,
1085 toggle makes them hidden. If they are hidden, toggle
1086 makes them shown.</desc>
1087 <examples>
1088 <code>$("p").toggle()</code>
1089 <result>[ &lt;p style="display: none"&gt;Hello&lt;/p&gt;, &lt;p style="display: block"&gt;Hello Again&lt;/p&gt; ]</result>
1090 <before>&lt;p&gt;Hello&lt;/p&gt;&lt;p style="display: none"&gt;Hello Again&lt;/p&gt;</before>
1091 </examples>
1092 </method>
1093 <method short='Adds the specified class to each of the set of matched elements.' type='jQuery' name='addClass' cat='DOM'>
1094 <params type='String' name='class'>
1095 <desc>A CSS class to add to the elements</desc>
1096 </params>
1097 <desc>Adds the specified class to each of the set of matched elements.</desc>
1098 <examples>
1099 <code>$("p").addClass("selected")</code>
1100 <result>[ &lt;p class="selected"&gt;Hello&lt;/p&gt; ]</result>
1101 <before>&lt;p&gt;Hello&lt;/p&gt;</before>
1102 </examples>
1103 </method>
1104 <method short='Removes the specified class from the set of matched elements.' type='jQuery' name='removeClass' cat='DOM'>
1105 <params type='String' name='class'>
1106 <desc>A CSS class to remove from the elements</desc>
1107 </params>
1108 <desc>Removes the specified class from the set of matched elements.</desc>
1109 <examples>
1110 <code>$("p").removeClass("selected")</code>
1111 <result>[ &lt;p&gt;Hello&lt;/p&gt; ]</result>
1112 <before>&lt;p class="selected"&gt;Hello&lt;/p&gt;</before>
1113 </examples>
1114 </method>
1115 <method short='Adds the specified class if it is present, removes it if it is
1116 not present.' type='jQuery' name='toggleClass' cat='DOM'>
1117 <params type='String' name='class'>
1118 <desc>A CSS class with which to toggle the elements</desc>
1119 </params>
1120 <desc>Adds the specified class if it is present, removes it if it is
1121 not present.</desc>
1122 <examples>
1123 <code>$("p").toggleClass("selected")</code>
1124 <result>[ &lt;p class="selected"&gt;Hello&lt;/p&gt;, &lt;p&gt;Hello Again&lt;/p&gt; ]</result>
1125 <before>&lt;p&gt;Hello&lt;/p&gt;&lt;p class="selected"&gt;Hello Again&lt;/p&gt;</before>
1126 </examples>
1127 </method>
1128 <method short='Removes all matched elements from the DOM.' type='jQuery' name='remove' cat='DOM/Manipulation'>
1129 <desc>Removes all matched elements from the DOM. This does NOT remove them from the
1130 jQuery object, allowing you to use the matched elements further.</desc>
1131 <examples>
1132 <code>$("p").remove();</code>
1133 <result>how are</result>
1134 <before>&lt;p&gt;Hello&lt;/p&gt; how are &lt;p&gt;you?&lt;/p&gt;</before>
1135 </examples>
1136 </method>
1137 <method short='Removes only elements (out of the list of matched elements) that match
1138 the specified jQuery expression.' type='jQuery' name='remove' cat='DOM/Manipulation'>
1139 <params type='String' name='expr'>
1140 <desc>A jQuery expression to filter elements by.</desc>
1141 </params>
1142 <desc>Removes only elements (out of the list of matched elements) that match
1143 the specified jQuery expression. This does NOT remove them from the
1144 jQuery object, allowing you to use the matched elements further.</desc>
1145 <examples>
1146 <code>$("p").remove(".hello");</code>
1147 <result>how are &lt;p&gt;you?&lt;/p&gt;</result>
1148 <before>&lt;p class="hello"&gt;Hello&lt;/p&gt; how are &lt;p&gt;you?&lt;/p&gt;</before>
1149 </examples>
1150 </method>
1151 <method short='Removes all child nodes from the set of matched elements.' type='jQuery' name='empty' cat='DOM/Manipulation'>
1152 <desc>Removes all child nodes from the set of matched elements.</desc>
1153 <examples>
1154 <code>$("p").empty()</code>
1155 <result>[ &lt;p&gt;&lt;/p&gt; ]</result>
1156 <before>&lt;p&gt;Hello, &lt;span&gt;Person&lt;/span&gt; &lt;a href="#"&gt;and person&lt;/a&gt;&lt;/p&gt;</before>
1157 </examples>
1158 </method>
1159 <method short='Binds a particular event (like click) to a each of a set of match elements.' type='jQuery' name='bind' cat='Events'>
1160 <params type='String' name='type'>
1161 <desc>An event type</desc>
1162 </params>
1163 <params type='Function' name='fn'>
1164 <desc>A function to bind to the event on each of the set of matched elements</desc>
1165 </params>
1166 <desc>Binds a particular event (like click) to a each of a set of match elements.</desc>
1167 <examples>
1168 <code>$("p").bind( "click", function() { alert("Hello"); } )</code>
1169 <result>[ &lt;p&gt;Hello&lt;/p&gt; ]<br/><br/>Cancel a default action and prevent it from bubbling by returning false<br/>from your function.</result>
1170 <before>&lt;p&gt;Hello&lt;/p&gt;</before>
1171 </examples>
1172 <examples>
1173 <code>$("form").bind( "submit", function() { return false; } )<br/><br/>Cancel a default action by using the preventDefault method.</code>
1174 </examples>
1175 <examples>
1176 <code>$("form").bind( "submit", function() { e.preventDefault(); } )<br/><br/>Stop an event from bubbling by using the stopPropogation method.</code>
1177 </examples>
1178 <examples>
1179 <code>$("form").bind( "submit", function() { e.stopPropogation(); } )</code>
1180 </examples>
1181 </method>
1182 <method short='The opposite of bind, removes a bound event from each of the matched
1183 elements.' type='jQuery' name='unbind' cat='Events'>
1184 <params type='String' name='type'>
1185 <desc>An event type</desc>
1186 </params>
1187 <params type='Function' name='fn'>
1188 <desc>A function to unbind from the event on each of the set of matched elements</desc>
1189 </params>
1190 <desc>The opposite of bind, removes a bound event from each of the matched
1191 elements. You must pass the identical function that was used in the original
1192 bind method.</desc>
1193 <examples>
1194 <code>$("p").unbind( "click", function() { alert("Hello"); } )</code>
1195 <result>[ &lt;p&gt;Hello&lt;/p&gt; ]</result>
1196 <before>&lt;p onclick="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
1197 </examples>
1198 </method>
1199 <method short='Removes all bound events of a particular type from each of the matched
1200 elements.' type='jQuery' name='unbind' cat='Events'>
1201 <params type='String' name='type'>
1202 <desc>An event type</desc>
1203 </params>
1204 <desc>Removes all bound events of a particular type from each of the matched
1205 elements.</desc>
1206 <examples>
1207 <code>$("p").unbind( "click" )</code>
1208 <result>[ &lt;p&gt;Hello&lt;/p&gt; ]</result>
1209 <before>&lt;p onclick="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
1210 </examples>
1211 </method>
1212 <method short='Removes all bound events from each of the matched elements.' type='jQuery' name='unbind' cat='Events'>
1213 <desc>Removes all bound events from each of the matched elements.</desc>
1214 <examples>
1215 <code>$("p").unbind()</code>
1216 <result>[ &lt;p&gt;Hello&lt;/p&gt; ]</result>
1217 <before>&lt;p onclick="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
1218 </examples>
1219 </method>
1220 <method short='Trigger a type of event on every matched element.' type='jQuery' name='trigger' cat='Events'>
1221 <params type='String' name='type'>
1222 <desc>An event type to trigger.</desc>
1223 </params>
1224 <desc>Trigger a type of event on every matched element.</desc>
1225 <examples>
1226 <code>$("p").trigger("click")</code>
1227 <result>alert('hello')</result>
1228 <before>&lt;p click="alert('hello')"&gt;Hello&lt;/p&gt;</before>
1229 </examples>
1230 </method>
1231 <method short='Toggle between two function calls every other click.' type='jQuery' name='toggle' cat='Events'>
1232 <params type='Function' name='even'>
1233 <desc>The function to execute on every even click.</desc>
1234 </params>
1235 <params type='Function' name='odd'>
1236 <desc>The function to execute on every odd click.</desc>
1237 </params>
1238 <desc>Toggle between two function calls every other click.
1239 Whenever a matched element is clicked, the first specified function
1240 is fired, when clicked again, the second is fired. All subsequent
1241 clicks continue to rotate through the two functions.</desc>
1242 <examples>
1243 <code>$("p").toggle(function(){<br/>  $(this).addClass("selected");<br/>},function(){<br/>  $(this).removeClass("selected");<br/>});</code>
1244 </examples>
1245 </method>
1246 <method short='A method for simulating hovering (moving the mouse on, and off,
1247 an object).' type='jQuery' name='hover' cat='Events'>
1248 <params type='Function' name='over'>
1249 <desc>The function to fire whenever the mouse is moved over a matched element.</desc>
1250 </params>
1251 <params type='Function' name='out'>
1252 <desc>The function to fire whenever the mouse is moved off of a matched element.</desc>
1253 </params>
1254 <desc>A method for simulating hovering (moving the mouse on, and off,
1255 an object). This is a custom method which provides an 'in' to a
1256 frequent task.
1257
1258 Whenever the mouse cursor is moved over a matched
1259 element, the first specified function is fired. Whenever the mouse
1260 moves off of the element, the second specified function fires.
1261 Additionally, checks are in place to see if the mouse is still within
1262 the specified element itself (for example, an image inside of a div),
1263 and if it is, it will continue to 'hover', and not move out
1264 (a common error in using a mouseout event handler).</desc>
1265 <examples>
1266 <code>$("p").hover(function(){<br/>  $(this).addClass("over");<br/>},function(){<br/>  $(this).addClass("out");<br/>});</code>
1267 </examples>
1268 </method>
1269 <method short='Bind a function to be executed whenever the DOM is ready to be
1270 traversed and manipulated.' type='jQuery' name='ready' cat='Events'>
1271 <params type='Function' name='fn'>
1272 <desc>The function to be executed when the DOM is ready.</desc>
1273 </params>
1274 <desc>Bind a function to be executed whenever the DOM is ready to be
1275 traversed and manipulated. This is probably the most important
1276 function included in the event module, as it can greatly improve
1277 the response times of your web applications.
1278
1279 In a nutshell, this is a solid replacement for using window.onload,
1280 and attaching a function to that. By using this method, your bound Function
1281 will be called the instant the DOM is ready to be read and manipulated,
1282 which is exactly what 99.99% of all Javascript code needs to run.
1283
1284 Please ensure you have no code in your &lt;body&gt; onload event handler,
1285 otherwise $(document).ready() may not fire.</desc>
1286 <examples>
1287 <code>$(document).ready(function(){ Your code here... });</code>
1288 </examples>
1289 </method>
1290 <method short='Bind a function to the blur event of each matched element.' type='jQuery' name='blur' cat='Events'>
1291 <params type='Function' name='fn'>
1292 <desc>A function to bind to the blur event on each of the matched elements.</desc>
1293 </params>
1294 <desc>Bind a function to the blur event of each matched element.</desc>
1295 <examples>
1296 <code>$("p").blur( function() { alert("Hello"); } );</code>
1297 <result>&lt;p onblur="alert('Hello');"&gt;Hello&lt;/p&gt;</result>
1298 <before>&lt;p&gt;Hello&lt;/p&gt;</before>
1299 </examples>
1300 </method>
1301 <method short='Trigger the blur event of each matched element.' type='jQuery' name='blur' cat='Events'>
1302 <desc>Trigger the blur event of each matched element. This causes all of the functions
1303 that have been bound to thet blur event to be executed.</desc>
1304 <examples>
1305 <code>$("p").blur();</code>
1306 <result>alert('Hello');</result>
1307 <before>&lt;p onblur="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
1308 </examples>
1309 </method>
1310 <method short='Bind a function to the blur event of each matched element, which will only be executed once.' type='jQuery' name='oneblur' cat='Events'>
1311 <params type='Function' name='fn'>
1312 <desc>A function to bind to the blur event on each of the matched elements.</desc>
1313 </params>
1314 <desc>Bind a function to the blur event of each matched element, which will only be executed once.
1315 Unlike a call to the normal .blur() method, calling .oneblur() causes the bound function to be
1316 only executed the first time it is triggered, and never again (unless it is re-bound).</desc>
1317 <examples>
1318 <code>$("p").oneblur( function() { alert("Hello"); } );</code>
1319 <result>alert('Hello'); // Only executed for the first blur</result>
1320 <before>&lt;p onblur="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
1321 </examples>
1322 </method>
1323 <method short='Removes a bound blur event from each of the matched
1324 elements.' type='jQuery' name='unblur' cat='Events'>
1325 <params type='Function' name='fn'>
1326 <desc>A function to unbind from the blur event on each of the matched elements.</desc>
1327 </params>
1328 <desc>Removes a bound blur event from each of the matched
1329 elements. You must pass the identical function that was used in the original
1330 bind method.</desc>
1331 <examples>
1332 <code>$("p").unblur( myFunction );</code>
1333 <result>&lt;p&gt;Hello&lt;/p&gt;</result>
1334 <before>&lt;p onblur="myFunction"&gt;Hello&lt;/p&gt;</before>
1335 </examples>
1336 </method>
1337 <method short='Removes all bound blur events from each of the matched elements.' type='jQuery' name='unblur' cat='Events'>
1338 <desc>Removes all bound blur events from each of the matched elements.</desc>
1339 <examples>
1340 <code>$("p").unblur();</code>
1341 <result>&lt;p&gt;Hello&lt;/p&gt;</result>
1342 <before>&lt;p onblur="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
1343 </examples>
1344 </method>
1345 <method short='Bind a function to the focus event of each matched element.' type='jQuery' name='focus' cat='Events'>
1346 <params type='Function' name='fn'>
1347 <desc>A function to bind to the focus event on each of the matched elements.</desc>
1348 </params>
1349 <desc>Bind a function to the focus event of each matched element.</desc>
1350 <examples>
1351 <code>$("p").focus( function() { alert("Hello"); } );</code>
1352 <result>&lt;p onfocus="alert('Hello');"&gt;Hello&lt;/p&gt;</result>
1353 <before>&lt;p&gt;Hello&lt;/p&gt;</before>
1354 </examples>
1355 </method>
1356 <method short='Trigger the focus event of each matched element.' type='jQuery' name='focus' cat='Events'>
1357 <desc>Trigger the focus event of each matched element. This causes all of the functions
1358 that have been bound to thet focus event to be executed.</desc>
1359 <examples>
1360 <code>$("p").focus();</code>
1361 <result>alert('Hello');</result>
1362 <before>&lt;p onfocus="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
1363 </examples>
1364 </method>
1365 <method short='Bind a function to the focus event of each matched element, which will only be executed once.' type='jQuery' name='onefocus' cat='Events'>
1366 <params type='Function' name='fn'>
1367 <desc>A function to bind to the focus event on each of the matched elements.</desc>
1368 </params>
1369 <desc>Bind a function to the focus event of each matched element, which will only be executed once.
1370 Unlike a call to the normal .focus() method, calling .onefocus() causes the bound function to be
1371 only executed the first time it is triggered, and never again (unless it is re-bound).</desc>
1372 <examples>
1373 <code>$("p").onefocus( function() { alert("Hello"); } );</code>
1374 <result>alert('Hello'); // Only executed for the first focus</result>
1375 <before>&lt;p onfocus="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
1376 </examples>
1377 </method>
1378 <method short='Removes a bound focus event from each of the matched
1379 elements.' type='jQuery' name='unfocus' cat='Events'>
1380 <params type='Function' name='fn'>
1381 <desc>A function to unbind from the focus event on each of the matched elements.</desc>
1382 </params>
1383 <desc>Removes a bound focus event from each of the matched
1384 elements. You must pass the identical function that was used in the original
1385 bind method.</desc>
1386 <examples>
1387 <code>$("p").unfocus( myFunction );</code>
1388 <result>&lt;p&gt;Hello&lt;/p&gt;</result>
1389 <before>&lt;p onfocus="myFunction"&gt;Hello&lt;/p&gt;</before>
1390 </examples>
1391 </method>
1392 <method short='Removes all bound focus events from each of the matched elements.' type='jQuery' name='unfocus' cat='Events'>
1393 <desc>Removes all bound focus events from each of the matched elements.</desc>
1394 <examples>
1395 <code>$("p").unfocus();</code>
1396 <result>&lt;p&gt;Hello&lt;/p&gt;</result>
1397 <before>&lt;p onfocus="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
1398 </examples>
1399 </method>
1400 <method short='Bind a function to the load event of each matched element.' type='jQuery' name='load' cat='Events'>
1401 <params type='Function' name='fn'>
1402 <desc>A function to bind to the load event on each of the matched elements.</desc>
1403 </params>
1404 <desc>Bind a function to the load event of each matched element.</desc>
1405 <examples>
1406 <code>$("p").load( function() { alert("Hello"); } );</code>
1407 <result>&lt;p onload="alert('Hello');"&gt;Hello&lt;/p&gt;</result>
1408 <before>&lt;p&gt;Hello&lt;/p&gt;</before>
1409 </examples>
1410 </method>
1411 <method short='Trigger the load event of each matched element.' type='jQuery' name='load' cat='Events'>
1412 <desc>Trigger the load event of each matched element. This causes all of the functions
1413 that have been bound to thet load event to be executed.</desc>
1414 <examples>
1415 <code>$("p").load();</code>
1416 <result>alert('Hello');</result>
1417 <before>&lt;p onload="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
1418 </examples>
1419 </method>
1420 <method short='Bind a function to the load event of each matched element, which will only be executed once.' type='jQuery' name='oneload' cat='Events'>
1421 <params type='Function' name='fn'>
1422 <desc>A function to bind to the load event on each of the matched elements.</desc>
1423 </params>
1424 <desc>Bind a function to the load event of each matched element, which will only be executed once.
1425 Unlike a call to the normal .load() method, calling .oneload() causes the bound function to be
1426 only executed the first time it is triggered, and never again (unless it is re-bound).</desc>
1427 <examples>
1428 <code>$("p").oneload( function() { alert("Hello"); } );</code>
1429 <result>alert('Hello'); // Only executed for the first load</result>
1430 <before>&lt;p onload="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
1431 </examples>
1432 </method>
1433 <method short='Removes a bound load event from each of the matched
1434 elements.' type='jQuery' name='unload' cat='Events'>
1435 <params type='Function' name='fn'>
1436 <desc>A function to unbind from the load event on each of the matched elements.</desc>
1437 </params>
1438 <desc>Removes a bound load event from each of the matched
1439 elements. You must pass the identical function that was used in the original
1440 bind method.</desc>
1441 <examples>
1442 <code>$("p").unload( myFunction );</code>
1443 <result>&lt;p&gt;Hello&lt;/p&gt;</result>
1444 <before>&lt;p onload="myFunction"&gt;Hello&lt;/p&gt;</before>
1445 </examples>
1446 </method>
1447 <method short='Removes all bound load events from each of the matched elements.' type='jQuery' name='unload' cat='Events'>
1448 <desc>Removes all bound load events from each of the matched elements.</desc>
1449 <examples>
1450 <code>$("p").unload();</code>
1451 <result>&lt;p&gt;Hello&lt;/p&gt;</result>
1452 <before>&lt;p onload="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
1453 </examples>
1454 </method>
1455 <method short='Bind a function to the resize event of each matched element.' type='jQuery' name='resize' cat='Events'>
1456 <params type='Function' name='fn'>
1457 <desc>A function to bind to the resize event on each of the matched elements.</desc>
1458 </params>
1459 <desc>Bind a function to the resize event of each matched element.</desc>
1460 <examples>
1461 <code>$("p").resize( function() { alert("Hello"); } );</code>
1462 <result>&lt;p onresize="alert('Hello');"&gt;Hello&lt;/p&gt;</result>
1463 <before>&lt;p&gt;Hello&lt;/p&gt;</before>
1464 </examples>
1465 </method>
1466 <method short='Trigger the resize event of each matched element.' type='jQuery' name='resize' cat='Events'>
1467 <desc>Trigger the resize event of each matched element. This causes all of the functions
1468 that have been bound to thet resize event to be executed.</desc>
1469 <examples>
1470 <code>$("p").resize();</code>
1471 <result>alert('Hello');</result>
1472 <before>&lt;p onresize="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
1473 </examples>
1474 </method>
1475 <method short='Bind a function to the resize event of each matched element, which will only be executed once.' type='jQuery' name='oneresize' cat='Events'>
1476 <params type='Function' name='fn'>
1477 <desc>A function to bind to the resize event on each of the matched elements.</desc>
1478 </params>
1479 <desc>Bind a function to the resize event of each matched element, which will only be executed once.
1480 Unlike a call to the normal .resize() method, calling .oneresize() causes the bound function to be
1481 only executed the first time it is triggered, and never again (unless it is re-bound).</desc>
1482 <examples>
1483 <code>$("p").oneresize( function() { alert("Hello"); } );</code>
1484 <result>alert('Hello'); // Only executed for the first resize</result>
1485 <before>&lt;p onresize="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
1486 </examples>
1487 </method>
1488 <method short='Removes a bound resize event from each of the matched
1489 elements.' type='jQuery' name='unresize' cat='Events'>
1490 <params type='Function' name='fn'>
1491 <desc>A function to unbind from the resize event on each of the matched elements.</desc>
1492 </params>
1493 <desc>Removes a bound resize event from each of the matched
1494 elements. You must pass the identical function that was used in the original
1495 bind method.</desc>
1496 <examples>
1497 <code>$("p").unresize( myFunction );</code>
1498 <result>&lt;p&gt;Hello&lt;/p&gt;</result>
1499 <before>&lt;p onresize="myFunction"&gt;Hello&lt;/p&gt;</before>
1500 </examples>
1501 </method>
1502 <method short='Removes all bound resize events from each of the matched elements.' type='jQuery' name='unresize' cat='Events'>
1503 <desc>Removes all bound resize events from each of the matched elements.</desc>
1504 <examples>
1505 <code>$("p").unresize();</code>
1506 <result>&lt;p&gt;Hello&lt;/p&gt;</result>
1507 <before>&lt;p onresize="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
1508 </examples>
1509 </method>
1510 <method short='Bind a function to the scroll event of each matched element.' type='jQuery' name='scroll' cat='Events'>
1511 <params type='Function' name='fn'>
1512 <desc>A function to bind to the scroll event on each of the matched elements.</desc>
1513 </params>
1514 <desc>Bind a function to the scroll event of each matched element.</desc>
1515 <examples>
1516 <code>$("p").scroll( function() { alert("Hello"); } );</code>
1517 <result>&lt;p onscroll="alert('Hello');"&gt;Hello&lt;/p&gt;</result>
1518 <before>&lt;p&gt;Hello&lt;/p&gt;</before>
1519 </examples>
1520 </method>
1521 <method short='Trigger the scroll event of each matched element.' type='jQuery' name='scroll' cat='Events'>
1522 <desc>Trigger the scroll event of each matched element. This causes all of the functions
1523 that have been bound to thet scroll event to be executed.</desc>
1524 <examples>
1525 <code>$("p").scroll();</code>
1526 <result>alert('Hello');</result>
1527 <before>&lt;p onscroll="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
1528 </examples>
1529 </method>
1530 <method short='Bind a function to the scroll event of each matched element, which will only be executed once.' type='jQuery' name='onescroll' cat='Events'>
1531 <params type='Function' name='fn'>
1532 <desc>A function to bind to the scroll event on each of the matched elements.</desc>
1533 </params>
1534 <desc>Bind a function to the scroll event of each matched element, which will only be executed once.
1535 Unlike a call to the normal .scroll() method, calling .onescroll() causes the bound function to be
1536 only executed the first time it is triggered, and never again (unless it is re-bound).</desc>
1537 <examples>
1538 <code>$("p").onescroll( function() { alert("Hello"); } );</code>
1539 <result>alert('Hello'); // Only executed for the first scroll</result>
1540 <before>&lt;p onscroll="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
1541 </examples>
1542 </method>
1543 <method short='Removes a bound scroll event from each of the matched
1544 elements.' type='jQuery' name='unscroll' cat='Events'>
1545 <params type='Function' name='fn'>
1546 <desc>A function to unbind from the scroll event on each of the matched elements.</desc>
1547 </params>
1548 <desc>Removes a bound scroll event from each of the matched
1549 elements. You must pass the identical function that was used in the original
1550 bind method.</desc>
1551 <examples>
1552 <code>$("p").unscroll( myFunction );</code>
1553 <result>&lt;p&gt;Hello&lt;/p&gt;</result>
1554 <before>&lt;p onscroll="myFunction"&gt;Hello&lt;/p&gt;</before>
1555 </examples>
1556 </method>
1557 <method short='Removes all bound scroll events from each of the matched elements.' type='jQuery' name='unscroll' cat='Events'>
1558 <desc>Removes all bound scroll events from each of the matched elements.</desc>
1559 <examples>
1560 <code>$("p").unscroll();</code>
1561 <result>&lt;p&gt;Hello&lt;/p&gt;</result>
1562 <before>&lt;p onscroll="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
1563 </examples>
1564 </method>
1565 <method short='Bind a function to the unload event of each matched element.' type='jQuery' name='unload' cat='Events'>
1566 <params type='Function' name='fn'>
1567 <desc>A function to bind to the unload event on each of the matched elements.</desc>
1568 </params>
1569 <desc>Bind a function to the unload event of each matched element.</desc>
1570 <examples>
1571 <code>$("p").unload( function() { alert("Hello"); } );</code>
1572 <result>&lt;p onunload="alert('Hello');"&gt;Hello&lt;/p&gt;</result>
1573 <before>&lt;p&gt;Hello&lt;/p&gt;</before>
1574 </examples>
1575 </method>
1576 <method short='Trigger the unload event of each matched element.' type='jQuery' name='unload' cat='Events'>
1577 <desc>Trigger the unload event of each matched element. This causes all of the functions
1578 that have been bound to thet unload event to be executed.</desc>
1579 <examples>
1580 <code>$("p").unload();</code>
1581 <result>alert('Hello');</result>
1582 <before>&lt;p onunload="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
1583 </examples>
1584 </method>
1585 <method short='Bind a function to the unload event of each matched element, which will only be executed once.' type='jQuery' name='oneunload' cat='Events'>
1586 <params type='Function' name='fn'>
1587 <desc>A function to bind to the unload event on each of the matched elements.</desc>
1588 </params>
1589 <desc>Bind a function to the unload event of each matched element, which will only be executed once.
1590 Unlike a call to the normal .unload() method, calling .oneunload() causes the bound function to be
1591 only executed the first time it is triggered, and never again (unless it is re-bound).</desc>
1592 <examples>
1593 <code>$("p").oneunload( function() { alert("Hello"); } );</code>
1594 <result>alert('Hello'); // Only executed for the first unload</result>
1595 <before>&lt;p onunload="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
1596 </examples>
1597 </method>
1598 <method short='Removes a bound unload event from each of the matched
1599 elements.' type='jQuery' name='ununload' cat='Events'>
1600 <params type='Function' name='fn'>
1601 <desc>A function to unbind from the unload event on each of the matched elements.</desc>
1602 </params>
1603 <desc>Removes a bound unload event from each of the matched
1604 elements. You must pass the identical function that was used in the original
1605 bind method.</desc>
1606 <examples>
1607 <code>$("p").ununload( myFunction );</code>
1608 <result>&lt;p&gt;Hello&lt;/p&gt;</result>
1609 <before>&lt;p onunload="myFunction"&gt;Hello&lt;/p&gt;</before>
1610 </examples>
1611 </method>
1612 <method short='Removes all bound unload events from each of the matched elements.' type='jQuery' name='ununload' cat='Events'>
1613 <desc>Removes all bound unload events from each of the matched elements.</desc>
1614 <examples>
1615 <code>$("p").ununload();</code>
1616 <result>&lt;p&gt;Hello&lt;/p&gt;</result>
1617 <before>&lt;p onunload="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
1618 </examples>
1619 </method>
1620 <method short='Bind a function to the click event of each matched element.' type='jQuery' name='click' cat='Events'>
1621 <params type='Function' name='fn'>
1622 <desc>A function to bind to the click event on each of the matched elements.</desc>
1623 </params>
1624 <desc>Bind a function to the click event of each matched element.</desc>
1625 <examples>
1626 <code>$("p").click( function() { alert("Hello"); } );</code>
1627 <result>&lt;p onclick="alert('Hello');"&gt;Hello&lt;/p&gt;</result>
1628 <before>&lt;p&gt;Hello&lt;/p&gt;</before>
1629 </examples>
1630 </method>
1631 <method short='Trigger the click event of each matched element.' type='jQuery' name='click' cat='Events'>
1632 <desc>Trigger the click event of each matched element. This causes all of the functions
1633 that have been bound to thet click event to be executed.</desc>
1634 <examples>
1635 <code>$("p").click();</code>
1636 <result>alert('Hello');</result>
1637 <before>&lt;p onclick="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
1638 </examples>
1639 </method>
1640 <method short='Bind a function to the click event of each matched element, which will only be executed once.' type='jQuery' name='oneclick' cat='Events'>
1641 <params type='Function' name='fn'>
1642 <desc>A function to bind to the click event on each of the matched elements.</desc>
1643 </params>
1644 <desc>Bind a function to the click event of each matched element, which will only be executed once.
1645 Unlike a call to the normal .click() method, calling .oneclick() causes the bound function to be
1646 only executed the first time it is triggered, and never again (unless it is re-bound).</desc>
1647 <examples>
1648 <code>$("p").oneclick( function() { alert("Hello"); } );</code>
1649 <result>alert('Hello'); // Only executed for the first click</result>
1650 <before>&lt;p onclick="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
1651 </examples>
1652 </method>
1653 <method short='Removes a bound click event from each of the matched
1654 elements.' type='jQuery' name='unclick' cat='Events'>
1655 <params type='Function' name='fn'>
1656 <desc>A function to unbind from the click event on each of the matched elements.</desc>
1657 </params>
1658 <desc>Removes a bound click event from each of the matched
1659 elements. You must pass the identical function that was used in the original
1660 bind method.</desc>
1661 <examples>
1662 <code>$("p").unclick( myFunction );</code>
1663 <result>&lt;p&gt;Hello&lt;/p&gt;</result>
1664 <before>&lt;p onclick="myFunction"&gt;Hello&lt;/p&gt;</before>
1665 </examples>
1666 </method>
1667 <method short='Removes all bound click events from each of the matched elements.' type='jQuery' name='unclick' cat='Events'>
1668 <desc>Removes all bound click events from each of the matched elements.</desc>
1669 <examples>
1670 <code>$("p").unclick();</code>
1671 <result>&lt;p&gt;Hello&lt;/p&gt;</result>
1672 <before>&lt;p onclick="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
1673 </examples>
1674 </method>
1675 <method short='Bind a function to the dblclick event of each matched element.' type='jQuery' name='dblclick' cat='Events'>
1676 <params type='Function' name='fn'>
1677 <desc>A function to bind to the dblclick event on each of the matched elements.</desc>
1678 </params>
1679 <desc>Bind a function to the dblclick event of each matched element.</desc>
1680 <examples>
1681 <code>$("p").dblclick( function() { alert("Hello"); } );</code>
1682 <result>&lt;p ondblclick="alert('Hello');"&gt;Hello&lt;/p&gt;</result>
1683 <before>&lt;p&gt;Hello&lt;/p&gt;</before>
1684 </examples>
1685 </method>
1686 <method short='Trigger the dblclick event of each matched element.' type='jQuery' name='dblclick' cat='Events'>
1687 <desc>Trigger the dblclick event of each matched element. This causes all of the functions
1688 that have been bound to thet dblclick event to be executed.</desc>
1689 <examples>
1690 <code>$("p").dblclick();</code>
1691 <result>alert('Hello');</result>
1692 <before>&lt;p ondblclick="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
1693 </examples>
1694 </method>
1695 <method short='Bind a function to the dblclick event of each matched element, which will only be executed once.' type='jQuery' name='onedblclick' cat='Events'>
1696 <params type='Function' name='fn'>
1697 <desc>A function to bind to the dblclick event on each of the matched elements.</desc>
1698 </params>
1699 <desc>Bind a function to the dblclick event of each matched element, which will only be executed once.
1700 Unlike a call to the normal .dblclick() method, calling .onedblclick() causes the bound function to be
1701 only executed the first time it is triggered, and never again (unless it is re-bound).</desc>
1702 <examples>
1703 <code>$("p").onedblclick( function() { alert("Hello"); } );</code>
1704 <result>alert('Hello'); // Only executed for the first dblclick</result>
1705 <before>&lt;p ondblclick="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
1706 </examples>
1707 </method>
1708 <method short='Removes a bound dblclick event from each of the matched
1709 elements.' type='jQuery' name='undblclick' cat='Events'>
1710 <params type='Function' name='fn'>
1711 <desc>A function to unbind from the dblclick event on each of the matched elements.</desc>
1712 </params>
1713 <desc>Removes a bound dblclick event from each of the matched
1714 elements. You must pass the identical function that was used in the original
1715 bind method.</desc>
1716 <examples>
1717 <code>$("p").undblclick( myFunction );</code>
1718 <result>&lt;p&gt;Hello&lt;/p&gt;</result>
1719 <before>&lt;p ondblclick="myFunction"&gt;Hello&lt;/p&gt;</before>
1720 </examples>
1721 </method>
1722 <method short='Removes all bound dblclick events from each of the matched elements.' type='jQuery' name='undblclick' cat='Events'>
1723 <desc>Removes all bound dblclick events from each of the matched elements.</desc>
1724 <examples>
1725 <code>$("p").undblclick();</code>
1726 <result>&lt;p&gt;Hello&lt;/p&gt;</result>
1727 <before>&lt;p ondblclick="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
1728 </examples>
1729 </method>
1730 <method short='Bind a function to the mousedown event of each matched element.' type='jQuery' name='mousedown' cat='Events'>
1731 <params type='Function' name='fn'>
1732 <desc>A function to bind to the mousedown event on each of the matched elements.</desc>
1733 </params>
1734 <desc>Bind a function to the mousedown event of each matched element.</desc>
1735 <examples>
1736 <code>$("p").mousedown( function() { alert("Hello"); } );</code>
1737 <result>&lt;p onmousedown="alert('Hello');"&gt;Hello&lt;/p&gt;</result>
1738 <before>&lt;p&gt;Hello&lt;/p&gt;</before>
1739 </examples>
1740 </method>
1741 <method short='Trigger the mousedown event of each matched element.' type='jQuery' name='mousedown' cat='Events'>
1742 <desc>Trigger the mousedown event of each matched element. This causes all of the functions
1743 that have been bound to thet mousedown event to be executed.</desc>
1744 <examples>
1745 <code>$("p").mousedown();</code>
1746 <result>alert('Hello');</result>
1747 <before>&lt;p onmousedown="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
1748 </examples>
1749 </method>
1750 <method short='Bind a function to the mousedown event of each matched element, which will only be executed once.' type='jQuery' name='onemousedown' cat='Events'>
1751 <params type='Function' name='fn'>
1752 <desc>A function to bind to the mousedown event on each of the matched elements.</desc>
1753 </params>
1754 <desc>Bind a function to the mousedown event of each matched element, which will only be executed once.
1755 Unlike a call to the normal .mousedown() method, calling .onemousedown() causes the bound function to be
1756 only executed the first time it is triggered, and never again (unless it is re-bound).</desc>
1757 <examples>
1758 <code>$("p").onemousedown( function() { alert("Hello"); } );</code>
1759 <result>alert('Hello'); // Only executed for the first mousedown</result>
1760 <before>&lt;p onmousedown="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
1761 </examples>
1762 </method>
1763 <method short='Removes a bound mousedown event from each of the matched
1764 elements.' type='jQuery' name='unmousedown' cat='Events'>
1765 <params type='Function' name='fn'>
1766 <desc>A function to unbind from the mousedown event on each of the matched elements.</desc>
1767 </params>
1768 <desc>Removes a bound mousedown event from each of the matched
1769 elements. You must pass the identical function that was used in the original
1770 bind method.</desc>
1771 <examples>
1772 <code>$("p").unmousedown( myFunction );</code>
1773 <result>&lt;p&gt;Hello&lt;/p&gt;</result>
1774 <before>&lt;p onmousedown="myFunction"&gt;Hello&lt;/p&gt;</before>
1775 </examples>
1776 </method>
1777 <method short='Removes all bound mousedown events from each of the matched elements.' type='jQuery' name='unmousedown' cat='Events'>
1778 <desc>Removes all bound mousedown events from each of the matched elements.</desc>
1779 <examples>
1780 <code>$("p").unmousedown();</code>
1781 <result>&lt;p&gt;Hello&lt;/p&gt;</result>
1782 <before>&lt;p onmousedown="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
1783 </examples>
1784 </method>
1785 <method short='Bind a function to the mouseup event of each matched element.' type='jQuery' name='mouseup' cat='Events'>
1786 <params type='Function' name='fn'>
1787 <desc>A function to bind to the mouseup event on each of the matched elements.</desc>
1788 </params>
1789 <desc>Bind a function to the mouseup event of each matched element.</desc>
1790 <examples>
1791 <code>$("p").mouseup( function() { alert("Hello"); } );</code>
1792 <result>&lt;p onmouseup="alert('Hello');"&gt;Hello&lt;/p&gt;</result>
1793 <before>&lt;p&gt;Hello&lt;/p&gt;</before>
1794 </examples>
1795 </method>
1796 <method short='Trigger the mouseup event of each matched element.' type='jQuery' name='mouseup' cat='Events'>
1797 <desc>Trigger the mouseup event of each matched element. This causes all of the functions
1798 that have been bound to thet mouseup event to be executed.</desc>
1799 <examples>
1800 <code>$("p").mouseup();</code>
1801 <result>alert('Hello');</result>
1802 <before>&lt;p onmouseup="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
1803 </examples>
1804 </method>
1805 <method short='Bind a function to the mouseup event of each matched element, which will only be executed once.' type='jQuery' name='onemouseup' cat='Events'>
1806 <params type='Function' name='fn'>
1807 <desc>A function to bind to the mouseup event on each of the matched elements.</desc>
1808 </params>
1809 <desc>Bind a function to the mouseup event of each matched element, which will only be executed once.
1810 Unlike a call to the normal .mouseup() method, calling .onemouseup() causes the bound function to be
1811 only executed the first time it is triggered, and never again (unless it is re-bound).</desc>
1812 <examples>
1813 <code>$("p").onemouseup( function() { alert("Hello"); } );</code>
1814 <result>alert('Hello'); // Only executed for the first mouseup</result>
1815 <before>&lt;p onmouseup="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
1816 </examples>
1817 </method>
1818 <method short='Removes a bound mouseup event from each of the matched
1819 elements.' type='jQuery' name='unmouseup' cat='Events'>
1820 <params type='Function' name='fn'>
1821 <desc>A function to unbind from the mouseup event on each of the matched elements.</desc>
1822 </params>
1823 <desc>Removes a bound mouseup event from each of the matched
1824 elements. You must pass the identical function that was used in the original
1825 bind method.</desc>
1826 <examples>
1827 <code>$("p").unmouseup( myFunction );</code>
1828 <result>&lt;p&gt;Hello&lt;/p&gt;</result>
1829 <before>&lt;p onmouseup="myFunction"&gt;Hello&lt;/p&gt;</before>
1830 </examples>
1831 </method>
1832 <method short='Removes all bound mouseup events from each of the matched elements.' type='jQuery' name='unmouseup' cat='Events'>
1833 <desc>Removes all bound mouseup events from each of the matched elements.</desc>
1834 <examples>
1835 <code>$("p").unmouseup();</code>
1836 <result>&lt;p&gt;Hello&lt;/p&gt;</result>
1837 <before>&lt;p onmouseup="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
1838 </examples>
1839 </method>
1840 <method short='Bind a function to the mousemove event of each matched element.' type='jQuery' name='mousemove' cat='Events'>
1841 <params type='Function' name='fn'>
1842 <desc>A function to bind to the mousemove event on each of the matched elements.</desc>
1843 </params>
1844 <desc>Bind a function to the mousemove event of each matched element.</desc>
1845 <examples>
1846 <code>$("p").mousemove( function() { alert("Hello"); } );</code>
1847 <result>&lt;p onmousemove="alert('Hello');"&gt;Hello&lt;/p&gt;</result>
1848 <before>&lt;p&gt;Hello&lt;/p&gt;</before>
1849 </examples>
1850 </method>
1851 <method short='Trigger the mousemove event of each matched element.' type='jQuery' name='mousemove' cat='Events'>
1852 <desc>Trigger the mousemove event of each matched element. This causes all of the functions
1853 that have been bound to thet mousemove event to be executed.</desc>
1854 <examples>
1855 <code>$("p").mousemove();</code>
1856 <result>alert('Hello');</result>
1857 <before>&lt;p onmousemove="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
1858 </examples>
1859 </method>
1860 <method short='Bind a function to the mousemove event of each matched element, which will only be executed once.' type='jQuery' name='onemousemove' cat='Events'>
1861 <params type='Function' name='fn'>
1862 <desc>A function to bind to the mousemove event on each of the matched elements.</desc>
1863 </params>
1864 <desc>Bind a function to the mousemove event of each matched element, which will only be executed once.
1865 Unlike a call to the normal .mousemove() method, calling .onemousemove() causes the bound function to be
1866 only executed the first time it is triggered, and never again (unless it is re-bound).</desc>
1867 <examples>
1868 <code>$("p").onemousemove( function() { alert("Hello"); } );</code>
1869 <result>alert('Hello'); // Only executed for the first mousemove</result>
1870 <before>&lt;p onmousemove="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
1871 </examples>
1872 </method>
1873 <method short='Removes a bound mousemove event from each of the matched
1874 elements.' type='jQuery' name='unmousemove' cat='Events'>
1875 <params type='Function' name='fn'>
1876 <desc>A function to unbind from the mousemove event on each of the matched elements.</desc>
1877 </params>
1878 <desc>Removes a bound mousemove event from each of the matched
1879 elements. You must pass the identical function that was used in the original
1880 bind method.</desc>
1881 <examples>
1882 <code>$("p").unmousemove( myFunction );</code>
1883 <result>&lt;p&gt;Hello&lt;/p&gt;</result>
1884 <before>&lt;p onmousemove="myFunction"&gt;Hello&lt;/p&gt;</before>
1885 </examples>
1886 </method>
1887 <method short='Removes all bound mousemove events from each of the matched elements.' type='jQuery' name='unmousemove' cat='Events'>
1888 <desc>Removes all bound mousemove events from each of the matched elements.</desc>
1889 <examples>
1890 <code>$("p").unmousemove();</code>
1891 <result>&lt;p&gt;Hello&lt;/p&gt;</result>
1892 <before>&lt;p onmousemove="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
1893 </examples>
1894 </method>
1895 <method short='Bind a function to the mouseover event of each matched element.' type='jQuery' name='mouseover' cat='Events'>
1896 <params type='Function' name='fn'>
1897 <desc>A function to bind to the mouseover event on each of the matched elements.</desc>
1898 </params>
1899 <desc>Bind a function to the mouseover event of each matched element.</desc>
1900 <examples>
1901 <code>$("p").mouseover( function() { alert("Hello"); } );</code>
1902 <result>&lt;p onmouseover="alert('Hello');"&gt;Hello&lt;/p&gt;</result>
1903 <before>&lt;p&gt;Hello&lt;/p&gt;</before>
1904 </examples>
1905 </method>
1906 <method short='Trigger the mouseover event of each matched element.' type='jQuery' name='mouseover' cat='Events'>
1907 <desc>Trigger the mouseover event of each matched element. This causes all of the functions
1908 that have been bound to thet mouseover event to be executed.</desc>
1909 <examples>
1910 <code>$("p").mouseover();</code>
1911 <result>alert('Hello');</result>
1912 <before>&lt;p onmouseover="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
1913 </examples>
1914 </method>
1915 <method short='Bind a function to the mouseover event of each matched element, which will only be executed once.' type='jQuery' name='onemouseover' cat='Events'>
1916 <params type='Function' name='fn'>
1917 <desc>A function to bind to the mouseover event on each of the matched elements.</desc>
1918 </params>
1919 <desc>Bind a function to the mouseover event of each matched element, which will only be executed once.
1920 Unlike a call to the normal .mouseover() method, calling .onemouseover() causes the bound function to be
1921 only executed the first time it is triggered, and never again (unless it is re-bound).</desc>
1922 <examples>
1923 <code>$("p").onemouseover( function() { alert("Hello"); } );</code>
1924 <result>alert('Hello'); // Only executed for the first mouseover</result>
1925 <before>&lt;p onmouseover="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
1926 </examples>
1927 </method>
1928 <method short='Removes a bound mouseover event from each of the matched
1929 elements.' type='jQuery' name='unmouseover' cat='Events'>
1930 <params type='Function' name='fn'>
1931 <desc>A function to unbind from the mouseover event on each of the matched elements.</desc>
1932 </params>
1933 <desc>Removes a bound mouseover event from each of the matched
1934 elements. You must pass the identical function that was used in the original
1935 bind method.</desc>
1936 <examples>
1937 <code>$("p").unmouseover( myFunction );</code>
1938 <result>&lt;p&gt;Hello&lt;/p&gt;</result>
1939 <before>&lt;p onmouseover="myFunction"&gt;Hello&lt;/p&gt;</before>
1940 </examples>
1941 </method>
1942 <method short='Removes all bound mouseover events from each of the matched elements.' type='jQuery' name='unmouseover' cat='Events'>
1943 <desc>Removes all bound mouseover events from each of the matched elements.</desc>
1944 <examples>
1945 <code>$("p").unmouseover();</code>
1946 <result>&lt;p&gt;Hello&lt;/p&gt;</result>
1947 <before>&lt;p onmouseover="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
1948 </examples>
1949 </method>
1950 <method short='Bind a function to the mouseout event of each matched element.' type='jQuery' name='mouseout' cat='Events'>
1951 <params type='Function' name='fn'>
1952 <desc>A function to bind to the mouseout event on each of the matched elements.</desc>
1953 </params>
1954 <desc>Bind a function to the mouseout event of each matched element.</desc>
1955 <examples>
1956 <code>$("p").mouseout( function() { alert("Hello"); } );</code>
1957 <result>&lt;p onmouseout="alert('Hello');"&gt;Hello&lt;/p&gt;</result>
1958 <before>&lt;p&gt;Hello&lt;/p&gt;</before>
1959 </examples>
1960 </method>
1961 <method short='Trigger the mouseout event of each matched element.' type='jQuery' name='mouseout' cat='Events'>
1962 <desc>Trigger the mouseout event of each matched element. This causes all of the functions
1963 that have been bound to thet mouseout event to be executed.</desc>
1964 <examples>
1965 <code>$("p").mouseout();</code>
1966 <result>alert('Hello');</result>
1967 <before>&lt;p onmouseout="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
1968 </examples>
1969 </method>
1970 <method short='Bind a function to the mouseout event of each matched element, which will only be executed once.' type='jQuery' name='onemouseout' cat='Events'>
1971 <params type='Function' name='fn'>
1972 <desc>A function to bind to the mouseout event on each of the matched elements.</desc>
1973 </params>
1974 <desc>Bind a function to the mouseout event of each matched element, which will only be executed once.
1975 Unlike a call to the normal .mouseout() method, calling .onemouseout() causes the bound function to be
1976 only executed the first time it is triggered, and never again (unless it is re-bound).</desc>
1977 <examples>
1978 <code>$("p").onemouseout( function() { alert("Hello"); } );</code>
1979 <result>alert('Hello'); // Only executed for the first mouseout</result>
1980 <before>&lt;p onmouseout="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
1981 </examples>
1982 </method>
1983 <method short='Removes a bound mouseout event from each of the matched
1984 elements.' type='jQuery' name='unmouseout' cat='Events'>
1985 <params type='Function' name='fn'>
1986 <desc>A function to unbind from the mouseout event on each of the matched elements.</desc>
1987 </params>
1988 <desc>Removes a bound mouseout event from each of the matched
1989 elements. You must pass the identical function that was used in the original
1990 bind method.</desc>
1991 <examples>
1992 <code>$("p").unmouseout( myFunction );</code>
1993 <result>&lt;p&gt;Hello&lt;/p&gt;</result>
1994 <before>&lt;p onmouseout="myFunction"&gt;Hello&lt;/p&gt;</before>
1995 </examples>
1996 </method>
1997 <method short='Removes all bound mouseout events from each of the matched elements.' type='jQuery' name='unmouseout' cat='Events'>
1998 <desc>Removes all bound mouseout events from each of the matched elements.</desc>
1999 <examples>
2000 <code>$("p").unmouseout();</code>
2001 <result>&lt;p&gt;Hello&lt;/p&gt;</result>
2002 <before>&lt;p onmouseout="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
2003 </examples>
2004 </method>
2005 <method short='Bind a function to the change event of each matched element.' type='jQuery' name='change' cat='Events'>
2006 <params type='Function' name='fn'>
2007 <desc>A function to bind to the change event on each of the matched elements.</desc>
2008 </params>
2009 <desc>Bind a function to the change event of each matched element.</desc>
2010 <examples>
2011 <code>$("p").change( function() { alert("Hello"); } );</code>
2012 <result>&lt;p onchange="alert('Hello');"&gt;Hello&lt;/p&gt;</result>
2013 <before>&lt;p&gt;Hello&lt;/p&gt;</before>
2014 </examples>
2015 </method>
2016 <method short='Trigger the change event of each matched element.' type='jQuery' name='change' cat='Events'>
2017 <desc>Trigger the change event of each matched element. This causes all of the functions
2018 that have been bound to thet change event to be executed.</desc>
2019 <examples>
2020 <code>$("p").change();</code>
2021 <result>alert('Hello');</result>
2022 <before>&lt;p onchange="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
2023 </examples>
2024 </method>
2025 <method short='Bind a function to the change event of each matched element, which will only be executed once.' type='jQuery' name='onechange' cat='Events'>
2026 <params type='Function' name='fn'>
2027 <desc>A function to bind to the change event on each of the matched elements.</desc>
2028 </params>
2029 <desc>Bind a function to the change event of each matched element, which will only be executed once.
2030 Unlike a call to the normal .change() method, calling .onechange() causes the bound function to be
2031 only executed the first time it is triggered, and never again (unless it is re-bound).</desc>
2032 <examples>
2033 <code>$("p").onechange( function() { alert("Hello"); } );</code>
2034 <result>alert('Hello'); // Only executed for the first change</result>
2035 <before>&lt;p onchange="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
2036 </examples>
2037 </method>
2038 <method short='Removes a bound change event from each of the matched
2039 elements.' type='jQuery' name='unchange' cat='Events'>
2040 <params type='Function' name='fn'>
2041 <desc>A function to unbind from the change event on each of the matched elements.</desc>
2042 </params>
2043 <desc>Removes a bound change event from each of the matched
2044 elements. You must pass the identical function that was used in the original
2045 bind method.</desc>
2046 <examples>
2047 <code>$("p").unchange( myFunction );</code>
2048 <result>&lt;p&gt;Hello&lt;/p&gt;</result>
2049 <before>&lt;p onchange="myFunction"&gt;Hello&lt;/p&gt;</before>
2050 </examples>
2051 </method>
2052 <method short='Removes all bound change events from each of the matched elements.' type='jQuery' name='unchange' cat='Events'>
2053 <desc>Removes all bound change events from each of the matched elements.</desc>
2054 <examples>
2055 <code>$("p").unchange();</code>
2056 <result>&lt;p&gt;Hello&lt;/p&gt;</result>
2057 <before>&lt;p onchange="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
2058 </examples>
2059 </method>
2060 <method short='Bind a function to the reset event of each matched element.' type='jQuery' name='reset' cat='Events'>
2061 <params type='Function' name='fn'>
2062 <desc>A function to bind to the reset event on each of the matched elements.</desc>
2063 </params>
2064 <desc>Bind a function to the reset event of each matched element.</desc>
2065 <examples>
2066 <code>$("p").reset( function() { alert("Hello"); } );</code>
2067 <result>&lt;p onreset="alert('Hello');"&gt;Hello&lt;/p&gt;</result>
2068 <before>&lt;p&gt;Hello&lt;/p&gt;</before>
2069 </examples>
2070 </method>
2071 <method short='Trigger the reset event of each matched element.' type='jQuery' name='reset' cat='Events'>
2072 <desc>Trigger the reset event of each matched element. This causes all of the functions
2073 that have been bound to thet reset event to be executed.</desc>
2074 <examples>
2075 <code>$("p").reset();</code>
2076 <result>alert('Hello');</result>
2077 <before>&lt;p onreset="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
2078 </examples>
2079 </method>
2080 <method short='Bind a function to the reset event of each matched element, which will only be executed once.' type='jQuery' name='onereset' cat='Events'>
2081 <params type='Function' name='fn'>
2082 <desc>A function to bind to the reset event on each of the matched elements.</desc>
2083 </params>
2084 <desc>Bind a function to the reset event of each matched element, which will only be executed once.
2085 Unlike a call to the normal .reset() method, calling .onereset() causes the bound function to be
2086 only executed the first time it is triggered, and never again (unless it is re-bound).</desc>
2087 <examples>
2088 <code>$("p").onereset( function() { alert("Hello"); } );</code>
2089 <result>alert('Hello'); // Only executed for the first reset</result>
2090 <before>&lt;p onreset="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
2091 </examples>
2092 </method>
2093 <method short='Removes a bound reset event from each of the matched
2094 elements.' type='jQuery' name='unreset' cat='Events'>
2095 <params type='Function' name='fn'>
2096 <desc>A function to unbind from the reset event on each of the matched elements.</desc>
2097 </params>
2098 <desc>Removes a bound reset event from each of the matched
2099 elements. You must pass the identical function that was used in the original
2100 bind method.</desc>
2101 <examples>
2102 <code>$("p").unreset( myFunction );</code>
2103 <result>&lt;p&gt;Hello&lt;/p&gt;</result>
2104 <before>&lt;p onreset="myFunction"&gt;Hello&lt;/p&gt;</before>
2105 </examples>
2106 </method>
2107 <method short='Removes all bound reset events from each of the matched elements.' type='jQuery' name='unreset' cat='Events'>
2108 <desc>Removes all bound reset events from each of the matched elements.</desc>
2109 <examples>
2110 <code>$("p").unreset();</code>
2111 <result>&lt;p&gt;Hello&lt;/p&gt;</result>
2112 <before>&lt;p onreset="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
2113 </examples>
2114 </method>
2115 <method short='Bind a function to the select event of each matched element.' type='jQuery' name='select' cat='Events'>
2116 <params type='Function' name='fn'>
2117 <desc>A function to bind to the select event on each of the matched elements.</desc>
2118 </params>
2119 <desc>Bind a function to the select event of each matched element.</desc>
2120 <examples>
2121 <code>$("p").select( function() { alert("Hello"); } );</code>
2122 <result>&lt;p onselect="alert('Hello');"&gt;Hello&lt;/p&gt;</result>
2123 <before>&lt;p&gt;Hello&lt;/p&gt;</before>
2124 </examples>
2125 </method>
2126 <method short='Trigger the select event of each matched element.' type='jQuery' name='select' cat='Events'>
2127 <desc>Trigger the select event of each matched element. This causes all of the functions
2128 that have been bound to thet select event to be executed.</desc>
2129 <examples>
2130 <code>$("p").select();</code>
2131 <result>alert('Hello');</result>
2132 <before>&lt;p onselect="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
2133 </examples>
2134 </method>
2135 <method short='Bind a function to the select event of each matched element, which will only be executed once.' type='jQuery' name='oneselect' cat='Events'>
2136 <params type='Function' name='fn'>
2137 <desc>A function to bind to the select event on each of the matched elements.</desc>
2138 </params>
2139 <desc>Bind a function to the select event of each matched element, which will only be executed once.
2140 Unlike a call to the normal .select() method, calling .oneselect() causes the bound function to be
2141 only executed the first time it is triggered, and never again (unless it is re-bound).</desc>
2142 <examples>
2143 <code>$("p").oneselect( function() { alert("Hello"); } );</code>
2144 <result>alert('Hello'); // Only executed for the first select</result>
2145 <before>&lt;p onselect="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
2146 </examples>
2147 </method>
2148 <method short='Removes a bound select event from each of the matched
2149 elements.' type='jQuery' name='unselect' cat='Events'>
2150 <params type='Function' name='fn'>
2151 <desc>A function to unbind from the select event on each of the matched elements.</desc>
2152 </params>
2153 <desc>Removes a bound select event from each of the matched
2154 elements. You must pass the identical function that was used in the original
2155 bind method.</desc>
2156 <examples>
2157 <code>$("p").unselect( myFunction );</code>
2158 <result>&lt;p&gt;Hello&lt;/p&gt;</result>
2159 <before>&lt;p onselect="myFunction"&gt;Hello&lt;/p&gt;</before>
2160 </examples>
2161 </method>
2162 <method short='Removes all bound select events from each of the matched elements.' type='jQuery' name='unselect' cat='Events'>
2163 <desc>Removes all bound select events from each of the matched elements.</desc>
2164 <examples>
2165 <code>$("p").unselect();</code>
2166 <result>&lt;p&gt;Hello&lt;/p&gt;</result>
2167 <before>&lt;p onselect="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
2168 </examples>
2169 </method>
2170 <method short='Bind a function to the submit event of each matched element.' type='jQuery' name='submit' cat='Events'>
2171 <params type='Function' name='fn'>
2172 <desc>A function to bind to the submit event on each of the matched elements.</desc>
2173 </params>
2174 <desc>Bind a function to the submit event of each matched element.</desc>
2175 <examples>
2176 <code>$("p").submit( function() { alert("Hello"); } );</code>
2177 <result>&lt;p onsubmit="alert('Hello');"&gt;Hello&lt;/p&gt;</result>
2178 <before>&lt;p&gt;Hello&lt;/p&gt;</before>
2179 </examples>
2180 </method>
2181 <method short='Trigger the submit event of each matched element.' type='jQuery' name='submit' cat='Events'>
2182 <desc>Trigger the submit event of each matched element. This causes all of the functions
2183 that have been bound to thet submit event to be executed.</desc>
2184 <examples>
2185 <code>$("p").submit();</code>
2186 <result>alert('Hello');</result>
2187 <before>&lt;p onsubmit="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
2188 </examples>
2189 </method>
2190 <method short='Bind a function to the submit event of each matched element, which will only be executed once.' type='jQuery' name='onesubmit' cat='Events'>
2191 <params type='Function' name='fn'>
2192 <desc>A function to bind to the submit event on each of the matched elements.</desc>
2193 </params>
2194 <desc>Bind a function to the submit event of each matched element, which will only be executed once.
2195 Unlike a call to the normal .submit() method, calling .onesubmit() causes the bound function to be
2196 only executed the first time it is triggered, and never again (unless it is re-bound).</desc>
2197 <examples>
2198 <code>$("p").onesubmit( function() { alert("Hello"); } );</code>
2199 <result>alert('Hello'); // Only executed for the first submit</result>
2200 <before>&lt;p onsubmit="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
2201 </examples>
2202 </method>
2203 <method short='Removes a bound submit event from each of the matched
2204 elements.' type='jQuery' name='unsubmit' cat='Events'>
2205 <params type='Function' name='fn'>
2206 <desc>A function to unbind from the submit event on each of the matched elements.</desc>
2207 </params>
2208 <desc>Removes a bound submit event from each of the matched
2209 elements. You must pass the identical function that was used in the original
2210 bind method.</desc>
2211 <examples>
2212 <code>$("p").unsubmit( myFunction );</code>
2213 <result>&lt;p&gt;Hello&lt;/p&gt;</result>
2214 <before>&lt;p onsubmit="myFunction"&gt;Hello&lt;/p&gt;</before>
2215 </examples>
2216 </method>
2217 <method short='Removes all bound submit events from each of the matched elements.' type='jQuery' name='unsubmit' cat='Events'>
2218 <desc>Removes all bound submit events from each of the matched elements.</desc>
2219 <examples>
2220 <code>$("p").unsubmit();</code>
2221 <result>&lt;p&gt;Hello&lt;/p&gt;</result>
2222 <before>&lt;p onsubmit="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
2223 </examples>
2224 </method>
2225 <method short='Bind a function to the keydown event of each matched element.' type='jQuery' name='keydown' cat='Events'>
2226 <params type='Function' name='fn'>
2227 <desc>A function to bind to the keydown event on each of the matched elements.</desc>
2228 </params>
2229 <desc>Bind a function to the keydown event of each matched element.</desc>
2230 <examples>
2231 <code>$("p").keydown( function() { alert("Hello"); } );</code>
2232 <result>&lt;p onkeydown="alert('Hello');"&gt;Hello&lt;/p&gt;</result>
2233 <before>&lt;p&gt;Hello&lt;/p&gt;</before>
2234 </examples>
2235 </method>
2236 <method short='Trigger the keydown event of each matched element.' type='jQuery' name='keydown' cat='Events'>
2237 <desc>Trigger the keydown event of each matched element. This causes all of the functions
2238 that have been bound to thet keydown event to be executed.</desc>
2239 <examples>
2240 <code>$("p").keydown();</code>
2241 <result>alert('Hello');</result>
2242 <before>&lt;p onkeydown="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
2243 </examples>
2244 </method>
2245 <method short='Bind a function to the keydown event of each matched element, which will only be executed once.' type='jQuery' name='onekeydown' cat='Events'>
2246 <params type='Function' name='fn'>
2247 <desc>A function to bind to the keydown event on each of the matched elements.</desc>
2248 </params>
2249 <desc>Bind a function to the keydown event of each matched element, which will only be executed once.
2250 Unlike a call to the normal .keydown() method, calling .onekeydown() causes the bound function to be
2251 only executed the first time it is triggered, and never again (unless it is re-bound).</desc>
2252 <examples>
2253 <code>$("p").onekeydown( function() { alert("Hello"); } );</code>
2254 <result>alert('Hello'); // Only executed for the first keydown</result>
2255 <before>&lt;p onkeydown="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
2256 </examples>
2257 </method>
2258 <method short='Removes a bound keydown event from each of the matched
2259 elements.' type='jQuery' name='unkeydown' cat='Events'>
2260 <params type='Function' name='fn'>
2261 <desc>A function to unbind from the keydown event on each of the matched elements.</desc>
2262 </params>
2263 <desc>Removes a bound keydown event from each of the matched
2264 elements. You must pass the identical function that was used in the original
2265 bind method.</desc>
2266 <examples>
2267 <code>$("p").unkeydown( myFunction );</code>
2268 <result>&lt;p&gt;Hello&lt;/p&gt;</result>
2269 <before>&lt;p onkeydown="myFunction"&gt;Hello&lt;/p&gt;</before>
2270 </examples>
2271 </method>
2272 <method short='Removes all bound keydown events from each of the matched elements.' type='jQuery' name='unkeydown' cat='Events'>
2273 <desc>Removes all bound keydown events from each of the matched elements.</desc>
2274 <examples>
2275 <code>$("p").unkeydown();</code>
2276 <result>&lt;p&gt;Hello&lt;/p&gt;</result>
2277 <before>&lt;p onkeydown="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
2278 </examples>
2279 </method>
2280 <method short='Bind a function to the keypress event of each matched element.' type='jQuery' name='keypress' cat='Events'>
2281 <params type='Function' name='fn'>
2282 <desc>A function to bind to the keypress event on each of the matched elements.</desc>
2283 </params>
2284 <desc>Bind a function to the keypress event of each matched element.</desc>
2285 <examples>
2286 <code>$("p").keypress( function() { alert("Hello"); } );</code>
2287 <result>&lt;p onkeypress="alert('Hello');"&gt;Hello&lt;/p&gt;</result>
2288 <before>&lt;p&gt;Hello&lt;/p&gt;</before>
2289 </examples>
2290 </method>
2291 <method short='Trigger the keypress event of each matched element.' type='jQuery' name='keypress' cat='Events'>
2292 <desc>Trigger the keypress event of each matched element. This causes all of the functions
2293 that have been bound to thet keypress event to be executed.</desc>
2294 <examples>
2295 <code>$("p").keypress();</code>
2296 <result>alert('Hello');</result>
2297 <before>&lt;p onkeypress="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
2298 </examples>
2299 </method>
2300 <method short='Bind a function to the keypress event of each matched element, which will only be executed once.' type='jQuery' name='onekeypress' cat='Events'>
2301 <params type='Function' name='fn'>
2302 <desc>A function to bind to the keypress event on each of the matched elements.</desc>
2303 </params>
2304 <desc>Bind a function to the keypress event of each matched element, which will only be executed once.
2305 Unlike a call to the normal .keypress() method, calling .onekeypress() causes the bound function to be
2306 only executed the first time it is triggered, and never again (unless it is re-bound).</desc>
2307 <examples>
2308 <code>$("p").onekeypress( function() { alert("Hello"); } );</code>
2309 <result>alert('Hello'); // Only executed for the first keypress</result>
2310 <before>&lt;p onkeypress="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
2311 </examples>
2312 </method>
2313 <method short='Removes a bound keypress event from each of the matched
2314 elements.' type='jQuery' name='unkeypress' cat='Events'>
2315 <params type='Function' name='fn'>
2316 <desc>A function to unbind from the keypress event on each of the matched elements.</desc>
2317 </params>
2318 <desc>Removes a bound keypress event from each of the matched
2319 elements. You must pass the identical function that was used in the original
2320 bind method.</desc>
2321 <examples>
2322 <code>$("p").unkeypress( myFunction );</code>
2323 <result>&lt;p&gt;Hello&lt;/p&gt;</result>
2324 <before>&lt;p onkeypress="myFunction"&gt;Hello&lt;/p&gt;</before>
2325 </examples>
2326 </method>
2327 <method short='Removes all bound keypress events from each of the matched elements.' type='jQuery' name='unkeypress' cat='Events'>
2328 <desc>Removes all bound keypress events from each of the matched elements.</desc>
2329 <examples>
2330 <code>$("p").unkeypress();</code>
2331 <result>&lt;p&gt;Hello&lt;/p&gt;</result>
2332 <before>&lt;p onkeypress="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
2333 </examples>
2334 </method>
2335 <method short='Bind a function to the keyup event of each matched element.' type='jQuery' name='keyup' cat='Events'>
2336 <params type='Function' name='fn'>
2337 <desc>A function to bind to the keyup event on each of the matched elements.</desc>
2338 </params>
2339 <desc>Bind a function to the keyup event of each matched element.</desc>
2340 <examples>
2341 <code>$("p").keyup( function() { alert("Hello"); } );</code>
2342 <result>&lt;p onkeyup="alert('Hello');"&gt;Hello&lt;/p&gt;</result>
2343 <before>&lt;p&gt;Hello&lt;/p&gt;</before>
2344 </examples>
2345 </method>
2346 <method short='Trigger the keyup event of each matched element.' type='jQuery' name='keyup' cat='Events'>
2347 <desc>Trigger the keyup event of each matched element. This causes all of the functions
2348 that have been bound to thet keyup event to be executed.</desc>
2349 <examples>
2350 <code>$("p").keyup();</code>
2351 <result>alert('Hello');</result>
2352 <before>&lt;p onkeyup="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
2353 </examples>
2354 </method>
2355 <method short='Bind a function to the keyup event of each matched element, which will only be executed once.' type='jQuery' name='onekeyup' cat='Events'>
2356 <params type='Function' name='fn'>
2357 <desc>A function to bind to the keyup event on each of the matched elements.</desc>
2358 </params>
2359 <desc>Bind a function to the keyup event of each matched element, which will only be executed once.
2360 Unlike a call to the normal .keyup() method, calling .onekeyup() causes the bound function to be
2361 only executed the first time it is triggered, and never again (unless it is re-bound).</desc>
2362 <examples>
2363 <code>$("p").onekeyup( function() { alert("Hello"); } );</code>
2364 <result>alert('Hello'); // Only executed for the first keyup</result>
2365 <before>&lt;p onkeyup="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
2366 </examples>
2367 </method>
2368 <method short='Removes a bound keyup event from each of the matched
2369 elements.' type='jQuery' name='unkeyup' cat='Events'>
2370 <params type='Function' name='fn'>
2371 <desc>A function to unbind from the keyup event on each of the matched elements.</desc>
2372 </params>
2373 <desc>Removes a bound keyup event from each of the matched
2374 elements. You must pass the identical function that was used in the original
2375 bind method.</desc>
2376 <examples>
2377 <code>$("p").unkeyup( myFunction );</code>
2378 <result>&lt;p&gt;Hello&lt;/p&gt;</result>
2379 <before>&lt;p onkeyup="myFunction"&gt;Hello&lt;/p&gt;</before>
2380 </examples>
2381 </method>
2382 <method short='Removes all bound keyup events from each of the matched elements.' type='jQuery' name='unkeyup' cat='Events'>
2383 <desc>Removes all bound keyup events from each of the matched elements.</desc>
2384 <examples>
2385 <code>$("p").unkeyup();</code>
2386 <result>&lt;p&gt;Hello&lt;/p&gt;</result>
2387 <before>&lt;p onkeyup="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
2388 </examples>
2389 </method>
2390 <method short='Bind a function to the error event of each matched element.' type='jQuery' name='error' cat='Events'>
2391 <params type='Function' name='fn'>
2392 <desc>A function to bind to the error event on each of the matched elements.</desc>
2393 </params>
2394 <desc>Bind a function to the error event of each matched element.</desc>
2395 <examples>
2396 <code>$("p").error( function() { alert("Hello"); } );</code>
2397 <result>&lt;p onerror="alert('Hello');"&gt;Hello&lt;/p&gt;</result>
2398 <before>&lt;p&gt;Hello&lt;/p&gt;</before>
2399 </examples>
2400 </method>
2401 <method short='Trigger the error event of each matched element.' type='jQuery' name='error' cat='Events'>
2402 <desc>Trigger the error event of each matched element. This causes all of the functions
2403 that have been bound to thet error event to be executed.</desc>
2404 <examples>
2405 <code>$("p").error();</code>
2406 <result>alert('Hello');</result>
2407 <before>&lt;p onerror="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
2408 </examples>
2409 </method>
2410 <method short='Bind a function to the error event of each matched element, which will only be executed once.' type='jQuery' name='oneerror' cat='Events'>
2411 <params type='Function' name='fn'>
2412 <desc>A function to bind to the error event on each of the matched elements.</desc>
2413 </params>
2414 <desc>Bind a function to the error event of each matched element, which will only be executed once.
2415 Unlike a call to the normal .error() method, calling .oneerror() causes the bound function to be
2416 only executed the first time it is triggered, and never again (unless it is re-bound).</desc>
2417 <examples>
2418 <code>$("p").oneerror( function() { alert("Hello"); } );</code>
2419 <result>alert('Hello'); // Only executed for the first error</result>
2420 <before>&lt;p onerror="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
2421 </examples>
2422 </method>
2423 <method short='Removes a bound error event from each of the matched
2424 elements.' type='jQuery' name='unerror' cat='Events'>
2425 <params type='Function' name='fn'>
2426 <desc>A function to unbind from the error event on each of the matched elements.</desc>
2427 </params>
2428 <desc>Removes a bound error event from each of the matched
2429 elements. You must pass the identical function that was used in the original
2430 bind method.</desc>
2431 <examples>
2432 <code>$("p").unerror( myFunction );</code>
2433 <result>&lt;p&gt;Hello&lt;/p&gt;</result>
2434 <before>&lt;p onerror="myFunction"&gt;Hello&lt;/p&gt;</before>
2435 </examples>
2436 </method>
2437 <method short='Removes all bound error events from each of the matched elements.' type='jQuery' name='unerror' cat='Events'>
2438 <desc>Removes all bound error events from each of the matched elements.</desc>
2439 <examples>
2440 <code>$("p").unerror();</code>
2441 <result>&lt;p&gt;Hello&lt;/p&gt;</result>
2442 <before>&lt;p onerror="alert('Hello');"&gt;Hello&lt;/p&gt;</before>
2443 </examples>
2444 </method>
2445 <method short='Show all matched elements using a graceful animation.' type='jQuery' name='show' cat='Effects/Animations'>
2446 <params type='Object' name='speed'>
2447 <desc>A string representing one of the three predefined speeds ("slow", "normal", or "fast") or the number of milliseconds to run the animation (e.g. 1000).</desc>
2448 </params>
2449 <desc>Show all matched elements using a graceful animation.
2450 The height, width, and opacity of each of the matched elements
2451 are changed dynamically according to the specified speed.</desc>
2452 <examples>
2453 <code>$("p").show("slow");</code>
2454 </examples>
2455 </method>
2456 <method short='Show all matched elements using a graceful animation and firing a callback
2457 function after completion.' type='jQuery' name='show' cat='Effects/Animations'>
2458 <params type='Object' name='speed'>
2459 <desc>A string representing one of the three predefined speeds ("slow", "normal", or "fast") or the number of milliseconds to run the animation (e.g. 1000).</desc>
2460 </params>
2461 <params type='Function' name='callback'>
2462 <desc>A function to be executed whenever the animation completes.</desc>
2463 </params>
2464 <desc>Show all matched elements using a graceful animation and firing a callback
2465 function after completion.
2466 The height, width, and opacity of each of the matched elements
2467 are changed dynamically according to the specified speed.</desc>
2468 <examples>
2469 <code>$("p").show("slow",function(){<br/>  alert("Animation Done.");<br/>});</code>
2470 </examples>
2471 </method>
2472 <method short='Hide all matched elements using a graceful animation.' type='jQuery' name='hide' cat='Effects/Animations'>
2473 <params type='Object' name='speed'>
2474 <desc>A string representing one of the three predefined speeds ("slow", "normal", or "fast") or the number of milliseconds to run the animation (e.g. 1000).</desc>
2475 </params>
2476 <desc>Hide all matched elements using a graceful animation.
2477 The height, width, and opacity of each of the matched elements
2478 are changed dynamically according to the specified speed.</desc>
2479 <examples>
2480 <code>$("p").hide("slow");</code>
2481 </examples>
2482 </method>
2483 <method short='Hide all matched elements using a graceful animation and firing a callback
2484 function after completion.' type='jQuery' name='hide' cat='Effects/Animations'>
2485 <params type='Object' name='speed'>
2486 <desc>A string representing one of the three predefined speeds ("slow", "normal", or "fast") or the number of milliseconds to run the animation (e.g. 1000).</desc>
2487 </params>
2488 <params type='Function' name='callback'>
2489 <desc>A function to be executed whenever the animation completes.</desc>
2490 </params>
2491 <desc>Hide all matched elements using a graceful animation and firing a callback
2492 function after completion.
2493 The height, width, and opacity of each of the matched elements
2494 are changed dynamically according to the specified speed.</desc>
2495 <examples>
2496 <code>$("p").hide("slow",function(){<br/>  alert("Animation Done.");<br/>});</code>
2497 </examples>
2498 </method>
2499 <method short='Reveal all matched elements by adjusting their height.' type='jQuery' name='slideDown' cat='Effects/Animations'>
2500 <params type='Object' name='speed'>
2501 <desc>A string representing one of the three predefined speeds ("slow", "normal", or "fast") or the number of milliseconds to run the animation (e.g. 1000).</desc>
2502 </params>
2503 <desc>Reveal all matched elements by adjusting their height.
2504 Only the height is adjusted for this animation, causing all matched
2505 elements to be revealed in a "sliding" manner.</desc>
2506 <examples>
2507 <code>$("p").slideDown("slow");</code>
2508 </examples>
2509 </method>
2510 <method short='Reveal all matched elements by adjusting their height and firing a callback
2511 function after completion.' type='jQuery' name='slideDown' cat='Effects/Animations'>
2512 <params type='Object' name='speed'>
2513 <desc>A string representing one of the three predefined speeds ("slow", "normal", or "fast") or the number of milliseconds to run the animation (e.g. 1000).</desc>
2514 </params>
2515 <params type='Function' name='callback'>
2516 <desc>A function to be executed whenever the animation completes.</desc>
2517 </params>
2518 <desc>Reveal all matched elements by adjusting their height and firing a callback
2519 function after completion.
2520 Only the height is adjusted for this animation, causing all matched
2521 elements to be revealed in a "sliding" manner.</desc>
2522 <examples>
2523 <code>$("p").slideDown("slow",function(){<br/>  alert("Animation Done.");<br/>});</code>
2524 </examples>
2525 </method>
2526 <method short='Hide all matched elements by adjusting their height.' type='jQuery' name='slideUp' cat='Effects/Animations'>
2527 <params type='Object' name='speed'>
2528 <desc>A string representing one of the three predefined speeds ("slow", "normal", or "fast") or the number of milliseconds to run the animation (e.g. 1000).</desc>
2529 </params>
2530 <desc>Hide all matched elements by adjusting their height.
2531 Only the height is adjusted for this animation, causing all matched
2532 elements to be hidden in a "sliding" manner.</desc>
2533 <examples>
2534 <code>$("p").slideUp("slow");</code>
2535 </examples>
2536 </method>
2537 <method short='Hide all matched elements by adjusting their height and firing a callback
2538 function after completion.' type='jQuery' name='slideUp' cat='Effects/Animations'>
2539 <params type='Object' name='speed'>
2540 <desc>A string representing one of the three predefined speeds ("slow", "normal", or "fast") or the number of milliseconds to run the animation (e.g. 1000).</desc>
2541 </params>
2542 <params type='Function' name='callback'>
2543 <desc>A function to be executed whenever the animation completes.</desc>
2544 </params>
2545 <desc>Hide all matched elements by adjusting their height and firing a callback
2546 function after completion.
2547 Only the height is adjusted for this animation, causing all matched
2548 elements to be hidden in a "sliding" manner.</desc>
2549 <examples>
2550 <code>$("p").slideUp("slow",function(){<br/>  alert("Animation Done.");<br/>});</code>
2551 </examples>
2552 </method>
2553 <method short='Fade in all matched elements by adjusting their opacity.' type='jQuery' name='fadeIn' cat='Effects/Animations'>
2554 <params type='Object' name='speed'>
2555 <desc>A string representing one of the three predefined speeds ("slow", "normal", or "fast") or the number of milliseconds to run the animation (e.g. 1000).</desc>
2556 </params>
2557 <desc>Fade in all matched elements by adjusting their opacity.
2558 Only the opacity is adjusted for this animation, meaning that
2559 all of the matched elements should already have some form of height
2560 and width associated with them.</desc>
2561 <examples>
2562 <code>$("p").fadeIn("slow");</code>
2563 </examples>
2564 </method>
2565 <method short='Fade in all matched elements by adjusting their opacity and firing a
2566 callback function after completion.' type='jQuery' name='fadeIn' cat='Effects/Animations'>
2567 <params type='Object' name='speed'>
2568 <desc>A string representing one of the three predefined speeds ("slow", "normal", or "fast") or the number of milliseconds to run the animation (e.g. 1000).</desc>
2569 </params>
2570 <params type='Function' name='callback'>
2571 <desc>A function to be executed whenever the animation completes.</desc>
2572 </params>
2573 <desc>Fade in all matched elements by adjusting their opacity and firing a
2574 callback function after completion.
2575 Only the opacity is adjusted for this animation, meaning that
2576 all of the matched elements should already have some form of height
2577 and width associated with them.</desc>
2578 <examples>
2579 <code>$("p").fadeIn("slow",function(){<br/>  alert("Animation Done.");<br/>});</code>
2580 </examples>
2581 </method>
2582 <method short='Fade out all matched elements by adjusting their opacity.' type='jQuery' name='fadeOut' cat='Effects/Animations'>
2583 <params type='Object' name='speed'>
2584 <desc>A string representing one of the three predefined speeds ("slow", "normal", or "fast") or the number of milliseconds to run the animation (e.g. 1000).</desc>
2585 </params>
2586 <desc>Fade out all matched elements by adjusting their opacity.
2587 Only the opacity is adjusted for this animation, meaning that
2588 all of the matched elements should already have some form of height
2589 and width associated with them.</desc>
2590 <examples>
2591 <code>$("p").fadeOut("slow");</code>
2592 </examples>
2593 </method>
2594 <method short='Fade out all matched elements by adjusting their opacity and firing a
2595 callback function after completion.' type='jQuery' name='fadeOut' cat='Effects/Animations'>
2596 <params type='Object' name='speed'>
2597 <desc>A string representing one of the three predefined speeds ("slow", "normal", or "fast") or the number of milliseconds to run the animation (e.g. 1000).</desc>
2598 </params>
2599 <params type='Function' name='callback'>
2600 <desc>A function to be executed whenever the animation completes.</desc>
2601 </params>
2602 <desc>Fade out all matched elements by adjusting their opacity and firing a
2603 callback function after completion.
2604 Only the opacity is adjusted for this animation, meaning that
2605 all of the matched elements should already have some form of height
2606 and width associated with them.</desc>
2607 <examples>
2608 <code>$("p").fadeOut("slow",function(){<br/>  alert("Animation Done.");<br/>});</code>
2609 </examples>
2610 </method>
2611 <method short='Fade the opacity of all matched elements to a specified opacity.' type='jQuery' name='fadeTo' cat='Effects/Animations'>
2612 <params type='Object' name='speed'>
2613 <desc>A string representing one of the three predefined speeds ("slow", "normal", or "fast") or the number of milliseconds to run the animation (e.g. 1000).</desc>
2614 </params>
2615 <params type='Number' name='opacity'>
2616 <desc>The opacity to fade to (a number from 0 to 1).</desc>
2617 </params>
2618 <desc>Fade the opacity of all matched elements to a specified opacity.
2619 Only the opacity is adjusted for this animation, meaning that
2620 all of the matched elements should already have some form of height
2621 and width associated with them.</desc>
2622 <examples>
2623 <code>$("p").fadeTo("slow", 0.5);</code>
2624 </examples>
2625 </method>
2626 <method short='Fade the opacity of all matched elements to a specified opacity and
2627 firing a callback function after completion.' type='jQuery' name='fadeTo' cat='Effects/Animations'>
2628 <params type='Object' name='speed'>
2629 <desc>A string representing one of the three predefined speeds ("slow", "normal", or "fast") or the number of milliseconds to run the animation (e.g. 1000).</desc>
2630 </params>
2631 <params type='Number' name='opacity'>
2632 <desc>The opacity to fade to (a number from 0 to 1).</desc>
2633 </params>
2634 <params type='Function' name='callback'>
2635 <desc>A function to be executed whenever the animation completes.</desc>
2636 </params>
2637 <desc>Fade the opacity of all matched elements to a specified opacity and
2638 firing a callback function after completion.
2639 Only the opacity is adjusted for this animation, meaning that
2640 all of the matched elements should already have some form of height
2641 and width associated with them.</desc>
2642 <examples>
2643 <code>$("p").fadeTo("slow", 0.5, function(){<br/>  alert("Animation Done.");<br/>});</code>
2644 </examples>
2645 </method>
2646 </docs>