Print Friendly

Class Ext.DomQuery

Package:Ext
Class:DomQuery
Extends:Object
Defined In:DomQuery.js
* 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).

DomQuery supports most of the CSS3 selectors spec, along with some custom selectors and basic XPath.

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.

Element Selectors:

Attribute Selectors:

The use of @ and quotes are optional. For example, div[@foo='bar'] is also a valid attribute selector.

Pseudo Classes:

CSS Value Selectors:



This class is a singleton and cannot be created directly.

Properties   -  Methods   -  Events

Public Properties

Property Defined By
  matchers : Object DomQuery
Collection of matching regular expressions and code snippets.
  operators : Object DomQuery
Collection of operator comparison functions. The default operators are =, !=, ^=, $=, *=, %=, |= and ~=. New operator...
  pseudos : Object DomQuery
Collection of "pseudo class" processors. Each processor is passed the current nodeset (array) and the argument (if an...

Public Methods

Method Defined By
  compileString selector, [String type] ) : Function DomQuery
Compiles a selector/xpath query into a reusable function. The returned function takes one parameter "root" (optional)...
  filterArray el, String selector, Boolean nonMatches ) : Array DomQuery
Filters an array of elements to only include matches of a simple selector (e.g. div.some-class or span:first-child)
  isString/HTMLElement/Array el, String selector ) : Boolean DomQuery
Returns true if the passed element(s) match the passed simple selector (e.g. div.some-class or span:first-child)
  selectString selector, [Node root] ) : Array DomQuery
Selects a group of elements.
  selectNodeString selector, [Node root] ) : Element DomQuery
Selects a single element.
  selectNumberString selector, [Node root], Number defaultValue ) : Number DomQuery
Selects the value of a node, parsing integers and floats.
  selectValueString selector, [Node root], String defaultValue ) : void DomQuery
Selects the value of a node, optionally replacing null with the defaultValue.

Public Events

This class has no public events.

Property Details

matchers

public Object matchers
Collection of matching regular expressions and code snippets.
This property is defined by DomQuery.

operators

public Object operators
Collection of operator comparison functions. The default operators are =, !=, ^=, $=, *=, %=, |= and ~=. New operators can be added as long as the match the format c= where c is any character other than space, > <.
This property is defined by DomQuery.

pseudos

public Object pseudos
Collection of "pseudo class" processors. Each processor is passed the current nodeset (array) and the argument (if any) supplied in the selector.
This property is defined by DomQuery.

Method Details

compile

public function compile( String selector, [String type] )
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.
Parameters:
  • selector : String
    The selector/xpath query
  • type : String
    (optional) Either "select" (the default) or "simple" for a simple selector match
Returns:
  • Function
This method is defined by DomQuery.

filter

public function filter( Array el, String selector, Boolean nonMatches )
Filters an array of elements to only include matches of a simple selector (e.g. div.some-class or span:first-child)
Parameters:
  • el : Array
    An array of elements to filter
  • selector : String
    The simple selector to test
  • nonMatches : Boolean
    If true, it returns the elements that DON'T match the selector instead of the ones that match
Returns:
  • Array
This method is defined by DomQuery.

is

public function is( String/HTMLElement/Array el, String selector )
Returns true if the passed element(s) match the passed simple selector (e.g. div.some-class or span:first-child)
Parameters:
  • el : String/HTMLElement/Array
    An element id, element or array of elements
  • selector : String
    The simple selector to test
Returns:
  • Boolean
This method is defined by DomQuery.

select

public function select( String selector, [Node root] )
Selects a group of elements.
Parameters:
  • selector : String
    The selector/xpath query (can be a comma separated list of selectors)
  • root : Node
    (optional) The start of the query (defaults to document).
Returns:
  • Array
This method is defined by DomQuery.

selectNode

public function selectNode( String selector, [Node root] )
Selects a single element.
Parameters:
  • selector : String
    The selector/xpath query
  • root : Node
    (optional) The start of the query (defaults to document).
Returns:
  • Element
This method is defined by DomQuery.

selectNumber

public function selectNumber( String selector, [Node root], Number defaultValue )
Selects the value of a node, parsing integers and floats.
Parameters:
  • selector : String
    The selector/xpath query
  • root : Node
    (optional) The start of the query (defaults to document).
  • defaultValue : Number
Returns:
  • Number
This method is defined by DomQuery.

selectValue

public function selectValue( String selector, [Node root], String defaultValue )
Selects the value of a node, optionally replacing null with the defaultValue.
Parameters:
  • selector : String
    The selector/xpath query
  • root : Node
    (optional) The start of the query (defaults to document).
  • defaultValue : String
Returns:
  • void
This method is defined by DomQuery.

Ext - Copyright © 2006-2007 Ext JS, LLC
All rights reserved.