| java.lang.Object com.gwtext.client.core.DomQuery
DomQuery | public class DomQuery (Code) | | 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:
- * 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"
|
Inner Class :public static class SelectorType | |
Field Summary | |
public static SelectorType | SELECT | public static SelectorType | SIMPLE |
Method Summary | |
public static DomQueryFunction | compile(String selector) Compiles a selector/xpath query into a reusable function. | public static DomQueryFunction | compile(String selector, SelectorType type) Compiles a selector/xpath query into a reusable function. | public static Element[] | filter(Element[] els, String selector, boolean nonMatches) Filters an array of elements to only include matches of a simple selector (e.g. | native public static boolean | is(String id, String selector) Returns true if the passed element match the passed simple selector (e.g. | native public static boolean | is(Element el, String selector) Returns true if the passed element match the passed simple selector (e.g. | public static boolean | is(Element[] els, String selector) Returns true if the passed elements match the passed simple selector (e.g. | public static Element[] | select(String selector) Selects a group of elements. | public static Element[] | select(String selector, Element root) Selects a group of elements. | native public static Element | selectNode(String selector) Selects a single element. | native public static Element | selectNode(String selector, Element root) Selects a single element.
Parameters: selector - the selector/xpath query Parameters: root - the start of the query (defaults to document). | native public static float | selectNumber(String selector) Selects the value of a node, parsing integers and floats. | native public static float | selectNumber(String selector, Element root) Selects the value of a node, parsing integers and floats. | native public static String | selectValue(String selector) Selects the value of a node. | native public static String | selectValue(String selector, Element root) | native public static String | selectValue(String selector, Element root, String defaultValue) |
SELECT | public static SelectorType SELECT(Code) | | |
SIMPLE | public static SelectorType SIMPLE(Code) | | |
compile | public static DomQueryFunction compile(String selector)(Code) | | 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 - the selector/xpath query the reusable dom query function |
compile | public static DomQueryFunction compile(String selector, SelectorType type)(Code) | | 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 - the selector/xpath query Parameters: type - either DomQuery.SELECT (the default) or DomQuery.SIMPLE for a simple selector match the reusable dom query function |
filter | public static Element[] filter(Element[] els, String selector, boolean nonMatches)(Code) | | Filters an array of elements to only include matches of a simple selector (e.g. div.some-class or span:first-child).
Parameters: els - an array of elements to filter Parameters: selector - the simple selector to test Parameters: nonMatches - if true, it returns the elements that DON'T match the selector instead of the ones that match filtered element array |
is | native public static boolean is(String id, String selector)(Code) | | Returns true if the passed element match the passed simple selector (e.g. div.some-class or span:first-child).
Parameters: id - the element id Parameters: selector - the simple selector to test true if matched |
is | native public static boolean is(Element el, String selector)(Code) | | Returns true if the passed element match the passed simple selector (e.g. div.some-class or span:first-child).
Parameters: el - the element Parameters: selector - the simple selector to test true if matched |
is | public static boolean is(Element[] els, String selector)(Code) | | Returns true if the passed elements match the passed simple selector (e.g. div.some-class or span:first-child).
Parameters: els - the element array Parameters: selector - the simple selector to test true if matched |
select | public static Element[] select(String selector)(Code) | | Selects a group of elements.
Parameters: selector - the selector/xpath query (can be a comma separated list of selectors) array of selected elements |
select | public static Element[] select(String selector, Element root)(Code) | | Selects a group of elements.
Parameters: selector - the selector/xpath query (can be a comma separated list of selectors) Parameters: root - the start of the query (defaults to document) array of selected elements |
selectNode | native public static Element selectNode(String selector)(Code) | | Selects a single element.
Parameters: selector - the selector/xpath query the selected element |
selectNode | native public static Element selectNode(String selector, Element root)(Code) | | Selects a single element.
Parameters: selector - the selector/xpath query Parameters: root - the start of the query (defaults to document). the selected element |
selectNumber | native public static float selectNumber(String selector)(Code) | | Selects the value of a node, parsing integers and floats.
Parameters: selector - the selector/xpath query the node value |
selectNumber | native public static float selectNumber(String selector, Element root)(Code) | | Selects the value of a node, parsing integers and floats.
Parameters: selector - the selector/xpath query Parameters: root - the start of the query (defaults to document) the node value |
selectValue | native public static String selectValue(String selector)(Code) | | Selects the value of a node.
Parameters: selector - the selector/xpath query the node value |
selectValue | native public static String selectValue(String selector, Element root)(Code) | | Selects the value of a node
Parameters: selector - the selector/xpath query Parameters: root - the start of the query (defaults to document) the node value |
selectValue | native public static String selectValue(String selector, Element root, String defaultValue)(Code) | | Selects the value of a node, optionally replacing null with the defaultValue
Parameters: selector - the selector/xpath query Parameters: root - the start of the query (defaults to document) Parameters: defaultValue - value returned if null the node value |
|
|