docs/data/jquery-docs-xml.xml

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