docs/output/Ext.DomQuery.html

   1 <div xmlns:ext="http://www.extjs.com" class="body-wrap"><h1>Class <a href="source/DomQuery.html#cls-Ext.DomQuery">Ext.DomQuery</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Ext</td></tr><tr><td class="label">Defined In:</td><td class="hd-info">DomQuery.js</td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/DomQuery.html#cls-Ext.DomQuery">DomQuery</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr></table><div class="description">Provides high performance selector/xpath processing by compiling queries into reusable functions. New pseudo classes and matchers can be plugged. It works on HTML and XML documents (if a content node is passed in).\r
   2 <p>\r
   3 DomQuery supports most of the <a href="http://www.w3.org/TR/2005/WD-css3-selectors-20051215/#selectors">CSS3 selectors spec</a>, along with some custom selectors and basic XPath.</p>\r
   4 \r
   5 <p>\r
   6 All selectors, attribute filters and pseudos below can be combined infinitely in any order. For example "div.foo:nth-child(odd)[@foo=bar].bar:first" would be a perfectly valid selector. Node filters are processed in the order in which they appear, which allows you to optimize your queries for your document structure.\r
   7 </p>\r
   8 <h4>Element Selectors:</h4>\r
   9 <ul class="list">\r
  10     <li> <b>*</b> any element</li>\r
  11     <li> <b>E</b> an element with the tag E</li>\r
  12     <li> <b>E F</b> All descendent elements of E that have the tag F</li>\r
  13     <li> <b>E > F</b> or <b>E/F</b> all direct children elements of E that have the tag F</li>\r
  14     <li> <b>E + F</b> all elements with the tag F that are immediately preceded by an element with the tag E</li>\r
  15     <li> <b>E ~ F</b> all elements with the tag F that are preceded by a sibling element with the tag E</li>\r
  16 </ul>\r
  17 <h4>Attribute Selectors:</h4>\r
  18 <p>The use of &#64; and quotes are optional. For example, div[&#64;foo='bar'] is also a valid attribute selector.</p>\r
  19 <ul class="list">\r
  20     <li> <b>E[foo]</b> has an attribute "foo"</li>\r
  21     <li> <b>E[foo=bar]</b> has an attribute "foo" that equals "bar"</li>\r
  22     <li> <b>E[foo^=bar]</b> has an attribute "foo" that starts with "bar"</li>\r
  23     <li> <b>E[foo$=bar]</b> has an attribute "foo" that ends with "bar"</li>\r
  24     <li> <b>E[foo*=bar]</b> has an attribute "foo" that contains the substring "bar"</li>\r
  25     <li> <b>E[foo%=2]</b> has an attribute "foo" that is evenly divisible by 2</li>\r
  26     <li> <b>E[foo!=bar]</b> has an attribute "foo" that does not equal "bar"</li>\r
  27 </ul>\r
  28 <h4>Pseudo Classes:</h4>\r
  29 <ul class="list">\r
  30     <li> <b>E:first-child</b> E is the first child of its parent</li>\r
  31     <li> <b>E:last-child</b> E is the last child of its parent</li>\r
  32     <li> <b>E:nth-child(<i>n</i>)</b> E is the <i>n</i>th child of its parent (1 based as per the spec)</li>\r
  33     <li> <b>E:nth-child(odd)</b> E is an odd child of its parent</li>\r
  34     <li> <b>E:nth-child(even)</b> E is an even child of its parent</li>\r
  35     <li> <b>E:only-child</b> E is the only child of its parent</li>\r
  36     <li> <b>E:checked</b> E is an element that is has a checked attribute that is true (e.g. a radio or checkbox) </li>\r
  37     <li> <b>E:first</b> the first E in the resultset</li>\r
  38     <li> <b>E:last</b> the last E in the resultset</li>\r
  39     <li> <b>E:nth(<i>n</i>)</b> the <i>n</i>th E in the resultset (1 based)</li>\r
  40     <li> <b>E:odd</b> shortcut for :nth-child(odd)</li>\r
  41     <li> <b>E:even</b> shortcut for :nth-child(even)</li>\r
  42     <li> <b>E:contains(foo)</b> E's innerHTML contains the substring "foo"</li>\r
  43     <li> <b>E:nodeValue(foo)</b> E contains a textNode with a nodeValue that equals "foo"</li>\r
  44     <li> <b>E:not(S)</b> an E element that does not match simple selector S</li>\r
  45     <li> <b>E:has(S)</b> an E element that has a descendent that matches simple selector S</li>\r
  46     <li> <b>E:next(S)</b> an E element whose next sibling matches simple selector S</li>\r
  47     <li> <b>E:prev(S)</b> an E element whose previous sibling matches simple selector S</li>\r
  48     <li> <b>E:any(S1|S2|S2)</b> an E element which matches any of the simple selectors S1, S2 or S3//\\</li>\r
  49 </ul>\r
  50 <h4>CSS Value Selectors:</h4>\r
  51 <ul class="list">\r
  52     <li> <b>E{display=none}</b> css value "display" that equals "none"</li>\r
  53     <li> <b>E{display^=none}</b> css value "display" that starts with "none"</li>\r
  54     <li> <b>E{display$=none}</b> css value "display" that ends with "none"</li>\r
  55     <li> <b>E{display*=none}</b> css value "display" that contains the substring "none"</li>\r
  56     <li> <b>E{display%=2}</b> css value "display" that is evenly divisible by 2</li>\r
  57     <li> <b>E{display!=none}</b> css value "display" that does not equal "none"</li>\r
  58 </ul><br><br><i>This class is a singleton and cannot be created directly.</i></div><div class="hr"></div><a id="Ext.DomQuery-props"></a><h2>Public Properties</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Property</th><th class="msource-header">Defined By</th></tr><tr class="property-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.DomQuery-matchers"></a><b><a href="source/DomQuery.html#prop-Ext.DomQuery-matchers">matchers</a></b> : Object<div class="mdesc"><div class="short">Collection of matching regular expressions and code snippets.&#13;
  59 Each capture group within () will be replace the {} in...</div><div class="long">Collection of matching regular expressions and code snippets.\r
  60 Each capture group within () will be replace the {} in the select\r
  61 statement as specified by their index.</div></div></td><td class="msource">DomQuery</td></tr><tr class="property-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.DomQuery-pseudos"></a><b><a href="source/DomQuery.html#prop-Ext.DomQuery-pseudos">pseudos</a></b> : Object<div class="mdesc"><div class="short">Object hash of "pseudo class" filter functions which are used when filtering selections. Each function is passed&#13;
  62 two...</div><div class="long"><p>Object hash of "pseudo class" filter functions which are used when filtering selections. Each function is passed\r
  63 two parameters:</p><div class="mdetail-params"><ul>\r
  64 <li><b>c</b> : Array<div class="sub-desc">An Array of DOM elements to filter.</div></li>\r
  65 <li><b>v</b> : String<div class="sub-desc">The argument (if any) supplied in the selector.</div></li>\r
  66 </ul></div>\r
  67 <p>A filter function returns an Array of DOM elements which conform to the pseudo class.</p>\r
  68 <p>In addition to the provided pseudo classes listed above such as <code>first-child</code> and <code>nth-child</code>,\r
  69 developers may add additional, custom psuedo class filters to select elements according to application-specific requirements.</p>\r
  70 <p>For example, to filter <code>&lt;a></code> elements to only return links to <i>external</i> resources:</p>\r
  71 <code><pre>\r
  72 Ext.DomQuery.pseudos.external = <b>function</b>(c, v){\r
  73     <b>var</b> r = [], ri = -1;\r
  74     <b>for</b>(<b>var</b> i = 0, ci; ci = c[i]; i++){\r
  75 <i>//      Include <b>in</b> result set only <b>if</b> it<em>'s a link to an external resource\r</i>
  76         <b>if</b>(ci.hostname != location.hostname){\r
  77             r[++ri] = ci;\r
  78         }\r
  79     }\r
  80     <b>return</b> r;\r
  81 };</pre></code>\r
  82 Then external links could be gathered with the following statement:<code><pre>\r
  83 <b>var</b> externalLinks = Ext.select(<em>"a:external"</em>);</code></pre></div></div></td><td class="msource">DomQuery</td></tr></tbody></table><a id="Ext.DomQuery-methods"></a><h2>Public Methods</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Method</th><th class="msource-header">Defined By</th></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.DomQuery-compile"></a><b><a href="source/DomQuery.html#method-Ext.DomQuery-compile">compile</a></b>(&nbsp;<code>String&nbsp;selector</code>,&nbsp;<span title="Optional" class="optional">[<code>String&nbsp;type</code>]</span>&nbsp;)
  84     :
  85                                         Function<div class="mdesc"><div class="short">Compiles a selector/xpath query into a reusable function. The returned function&#13;
  86 takes one parameter "root" (optional...</div><div class="long">Compiles a selector/xpath query into a reusable function. The returned function\r
  87 takes one parameter "root" (optional), which is the context node from where the query should start.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>selector</code> : String<div class="sub-desc">The selector/xpath query</div></li><li><code>type</code> : String<div class="sub-desc">(optional) Either "select" (the default) or "simple" for a simple selector match</div></li></ul><strong>Returns:</strong><ul><li><code>Function</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">DomQuery</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.DomQuery-filter"></a><b><a href="source/DomQuery.html#method-Ext.DomQuery-filter">filter</a></b>(&nbsp;<code>Array&nbsp;el</code>,&nbsp;<code>String&nbsp;selector</code>,&nbsp;<code>Boolean&nbsp;nonMatches</code>&nbsp;)
  88     :
  89                                         Array<div class="mdesc"><div class="short">Filters an array of elements to only include matches of a simple selector (e.g. div.some-class or span:first-child)</div><div class="long">Filters an array of elements to only include matches of a simple selector (e.g. div.some-class or span:first-child)<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>el</code> : Array<div class="sub-desc">An array of elements to filter</div></li><li><code>selector</code> : String<div class="sub-desc">The simple selector to test</div></li><li><code>nonMatches</code> : Boolean<div class="sub-desc">If true, it returns the elements that DON'T match\r
  90 the selector instead of the ones that match</div></li></ul><strong>Returns:</strong><ul><li><code>Array</code><div class="sub-desc">An Array of DOM elements which match the selector. If there are&#13;
  91 no matches, and empty Array is returned.</div></li></ul></div></div></div></td><td class="msource">DomQuery</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.DomQuery-is"></a><b><a href="source/DomQuery.html#method-Ext.DomQuery-is">is</a></b>(&nbsp;<code>String/HTMLElement/Array&nbsp;el</code>,&nbsp;<code>String&nbsp;selector</code>&nbsp;)
  92     :
  93                                         Boolean<div class="mdesc"><div class="short">Returns true if the passed element(s) match the passed simple selector (e.g. div.some-class or span:first-child)</div><div class="long">Returns true if the passed element(s) match the passed simple selector (e.g. div.some-class or span:first-child)<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>el</code> : String/HTMLElement/Array<div class="sub-desc">An element id, element or array of elements</div></li><li><code>selector</code> : String<div class="sub-desc">The simple selector to test</div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">DomQuery</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.DomQuery-jsSelect"></a><b><a href="source/DomQuery.html#method-Ext.DomQuery-jsSelect">jsSelect</a></b>(&nbsp;<code>String&nbsp;selector</code>,&nbsp;<span title="Optional" class="optional">[<code>Node/String&nbsp;root</code>]</span>&nbsp;)
  94     :
  95                                         Array<div class="mdesc"><div class="short">Selects a group of elements.</div><div class="long">Selects a group of elements.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>selector</code> : String<div class="sub-desc">The selector/xpath query (can be a comma separated list of selectors)</div></li><li><code>root</code> : Node/String<div class="sub-desc">(optional) The start of the query (defaults to document).</div></li></ul><strong>Returns:</strong><ul><li><code>Array</code><div class="sub-desc">An Array of DOM elements which match the selector. If there are&#13;
  96 no matches, and empty Array is returned.</div></li></ul></div></div></div></td><td class="msource">DomQuery</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.DomQuery-operators"></a><b><a href="source/DomQuery.html#method-Ext.DomQuery-operators">operators</a></b>()
  97     :
  98                                         void<div class="mdesc"><div class="short">Collection of operator comparison functions. The default operators are =, !=, ^=, $=, *=, %=, |= and ~=.&#13;
  99 New operato...</div><div class="long">Collection of operator comparison functions. The default operators are =, !=, ^=, $=, *=, %=, |= and ~=.\r
 100 New operators can be added as long as the match the format <i>c</i>= where <i>c</i> is any character other than space, &gt; &lt;.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">DomQuery</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.DomQuery-selectNode"></a><b><a href="source/DomQuery.html#method-Ext.DomQuery-selectNode">selectNode</a></b>(&nbsp;<code>String&nbsp;selector</code>,&nbsp;<span title="Optional" class="optional">[<code>Node&nbsp;root</code>]</span>&nbsp;)
 101     :
 102                                         Element<div class="mdesc"><div class="short">Selects a single element.</div><div class="long">Selects a single element.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>selector</code> : String<div class="sub-desc">The selector/xpath query</div></li><li><code>root</code> : Node<div class="sub-desc">(optional) The start of the query (defaults to document).</div></li></ul><strong>Returns:</strong><ul><li><code>Element</code><div class="sub-desc">The DOM element which matched the selector.</div></li></ul></div></div></div></td><td class="msource">DomQuery</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.DomQuery-selectNumber"></a><b><a href="source/DomQuery.html#method-Ext.DomQuery-selectNumber">selectNumber</a></b>(&nbsp;<code>String&nbsp;selector</code>,&nbsp;<span title="Optional" class="optional">[<code>Node&nbsp;root</code>]</span>,&nbsp;<code>Number&nbsp;defaultValue</code>&nbsp;)
 103     :
 104                                         Number<div class="mdesc"><div class="short">Selects the value of a node, parsing integers and floats. Returns the defaultValue, or 0 if none is specified.</div><div class="long">Selects the value of a node, parsing integers and floats. Returns the defaultValue, or 0 if none is specified.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>selector</code> : String<div class="sub-desc">The selector/xpath query</div></li><li><code>root</code> : Node<div class="sub-desc">(optional) The start of the query (defaults to document).</div></li><li><code>defaultValue</code> : Number<div class="sub-desc"></div></li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">DomQuery</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.DomQuery-selectValue"></a><b><a href="source/DomQuery.html#method-Ext.DomQuery-selectValue">selectValue</a></b>(&nbsp;<code>String&nbsp;selector</code>,&nbsp;<span title="Optional" class="optional">[<code>Node&nbsp;root</code>]</span>,&nbsp;<code>String&nbsp;defaultValue</code>&nbsp;)
 105     :
 106                                         String<div class="mdesc"><div class="short">Selects the value of a node, optionally replacing null with the defaultValue.</div><div class="long">Selects the value of a node, optionally replacing null with the defaultValue.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>selector</code> : String<div class="sub-desc">The selector/xpath query</div></li><li><code>root</code> : Node<div class="sub-desc">(optional) The start of the query (defaults to document).</div></li><li><code>defaultValue</code> : String<div class="sub-desc"></div></li></ul><strong>Returns:</strong><ul><li><code>String</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">DomQuery</td></tr></tbody></table><a id="Ext.DomQuery-events"></a><h2>Public Events</h2><div class="no-members">This class has no public events.</div></div>