com.sencha.gxt.core.client.dom

Class DomQuery

java.lang.Object

com.sencha.gxt.core.client.dom.DomQuery

public class DomQuery
extends Object

Provides high performance selector/xpath processing.

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:

• * any element
• E an element with the tag E
• E F All descendent elements of E that have the tag F
• E > F or E/F all direct children elements of E that have the tag F
• E + F all elements with the tag F that are immediately preceded by an element with the tag E
• E ~ F all elements with the tag F that are preceded by a sibling element with the tag E

Attribute Selectors:

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

• E[foo] has an attribute "foo"
• E[foo=bar] has an attribute "foo" that equals "bar"
• E[foo^=bar] has an attribute "foo" that starts with "bar"
• E[foo$=bar] has an attribute "foo" that ends with "bar"
• E[foo*=bar] has an attribute "foo" that contains the substring "bar"
• E[foo%=2] has an attribute "foo" that is evenly divisible by 2
• E[foo!=bar] has an attribute "foo" that does not equal "bar"

Pseudo Classes:

• E:first-child E is the first child of its parent
• E:last-child E is the last child of its parent
• E:nth-child(n) E is the nth child of its parent (1 based as per the spec)
• E:nth-child(odd) E is an odd child of its parent
• E:nth-child(even) E is an even child of its parent
• E:only-child E is the only child of its parent
• E:checked E is an element that is has a checked attribute that is true (e.g. a radio or checkbox)
• E:first the first E in the resultset
• E:last the last E in the resultset
• E:nth(n) the nth E in the resultset (1 based)
• E:odd shortcut for :nth-child(odd)
• E:even shortcut for :nth-child(even)
• E:contains(foo) E's innerHTML contains the substring "foo"
• E:nodeValue(foo) E contains a textNode with a nodeValue that equals "foo"
• E:not(S) an E element that does not match simple selector S
• E:has(S) an E element that has a descendent that matches simple selector S
• E:next(S) an E element whose next sibling matches simple selector S
• E:prev(S) an E element whose previous sibling matches simple selector S

CSS Value Selectors:

• E{display=none} css value "display" that equals "none"
• E{display^=none} css value "display" that starts with "none"
• E{display$=none} css value "display" that ends with "none"
• E{display*=none} css value "display" that contains the substring "none"
• E{display%=2} css value "display" that is evenly divisible by 2
• E{display!=none} css value "display" that does not equal "none"

Constructor Summary

Constructors

Constructor and Description
DomQuery()

Method Summary

Methods

Modifier and Type	Method and Description
static Element[]	filter(Element[] elems, String selector, boolean nonMatches) Filters an array of elements to only include matches of a simple selector (e.g.
static boolean	is(Element elem, String selector) Returns true if the passed element(s) match the passed simple selector (e.g.
static NodeList<Element>	select(String selector) Selects a group of elements using the document as the root node.
static NodeList<Element>	select(String selector, Element root) Selects a group of elements.
static Element	selectNode(String selector) Selects a single element using the document as the root node.
static Element	selectNode(String selector, Element root) Selects a single element using the given root node.
static String	selectValue(String selector, Element root) Selects the value of a node,
static String	selectValue(String selector, JavaScriptObject root) Selects the value of a node,

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DomQuery

public DomQuery()

Method Detail

filter

public static Element[] filter(Element[] elems,
               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:

elems - an array of elements

selector - the selector/xpath query

nonMatches - if true, it returns the elements that DON'T match the selector instead of the ones that match

Returns:

the matching elements

is

public static boolean is(Element elem,
         String selector)

Returns true if the passed element(s) match the passed simple selector (e.g. div.some-class or span:first-child).

Parameters:

elem - the element

selector - The selector/xpath query (can be a comma separated list of selectors)

Returns:

true if matches

select

public static NodeList<Element> select(String selector)

Selects a group of elements using the document as the root node.

Parameters:

selector - the selector/xpath query

Returns:

the matching elements

select

public static NodeList<Element> select(String selector,
                       Element root)

Selects a group of elements.

Parameters:

selector - the selector/xpath query

root - the start of the query

Returns:

the matching elements

selectNode

public static Element selectNode(String selector)

Selects a single element using the document as the root node.

Parameters:

selector - the selector/xpath query

Returns:

the matching element

selectNode

public static Element selectNode(String selector,
                 Element root)

Selects a single element using the given root node.

Parameters:

selector - the selector / xpath query

root - the start of the query

Returns:

the matching element

selectValue

public static String selectValue(String selector,
                 Element root)

Selects the value of a node,

Parameters:

selector - the selector/xpath query

root - the start of the query

Returns:

the value

selectValue

public static String selectValue(String selector,
                 JavaScriptObject root)

Selects the value of a node,

Parameters:

selector - the selector/xpath query

root - the start of the query

Returns:

the value