elemental.js.xpath

Class JsXPathEvaluator

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

elemental.js.util.JsElementalBase

elemental.js.dom.JsElementalMixinBase

elemental.js.xpath.JsXPathEvaluator

All Implemented Interfaces:

ElementalMixinBase, ElementTraversal, NodeSelector, EventTarget, ElementTimeControl, SVGExternalResourcesRequired, SVGFilterPrimitiveStandardAttributes, SVGFitToViewBox, SVGLangSpace, SVGLocatable, SVGStylable, SVGTests, SVGTransformable, SVGURIReference, SVGZoomAndPan, Indexable, IndexableInt, IndexableNumber, Mappable, Settable, SettableInt, SettableNumber, XPathEvaluator

public class JsXPathEvaluator
extends JsElementalMixinBase
implements XPathEvaluator

Field Summary

Fields inherited from interface elemental.svg.SVGZoomAndPan

SVG_ZOOMANDPAN_DISABLE, SVG_ZOOMANDPAN_MAGNIFY, SVG_ZOOMANDPAN_UNKNOWN

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JsXPathEvaluator()

Method Summary

Modifier and Type	Method and Description
JsXPathExpression	createExpression(String expression, XPathNSResolver resolver) Creates an nsIDOMXPathExpression which can then be used for (repeated) evaluations.
JsXPathNSResolver	createNSResolver(Node nodeResolver) Creates an nsIDOMXPathExpression which resolves name spaces with respect to the definitions in scope for a specified node.
JsXPathResult	evaluate(String expression, Node contextNode, XPathNSResolver resolver, int type, XPathResult inResult) Evaluate the specified XPath expression.

Methods inherited from class elemental.js.dom.JsElementalMixinBase

addEventListener, addEventListener, beginElement, beginElementAt, dispatchEvent, endElement, endElementAt, getAnimatedClassName, getAnimatedHeight, getAnimatedHref, getAnimatedResult, getAnimatedTransform, getAnimatedWidth, getAnimatedX, getAnimatedY, getBBox, getChildElementCount, getCTM, getExternalResourcesRequired, getFarthestViewportElement, getFirstElementChild, getLastElementChild, getNearestViewportElement, getNextElementSibling, getPresentationAttribute, getPreserveAspectRatio, getPreviousElementSibling, getRequiredExtensions, getRequiredFeatures, getScreenCTM, getSvgStyle, getSystemLanguage, getTransformToElement, getViewBox, getXmllang, getXmlspace, getZoomAndPan, hasExtension, querySelector, querySelectorAll, removeEventListener, removeEventListener, setXmllang, setXmlspace, setZoomAndPan

Methods inherited from class elemental.js.util.JsElementalBase

at, at, intAt, intAt, length, numberAt, numberAt, setAt, setAt, setAt, setAt, setAt, setAt

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface elemental.util.IndexableInt

intAt, length

Methods inherited from interface elemental.util.IndexableNumber

numberAt

Constructor Detail

JsXPathEvaluator

protected JsXPathEvaluator()

Method Detail

createExpression

public final JsXPathExpression createExpression(String expression,
                                                XPathNSResolver resolver)

Description copied from interface: XPathEvaluator

Creates an nsIDOMXPathExpression which can then be used for (repeated) evaluations.

Gecko 1.9 note

(Firefox 3)

Prior to Gecko 1.9, you could call this method on documents other than the one you planned to run the XPath against; starting with Gecko 1.9, however, you must call it on the same document.

Parameters

expression

A string representing the XPath to be created.

resolver

A name space resolver created by , or a user defined name space resolver. Read more on Implementing a User Defined Namespace Resolver if you wish to take the latter approach.

Return value

An XPath expression, as an nsIDOMXPathExpression object.

Specified by:

createExpression in interface XPathEvaluator

createNSResolver

public final JsXPathNSResolver createNSResolver(Node nodeResolver)

Description copied from interface: XPathEvaluator

Creates an nsIDOMXPathExpression which resolves name spaces with respect to the definitions in scope for a specified node. It is used to resolve prefixes within the XPath itself, so that they can be matched with the document. null is common for HTML documents or when no name space prefixes are used.

Parameters

nodeResolver

The node to be used as a context for name space resolution.

Return value

A name space resolver.

Specified by:

createNSResolver in interface XPathEvaluator

evaluate

public final JsXPathResult evaluate(String expression,
                                    Node contextNode,
                                    XPathNSResolver resolver,
                                    int type,
                                    XPathResult inResult)

Description copied from interface: XPathEvaluator

Evaluate the specified XPath expression.

Parameters

expression

A string representing the XPath to be evaluated.

contextNode

A DOM Node to evaluate the XPath expression against. To evaluate against a whole document, use the document.documentElement .

resolver

A name space resolver created by , or a user defined name space resolver. Read more on Implementing a User Defined Namespace Resolver if you wish to take the latter approach.

type

A number that corresponds to one of the type constants of nsIXPathResult .

result

An existing nsIXPathResult to use for the result. Using null will create a new nsIXPathResult .

Return value

An XPath result.

Specified by:

evaluate in interface XPathEvaluator