- <div class="body-wrap">
- <div class="top-tools">
- <a class="inner-link" href="#Ext.DomQuery-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
- <a class="inner-link" href="#Ext.DomQuery-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
- <a class="inner-link" href="#Ext.DomQuery-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
- <a class="bookmark" href="../docs/?class=Ext.DomQuery"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
- </div>
- <h1>Class Ext.DomQuery</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"><a href="../src/DomQuery.js" target="_blank">DomQuery.js</a></td></tr>
- <tr><td class="label">Class:</td><td class="hd-info">DomQuery</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
+<div class="body-wrap" xmlns:ext="http://www.extjs.com"><div class="top-tools"><a class="inner-link" href="#Ext.DomQuery-props"><img src="resources/images/default/s.gif" class="item-icon icon-prop">Properties</a> <a class="inner-link" href="#Ext.DomQuery-methods"><img src="resources/images/default/s.gif" class="item-icon icon-method">Methods</a> <a class="inner-link" href="#Ext.DomQuery-events"><img src="resources/images/default/s.gif" class="item-icon icon-event">Events</a> <a class="bookmark" href="../docs/?class=Ext.DomQuery"><img src="resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a> </div><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
<p>\r
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
\r
<li> <b>E ~ F</b> all elements with the tag F that are preceded by a sibling element with the tag E</li>\r
</ul>\r
<h4>Attribute Selectors:</h4>\r
-<p>The use of @ and quotes are optional. For example, div[@foo='bar'] is also a valid attribute selector.</p>\r
+<p>The use of @ and quotes are optional. For example, div[@foo='bar'] is also a valid attribute selector.</p>\r
<ul class="list">\r
<li> <b>E[foo]</b> has an attribute "foo"</li>\r
<li> <b>E[foo=bar]</b> has an attribute "foo" that equals "bar"</li>\r
<li> <b>E{display*=none}</b> css value "display" that contains the substring "none"</li>\r
<li> <b>E{display%=2}</b> css value "display" that is evenly divisible by 2</li>\r
<li> <b>E{display!=none}</b> css value "display" that does not equal "none"</li>\r
-</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">
- <tr>
- <th class="sig-header" colspan="2">Property</th>
- <th class="msource-header">Defined By</th>
- </tr>
- <tr class="property-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.DomQuery-matchers"></a>\r
- <b>matchers</b> : Object <div class="mdesc">\r
- Collection of matching regular expressions and code snippets. </div>\r
- </td>\r
- <td class="msource">DomQuery</td>\r
- </tr>\r
- <tr class="property-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.DomQuery-operators"></a>\r
- <b>operators</b> : Object <div class="mdesc">\r
- <div class="short">Collection of operator comparison functions. The default operators are =, !=, ^=, $=, *=, %=, |= and ~=.
-New operator...</div>\r
- <div class="long">\r
- Collection of operator comparison functions. The default operators are =, !=, ^=, $=, *=, %=, |= and ~=.
-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, > <. </div>\r
- </div>\r
- </td>\r
- <td class="msource">DomQuery</td>\r
- </tr>\r
- <tr class="property-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.DomQuery-pseudos"></a>\r
- <b>pseudos</b> : Object <div class="mdesc">\r
- <div class="short">Collection of "pseudo class" processors. Each processor is passed the current nodeset (array)
-and the argument (if an...</div>\r
- <div class="long">\r
- Collection of "pseudo class" processors. Each processor is passed the current nodeset (array)
-and the argument (if any) supplied in the selector. </div>\r
- </div>\r
- </td>\r
- <td class="msource">DomQuery</td>\r
- </tr>\r
- </table>
- <a id="Ext.DomQuery-methods"></a>
- <h2>Public Methods</h2>
- <table cellspacing="0" class="member-table">
- <tr>
- <th class="sig-header" colspan="2">Method</th>
- <th class="msource-header">Defined By</th>
- </tr>
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.DomQuery-compile"></a>\r
- <b>compile</b>( <code>String selector</code>, <span class="optional" title="Optional">[<code>String type</code>]</span> ) : Function <div class="mdesc">\r
- <div class="short">Compiles a selector/xpath query into a reusable function. The returned function
-takes one parameter "root" (optional)...</div>\r
- <div class="long">\r
- Compiles a selector/xpath query into a reusable function. The returned function
-takes one parameter "root" (optional), which is the context node from where the query should start. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <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>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Function</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">DomQuery</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.DomQuery-filter"></a>\r
- <b>filter</b>( <code>Array el</code>, <code>String selector</code>, <code>Boolean nonMatches</code> ) : Array <div class="mdesc">\r
- <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>\r
- <div class="long">\r
- 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">\r
- <strong>Parameters:</strong>\r
- <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
-the selector instead of the ones that match</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Array</code><div class="sub-desc">An Array of DOM elements which match the selector. If there are no matches, and empty Array is returned.</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">DomQuery</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.DomQuery-is"></a>\r
- <b>is</b>( <code>String/HTMLElement/Array el</code>, <code>String selector</code> ) : Boolean <div class="mdesc">\r
- <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>\r
- <div class="long">\r
- 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">\r
- <strong>Parameters:</strong>\r
- <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>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Boolean</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">DomQuery</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.DomQuery-select"></a>\r
- <b>select</b>( <code>String selector</code>, <span class="optional" title="Optional">[<code>Node root</code>]</span> ) : Array <div class="mdesc">\r
- <div class="short">Selects a group of elements.</div>\r
- <div class="long">\r
- Selects a group of elements. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <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<div class="sub-desc">(optional) The start of the query (defaults to document).</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Array</code><div class="sub-desc">An Array of DOM elements which match the selector. If there are no matches, and empty Array is returned.</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">DomQuery</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.DomQuery-selectNode"></a>\r
- <b>selectNode</b>( <code>String selector</code>, <span class="optional" title="Optional">[<code>Node root</code>]</span> ) : Element <div class="mdesc">\r
- <div class="short">Selects a single element.</div>\r
- <div class="long">\r
- Selects a single element. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <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>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Element</code><div class="sub-desc">The DOM element which matched the selector.</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">DomQuery</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.DomQuery-selectNumber"></a>\r
- <b>selectNumber</b>( <code>String selector</code>, <span class="optional" title="Optional">[<code>Node root</code>]</span>, <code>Number defaultValue</code> ) : Number <div class="mdesc">\r
- <div class="short">Selects the value of a node, parsing integers and floats. Returns the defaultValue, or 0 if none is specified.</div>\r
- <div class="long">\r
- Selects the value of a node, parsing integers and floats. Returns the defaultValue, or 0 if none is specified. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <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>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Number</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">DomQuery</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.DomQuery-selectValue"></a>\r
- <b>selectValue</b>( <code>String selector</code>, <span class="optional" title="Optional">[<code>Node root</code>]</span>, <code>String defaultValue</code> ) : String <div class="mdesc">\r
- <div class="short">Selects the value of a node, optionally replacing null with the defaultValue.</div>\r
- <div class="long">\r
- Selects the value of a node, optionally replacing null with the defaultValue. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <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>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>String</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">DomQuery</td>\r
- </tr>\r
- </table>
- <a id="Ext.DomQuery-events"></a>
- <h2>Public Events</h2>
- <div class="no-members">This class has no public events.</div>
- </div>
\ No newline at end of file
+</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 "><td class="micon"><a href="#expand" class="exi"> </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">Collection of matching regular expressions and code snippets.</div></td><td class="msource">DomQuery</td></tr><tr class="property-row expandable "><td class="micon"><a href="#expand" class="exi"> </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">Collection of "pseudo class" processors. Each processor is passed the current nodeset (array)
+and the argument (if a...</div><div class="long">Collection of "pseudo class" processors. Each processor is passed the current nodeset (array)\r
+and the argument (if any) supplied in the selector.</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"> </a></td><td class="sig"><a id="Ext.DomQuery-compile"></a><b><a href="source/DomQuery.html#method-Ext.DomQuery-compile">compile</a></b>( <code>String selector</code>, <span title="Optional" class="optional">[<code>String type</code>]</span> )
+ :
+ Function<div class="mdesc"><div class="short">Compiles a selector/xpath query into a reusable function. The returned function
+takes one parameter "root" (optional...</div><div class="long">Compiles a selector/xpath query into a reusable function. The returned function\r
+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"> </a></td><td class="sig"><a id="Ext.DomQuery-filter"></a><b><a href="source/DomQuery.html#method-Ext.DomQuery-filter">filter</a></b>( <code>Array el</code>, <code>String selector</code>, <code>Boolean nonMatches</code> )
+ :
+ 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
+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
+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"> </a></td><td class="sig"><a id="Ext.DomQuery-is"></a><b><a href="source/DomQuery.html#method-Ext.DomQuery-is">is</a></b>( <code>String/HTMLElement/Array el</code>, <code>String selector</code> )
+ :
+ 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"> </a></td><td class="sig"><a id="Ext.DomQuery-operators"></a><b><a href="source/DomQuery.html#method-Ext.DomQuery-operators">operators</a></b>()
+ :
+ void<div class="mdesc"><div class="short">Collection of operator comparison functions. The default operators are =, !=, ^=, $=, *=, %=, |= and ~=.
+New operato...</div><div class="long">Collection of operator comparison functions. The default operators are =, !=, ^=, $=, *=, %=, |= and ~=.\r
+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, > <.<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"> </a></td><td class="sig"><a id="Ext.DomQuery-select"></a><b><a href="source/DomQuery.html#method-Ext.DomQuery-select">select</a></b>( <code>String selector</code>, <span title="Optional" class="optional">[<code>Node root</code>]</span> )
+ :
+ 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<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
+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"> </a></td><td class="sig"><a id="Ext.DomQuery-selectNode"></a><b><a href="source/DomQuery.html#method-Ext.DomQuery-selectNode">selectNode</a></b>( <code>String selector</code>, <span title="Optional" class="optional">[<code>Node root</code>]</span> )
+ :
+ 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"> </a></td><td class="sig"><a id="Ext.DomQuery-selectNumber"></a><b><a href="source/DomQuery.html#method-Ext.DomQuery-selectNumber">selectNumber</a></b>( <code>String selector</code>, <span title="Optional" class="optional">[<code>Node root</code>]</span>, <code>Number defaultValue</code> )
+ :
+ 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"> </a></td><td class="sig"><a id="Ext.DomQuery-selectValue"></a><b><a href="source/DomQuery.html#method-Ext.DomQuery-selectValue">selectValue</a></b>( <code>String selector</code>, <span title="Optional" class="optional">[<code>Node root</code>]</span>, <code>String defaultValue</code> )
+ :
+ 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>
\ No newline at end of file