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).
\n\n\nDomQuery supports most of the CSS3 selectors spec, along with some custom selectors and basic XPath.
\n\n\n\n\n\nAll 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.\n
\n\n\nThe use of @ and quotes are optional. For example, div[@foo='bar'] is also a valid attribute selector.
\n\n\nCompiles a selector/xpath query into a reusable function. The returned function\ntakes one parameter \"root\" (optional), which is the context node from where the query should start.
\n", - "params": [ - { - "type": "String", - "name": "selector", - "doc": "The selector/xpath query
\n", - "optional": false + ], + "method": [ + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "DomQuery.html#Ext-DomQuery-method-compile", + "shortDoc": "Compiles a selector/xpath query into a reusable function. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/dom/DomQuery.js", + "private": false, + "params": [ + { + "type": "String", + "optional": false, + "doc": "The selector/xpath query
\n", + "name": "selector" + }, + { + "type": "String", + "optional": true, + "doc": "(optional) Either \"select\" (the default) or \"simple\" for a simple selector match
\n", + "name": "type" + } + ], + "name": "compile", + "owner": "Ext.DomQuery", + "doc": "Compiles a selector/xpath query into a reusable function. The returned function\ntakes one parameter \"root\" (optional), which is the context node from where the query should start.
\n", + "linenr": 431, + "return": { + "type": "Function", + "doc": "\n" }, - { - "type": "String", - "name": "type", - "doc": "(optional) Either \"select\" (the default) or \"simple\" for a simple selector match
\n", - "optional": true - } - ], - "return": { - "type": "Function", - "doc": "\n" + "html_filename": "DomQuery.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/dom/DomQuery.js", - "linenr": 431, - "html_filename": "DomQuery.html", - "href": "DomQuery.html#Ext-DomQuery-method-compile", - "shortDoc": "Compiles a selector/xpath query into a reusable function. The returned function\ntakes one parameter \"root\" (optional)..." - }, - { - "tagname": "method", - "name": "filter", - "member": "Ext.DomQuery", - "doc": "Filters an array of elements to only include matches of a simple selector (e.g. div.some-class or span:first-child)
\n", - "params": [ - { + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "DomQuery.html#Ext-DomQuery-method-filter", + "shortDoc": "Filters an array of elements to only include matches of a simple selector (e.g. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/dom/DomQuery.js", + "private": false, + "params": [ + { + "type": "Array", + "optional": false, + "doc": "An array of elements to filter
\n", + "name": "el" + }, + { + "type": "String", + "optional": false, + "doc": "The simple selector to test
\n", + "name": "selector" + }, + { + "type": "Boolean", + "optional": false, + "doc": "If true, it returns the elements that DON'T match\nthe selector instead of the ones that match
\n", + "name": "nonMatches" + } + ], + "name": "filter", + "owner": "Ext.DomQuery", + "doc": "Filters an array of elements to only include matches of a simple selector (e.g. div.some-class or span:first-child)
\n", + "linenr": 672, + "return": { "type": "Array", - "name": "el", - "doc": "An array of elements to filter
\n", - "optional": false - }, - { - "type": "String", - "name": "selector", - "doc": "The simple selector to test
\n", - "optional": false + "doc": "An Array of DOM elements which match the selector. If there are\nno matches, and empty Array is returned.
\n" }, - { - "type": "Boolean", - "name": "nonMatches", - "doc": "If true, it returns the elements that DON'T match\nthe selector instead of the ones that match
\n", - "optional": false - } - ], - "return": { - "type": "Array", - "doc": "An Array of DOM elements which match the selector. If there are\nno matches, and empty Array is returned.
\n" + "html_filename": "DomQuery.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/dom/DomQuery.js", - "linenr": 672, - "html_filename": "DomQuery.html", - "href": "DomQuery.html#Ext-DomQuery-method-filter", - "shortDoc": "Filters an array of elements to only include matches of a simple selector (e.g. div.some-class or span:first-child)
\n" - }, - { - "tagname": "method", - "name": "is", - "member": "Ext.DomQuery", - "doc": "Returns true if the passed element(s) match the passed simple selector (e.g. div.some-class or span:first-child)
\n", - "params": [ - { - "type": "String/HTMLElement/Array", - "name": "el", - "doc": "An element id, element or array of elements
\n", - "optional": false + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "DomQuery.html#Ext-DomQuery-method-is", + "shortDoc": "Returns true if the passed element(s) match the passed simple selector (e.g. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/dom/DomQuery.js", + "private": false, + "params": [ + { + "type": "String/HTMLElement/Array", + "optional": false, + "doc": "An element id, element or array of elements
\n", + "name": "el" + }, + { + "type": "String", + "optional": false, + "doc": "The simple selector to test
\n", + "name": "selector" + } + ], + "name": "is", + "owner": "Ext.DomQuery", + "doc": "Returns true if the passed element(s) match the passed simple selector (e.g. div.some-class or span:first-child)
\n", + "linenr": 657, + "return": { + "type": "Boolean", + "doc": "\n" }, - { - "type": "String", - "name": "selector", - "doc": "The simple selector to test
\n", - "optional": false - } - ], - "return": { - "type": "Boolean", - "doc": "\n" + "html_filename": "DomQuery.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/dom/DomQuery.js", - "linenr": 657, - "html_filename": "DomQuery.html", - "href": "DomQuery.html#Ext-DomQuery-method-is", - "shortDoc": "Returns true if the passed element(s) match the passed simple selector (e.g. div.some-class or span:first-child)
\n" - }, - { - "tagname": "method", - "name": "jsSelect", - "member": "Ext.DomQuery", - "doc": "Selects an array of DOM nodes using JavaScript-only implementation.
\n\nUse select to take advantage of browsers built-in support for CSS selectors.
\n", - "params": [ - { - "type": "String", - "name": "selector", - "doc": "The selector/xpath query (can be a comma separated list of selectors)
\n", - "optional": false - }, - { - "type": "Node/String", - "name": "root", - "doc": "(optional) The start of the query (defaults to document).
\n", - "optional": true + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "DomQuery.html#Ext-DomQuery-method-jsSelect", + "shortDoc": "Selects an array of DOM nodes using JavaScript-only implementation. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/dom/DomQuery.js", + "private": false, + "params": [ + { + "type": "String", + "optional": false, + "doc": "The selector/xpath query (can be a comma separated list of selectors)
\n", + "name": "selector" + }, + { + "type": "Node/String", + "optional": true, + "doc": "(optional) The start of the query (defaults to document).
\n", + "name": "root" + }, + { + "type": "Object", + "optional": false, + "doc": "\n", + "name": "type" + } + ], + "name": "jsSelect", + "owner": "Ext.DomQuery", + "doc": "Selects an array of DOM nodes using JavaScript-only implementation.
\n\nUse select to take advantage of browsers built-in support for CSS selectors.
\n", + "linenr": 525, + "return": { + "type": "Array", + "doc": "An Array of DOM elements which match the selector. If there are\nno matches, and empty Array is returned.
\n" }, - { - "type": "Object", - "name": "type", - "doc": "\n", - "optional": false - } - ], - "return": { - "type": "Array", - "doc": "An Array of DOM elements which match the selector. If there are\nno matches, and empty Array is returned.
\n" + "html_filename": "DomQuery.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/dom/DomQuery.js", - "linenr": 525, - "html_filename": "DomQuery.html", - "href": "DomQuery.html#Ext-DomQuery-method-jsSelect", - "shortDoc": "Selects an array of DOM nodes using JavaScript-only implementation.\n\nUse select to take advantage of browsers built-i..." - }, - { - "tagname": "method", - "name": "select", - "member": "Ext.DomQuery", - "doc": "Selects an array of DOM nodes by CSS/XPath selector.
\n\nUses document.querySelectorAll if browser supports that, otherwise falls back to\njsSelect to do the work.
\n\nAliased as Ext.query.
\n", - "params": [ - { - "type": "String", - "name": "path", - "doc": "The selector/xpath query
\n", - "optional": false + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "DomQuery.html#Ext-DomQuery-method-select", + "shortDoc": "Selects an array of DOM nodes by CSS/XPath selector. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/dom/DomQuery.js", + "private": false, + "params": [ + { + "type": "String", + "optional": false, + "doc": "The selector/xpath query
\n", + "name": "path" + }, + { + "type": "Node", + "optional": true, + "doc": "(optional) The start of the query (defaults to document).
\n", + "name": "root" + } + ], + "name": "select", + "owner": "Ext.DomQuery", + "doc": "Selects an array of DOM nodes by CSS/XPath selector.
\n\nUses document.querySelectorAll if browser supports that, otherwise falls back to\njsSelect to do the work.
\n\nAliased as Ext.query.
\n", + "linenr": 580, + "return": { + "type": "Array", + "doc": "An array of DOM elements (not a NodeList as returned by querySelectorAll).\nEmpty array when no matches.
(optional) The start of the query (defaults to document).
\n", - "optional": true - } - ], - "return": { - "type": "Array", - "doc": "An array of DOM elements (not a NodeList as returned by querySelectorAll).\nEmpty array when no matches.
Selects a single element.
\n", - "params": [ - { - "type": "String", - "name": "selector", - "doc": "The selector/xpath query
\n", - "optional": false + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "DomQuery.html#Ext-DomQuery-method-selectNode", + "shortDoc": "Selects a single element. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/dom/DomQuery.js", + "private": false, + "params": [ + { + "type": "String", + "optional": false, + "doc": "The selector/xpath query
\n", + "name": "selector" + }, + { + "type": "Node", + "optional": true, + "doc": "(optional) The start of the query (defaults to document).
\n", + "name": "root" + } + ], + "name": "selectNode", + "owner": "Ext.DomQuery", + "doc": "Selects a single element.
\n", + "linenr": 610, + "return": { + "type": "Element", + "doc": "The DOM element which matched the selector.
\n" }, - { - "type": "Node", - "name": "root", - "doc": "(optional) The start of the query (defaults to document).
\n", - "optional": true - } - ], - "return": { - "type": "Element", - "doc": "The DOM element which matched the selector.
\n" + "html_filename": "DomQuery.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/dom/DomQuery.js", - "linenr": 610, - "html_filename": "DomQuery.html", - "href": "DomQuery.html#Ext-DomQuery-method-selectNode", - "shortDoc": "Selects a single element.
\n" - }, - { - "tagname": "method", - "name": "selectNumber", - "member": "Ext.DomQuery", - "doc": "Selects the value of a node, parsing integers and floats. Returns the defaultValue, or 0 if none is specified.
\n", - "params": [ - { - "type": "String", - "name": "selector", - "doc": "The selector/xpath query
\n", - "optional": false - }, - { - "type": "Node", - "name": "root", - "doc": "(optional) The start of the query (defaults to document).
\n", - "optional": true - }, - { + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "DomQuery.html#Ext-DomQuery-method-selectNumber", + "shortDoc": "Selects the value of a node, parsing integers and floats. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/dom/DomQuery.js", + "private": false, + "params": [ + { + "type": "String", + "optional": false, + "doc": "The selector/xpath query
\n", + "name": "selector" + }, + { + "type": "Node", + "optional": true, + "doc": "(optional) The start of the query (defaults to document).
\n", + "name": "root" + }, + { + "type": "Number", + "optional": false, + "doc": "\n", + "name": "defaultValue" + } + ], + "name": "selectNumber", + "owner": "Ext.DomQuery", + "doc": "Selects the value of a node, parsing integers and floats. Returns the defaultValue, or 0 if none is specified.
\n", + "linenr": 645, + "return": { "type": "Number", - "name": "defaultValue", - "doc": "\n", - "optional": false - } - ], - "return": { - "type": "Number", - "doc": "\n" + "doc": "\n" + }, + "html_filename": "DomQuery.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/dom/DomQuery.js", - "linenr": 645, - "html_filename": "DomQuery.html", - "href": "DomQuery.html#Ext-DomQuery-method-selectNumber", - "shortDoc": "Selects the value of a node, parsing integers and floats. Returns the defaultValue, or 0 if none is specified.
\n" - }, - { - "tagname": "method", - "name": "selectValue", - "member": "Ext.DomQuery", - "doc": "Selects the value of a node, optionally replacing null with the defaultValue.
\n", - "params": [ - { + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "DomQuery.html#Ext-DomQuery-method-selectValue", + "shortDoc": "Selects the value of a node, optionally replacing null with the defaultValue. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/dom/DomQuery.js", + "private": false, + "params": [ + { + "type": "String", + "optional": false, + "doc": "The selector/xpath query
\n", + "name": "selector" + }, + { + "type": "Node", + "optional": true, + "doc": "(optional) The start of the query (defaults to document).
\n", + "name": "root" + }, + { + "type": "String", + "optional": false, + "doc": "\n", + "name": "defaultValue" + } + ], + "name": "selectValue", + "owner": "Ext.DomQuery", + "doc": "Selects the value of a node, optionally replacing null with the defaultValue.
\n", + "linenr": 620, + "return": { "type": "String", - "name": "selector", - "doc": "The selector/xpath query
\n", - "optional": false - }, - { - "type": "Node", - "name": "root", - "doc": "(optional) The start of the query (defaults to document).
\n", - "optional": true + "doc": "\n" }, - { - "type": "String", - "name": "defaultValue", - "doc": "\n", - "optional": false - } - ], - "return": { - "type": "String", - "doc": "\n" + "html_filename": "DomQuery.html" + } + ], + "property": [ + { + "type": "Object", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "property", + "href": "DomQuery.html#Ext-DomQuery-property-matchers", + "shortDoc": "Collection of matching regular expressions and code snippets. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/dom/DomQuery.js", + "private": false, + "name": "matchers", + "owner": "Ext.DomQuery", + "doc": "Collection of matching regular expressions and code snippets.\nEach capture group within () will be replace the {} in the select\nstatement as specified by their index.
\n", + "linenr": 690, + "html_filename": "DomQuery.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/dom/DomQuery.js", - "linenr": 620, - "html_filename": "DomQuery.html", - "href": "DomQuery.html#Ext-DomQuery-method-selectValue", - "shortDoc": "Selects the value of a node, optionally replacing null with the defaultValue.
\n" - } - ], - "property": [ - { - "tagname": "property", - "name": "matchers", - "member": "Ext.DomQuery", - "type": "Object", - "doc": "Collection of matching regular expressions and code snippets.\nEach capture group within () will be replace the {} in the select\nstatement as specified by their index.
\n", - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/dom/DomQuery.js", - "linenr": 690, - "html_filename": "DomQuery.html", - "href": "DomQuery.html#Ext-DomQuery-property-matchers", - "shortDoc": "Collection of matching regular expressions and code snippets.\nEach capture group within () will be replace the {} in ..." - }, - { - "tagname": "property", - "name": "operators", - "member": "Ext.DomQuery", - "type": "Object", - "doc": "Collection of operator comparison functions. The default operators are =, !=, ^=, $=, *=, %=, |= and ~=.\nNew operators can be added as long as the match the format c= where c is any character other than space, > <.
\n", - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/dom/DomQuery.js", - "linenr": 713, - "html_filename": "DomQuery.html", - "href": "DomQuery.html#Ext-DomQuery-property-operators", - "shortDoc": "Collection of operator comparison functions. The default operators are =, !=, ^=, $=, *=, %=, |= and ~=.\nNew operator..." - }, - { - "tagname": "property", - "name": "pseudos", - "member": "Ext.DomQuery", - "type": "Object", - "doc": "Object hash of \"pseudo class\" filter functions which are used when filtering selections.\nEach function is passed two parameters:
\n\nc : Array\n An Array of DOM elements to filter.
v : String\n The argument (if any) supplied in the selector.
A filter function returns an Array of DOM elements which conform to the pseudo class.\nIn addition to the provided pseudo classes listed above such as first-child and nth-child,\ndevelopers may add additional, custom psuedo class filters to select elements according to application-specific requirements.
For example, to filter a elements to only return links to external resources:
Ext.DomQuery.pseudos.external = function(c, v){\n var r = [], ri = -1;\n for(var i = 0, ci; ci = c[i]; i++){\n // Include in result set only if it's a link to an external resource\n if(ci.hostname != location.hostname){\n r[++ri] = ci;\n }\n }\n return r;\n};\nThen external links could be gathered with the following statement:
\n\nvar externalLinks = Ext.select(\"a:external\");\nCollection of operator comparison functions. The default operators are =, !=, ^=, $=, *=, %=, |= and ~=.\nNew operators can be added as long as the match the format c= where c is any character other than space, > <.
\n", + "linenr": 713, + "html_filename": "DomQuery.html" + }, + { + "type": "Object", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "property", + "href": "DomQuery.html#Ext-DomQuery-property-pseudos", + "shortDoc": "Object hash of \"pseudo class\" filter functions which are used when filtering selections. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/dom/DomQuery.js", + "private": false, + "name": "pseudos", + "owner": "Ext.DomQuery", + "doc": "Object hash of \"pseudo class\" filter functions which are used when filtering selections.\nEach function is passed two parameters:
\n\nc : Array\n An Array of DOM elements to filter.
v : String\n The argument (if any) supplied in the selector.
A filter function returns an Array of DOM elements which conform to the pseudo class.\nIn addition to the provided pseudo classes listed above such as first-child and nth-child,\ndevelopers may add additional, custom psuedo class filters to select elements according to application-specific requirements.
For example, to filter a elements to only return links to external resources:
Ext.DomQuery.pseudos.external = function(c, v){\n var r = [], ri = -1;\n for(var i = 0, ci; ci = c[i]; i++){\n // Include in result set only if it's a link to an external resource\n if(ci.hostname != location.hostname){\n r[++ri] = ci;\n }\n }\n return r;\n};\nThen external links could be gathered with the following statement:
\n\nvar externalLinks = Ext.select(\"a:external\");\nProvides 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).
\n\n\nDomQuery supports most of the CSS3 selectors spec, along with some custom selectors and basic XPath.
\n\n\n\n\n\nAll 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.\n
\n\n\nThe use of @ and quotes are optional. For example, div[@foo='bar'] is also a valid attribute selector.
\n\n\n