com.gargoylesoftware.htmlunit.javascript.host

Class XMLDocument

java.lang.Object

org.mozilla.javascript.ScriptableObject

com.gargoylesoftware.htmlunit.javascript.SimpleScriptable

com.gargoylesoftware.htmlunit.javascript.host.Node

com.gargoylesoftware.htmlunit.javascript.host.Document

com.gargoylesoftware.htmlunit.javascript.host.XMLDocument

All Implemented Interfaces:

Serializable, org.mozilla.javascript.ConstProperties, org.mozilla.javascript.debug.DebuggableObject, org.mozilla.javascript.Scriptable

public class XMLDocument
extends Document

A JavaScript object for XMLDocument.

Version:

$Revision: 2155 $

Author:

Ahmed Ashour

See Also:

Serialized Form

Field Summary

Fields inherited from class com.gargoylesoftware.htmlunit.javascript.host.Node

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Fields inherited from class org.mozilla.javascript.ScriptableObject

CONST, DONTENUM, EMPTY, PERMANENT, READONLY, UNINITIALIZED_CONST

Fields inherited from interface org.mozilla.javascript.Scriptable

NOT_FOUND

Constructor Summary

Constructors

Constructor and Description
XMLDocument() Creates a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
protected Object	getWithPreemption(String name) Calls to document.XYZ should first look at elements named XYZ before using standard functions.
Object	jsxFunction_getElementById(String id) Return the element with the specified id or null if that element could not be found
Object	jsxFunction_getElementsByTagName(String tagName) Returns all the descendant elements with the specified tag name.
boolean	jsxFunction_load(String xmlSrouce) Loads an XML document from the specified location.
boolean	jsxFunction_loadXML(String strXML) Loads an XML document using the supplied string
HTMLCollection	jsxFunction_selectNodes(String expression) Applies the specified xpath expression to this node's context and returns the generated list of matching nodes.
Object	jsxFunction_selectSingleNode(String expression) Applies the specified pattern-matching operation to this node's context and returns the first matching node.
void	jsxFunction_setProperty(String name, String value) This method is used to set second-level properties on the DOM object.
boolean	jsxGet_async() Returns Whether or not to send the request to the server asynchronously.
Object	jsxGet_body() Returns Scriptable#NOT_FOUND Returns this document's body element.
SimpleScriptable	jsxGet_documentElement() Get the JavaScript property "documentElement" for the document.
XMLDOMParseError	jsxGet_parseError() Get the JavaScript property "parseError" for the document.
boolean	jsxGet_preserveWhiteSpace() Gets the current white space handling.
String	jsxGet_xml() Contains the XML representation of the node and all its descendants.
void	jsxSet_async(boolean async) Sets the async attribute.
void	jsxSet_preserveWhiteSpace(boolean preserveWhiteSpace) Specifies the white space handling.
SimpleScriptable	makeScriptableFor(DomNode domNode) Builds a new the javascript object that corresponds to the specified object.

Methods inherited from class com.gargoylesoftware.htmlunit.javascript.host.Document

getHtmlPage, getHtmlPageOrNull, jsConstructor, jsxFunction_close, jsxFunction_createAttribute, jsxFunction_createDocumentFragment, jsxFunction_createElement, jsxFunction_createElementNS, jsxFunction_createEvent, jsxFunction_createEventObject, jsxFunction_createNSResolver, jsxFunction_createRange, jsxFunction_createStyleSheet, jsxFunction_createTextNode, jsxFunction_elementFromPoint, jsxFunction_evaluate, jsxFunction_getBoxObjectFor, jsxFunction_getElementsByName, jsxFunction_open, jsxFunction_write, jsxFunction_writeln, jsxGet_all, jsxGet_anchors, jsxGet_cookie, jsxGet_defaultView, jsxGet_domain, jsxGet_forms, jsxGet_frames, jsxGet_images, jsxGet_implementation, jsxGet_links, jsxGet_location, jsxGet_parentWindow, jsxGet_readyState, jsxGet_referrer, jsxGet_scripts, jsxGet_styleSheets, jsxGet_title, jsxGet_URL, jsxSet_cookie, jsxSet_domain, jsxSet_location, jsxSet_title, write

Methods inherited from class com.gargoylesoftware.htmlunit.javascript.host.Node

executeEvent, fireEvent, getEventHandler, getEventHandlerProp, getJavaScriptNode, jsxFunction_addEventListener, jsxFunction_appendChild, jsxFunction_attachEvent, jsxFunction_cloneNode, jsxFunction_detachEvent, jsxFunction_hasChildNodes, jsxFunction_insertBefore, jsxFunction_isSameNode, jsxFunction_removeChild, jsxFunction_removeEventListener, jsxFunction_replaceChild, jsxGet_childNodes, jsxGet_firstChild, jsxGet_lastChild, jsxGet_nextSibling, jsxGet_nodeName, jsxGet_nodeType, jsxGet_nodeValue, jsxGet_parentNode, jsxGet_previousSibling, jsxSet_nodeValue, setEventHandler, setEventHandlerProp

Methods inherited from class com.gargoylesoftware.htmlunit.javascript.SimpleScriptable

get, getBooleanArg, getClassName, getDefaultValue, getDomNodeOrDie, getDomNodeOrNull, getIntArg, getLog, getObjectArg, getPrototype, getScriptableFor, getStartingScope, getStringArg, getTransformerScriptableFor, getWindow, getWindow, setDomNode, setDomNode, setHtmlElement

Methods inherited from class org.mozilla.javascript.ScriptableObject

associateValue, callMethod, callMethod, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineFunctionProperties, defineProperty, defineProperty, defineProperty, defineProperty, delete, delete, deleteProperty, deleteProperty, equivalentValues, get, getAllIds, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getClassPrototype, getDefaultValue, getFunctionPrototype, getGetterOrSetter, getIds, getObjectPrototype, getParentScope, getProperty, getProperty, getPropertyIds, getPrototype, getTopLevelScope, getTopScopeValue, has, has, hasInstance, hasProperty, hasProperty, isConst, isSealed, put, put, putConst, putConstProperty, putProperty, putProperty, redefineProperty, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setGetterOrSetter, setParentScope, setPrototype

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLDocument

public XMLDocument()

Creates a new instance. JavaScript objects must have a default constructor.

Method Detail

jsxSet_async

public void jsxSet_async(boolean async)

Sets the async attribute.

Parameters:

async - Whether or not to send the request to the server asynchronously.

jsxGet_async

public boolean jsxGet_async()

Returns Whether or not to send the request to the server asynchronously.

Returns:

the async attribute.

jsxFunction_load

public boolean jsxFunction_load(String xmlSrouce)

Loads an XML document from the specified location.

Parameters:

xmlSrouce - A string containing a URL that specifies the location of the XML file.

Returns:

true if the load succeeded; false if the load failed.

jsxFunction_loadXML

public boolean jsxFunction_loadXML(String strXML)

Loads an XML document using the supplied string

Parameters:

strXML - A string containing the XML string to load into this XML document object. This string can contain an entire XML document or a well-formed fragment.

Returns:

true if the load succeeded; false if the load failed.

getWithPreemption

protected Object getWithPreemption(String name)

Calls to document.XYZ should first look at elements named XYZ before using standard functions.

Called by SimpleScriptable.get(String, Scriptable) to allow retrieval of the property before the prototype chain is searched.

IMPORTANT: This method is invoked *very* often by Rhino. If you override this method, the implementation needs to be as fast as possible!

Overrides:

getWithPreemption in class Document

Parameters:

name - the property name

Returns:

Scriptable.NOT_FOUND if not found

makeScriptableFor

public SimpleScriptable makeScriptableFor(DomNode domNode)

Builds a new the javascript object that corresponds to the specified object.

Overrides:

makeScriptableFor in class SimpleScriptable

Parameters:

domNode - the dom node for which a JS object should be created

Returns:

The javascript object

jsxGet_documentElement

public SimpleScriptable jsxGet_documentElement()

Get the JavaScript property "documentElement" for the document.

Overrides:

jsxGet_documentElement in class Document

Returns:

The root node for the document.

jsxGet_parseError

public XMLDOMParseError jsxGet_parseError()

Get the JavaScript property "parseError" for the document.

Returns:

The ParserError object for the document.

jsxGet_xml

public String jsxGet_xml()

Contains the XML representation of the node and all its descendants.

Returns:

An XML representation of this node and all its descendants.

jsxGet_preserveWhiteSpace

public boolean jsxGet_preserveWhiteSpace()

Gets the current white space handling.

Returns:

the current white space handling.

jsxSet_preserveWhiteSpace

public void jsxSet_preserveWhiteSpace(boolean preserveWhiteSpace)

Specifies the white space handling.

Parameters:

preserveWhiteSpace - white space handling.

jsxFunction_setProperty

public void jsxFunction_setProperty(String name,
                           String value)

This method is used to set second-level properties on the DOM object.

Parameters:

name - The name of the property to be set.

value - The value of the specified property.

jsxFunction_selectNodes

public HTMLCollection jsxFunction_selectNodes(String expression)

Applies the specified xpath expression to this node's context and returns the generated list of matching nodes.

Parameters:

expression - A string specifying an XPath expression.

Returns:

list of the found elements.

jsxFunction_selectSingleNode

public Object jsxFunction_selectSingleNode(String expression)

Applies the specified pattern-matching operation to this node's context and returns the first matching node.

Parameters:

expression - A string specifying an XPath expression.

Returns:

the first node that matches the given pattern-matching operation. If no nodes match the expression, returns a null value.

jsxFunction_getElementsByTagName

public Object jsxFunction_getElementsByTagName(String tagName)

Returns all the descendant elements with the specified tag name.

Overrides:

jsxFunction_getElementsByTagName in class Document

Parameters:

tagName - the name to search for.

Returns:

all the descendant elements with the specified tag name.

jsxGet_body

public Object jsxGet_body()

Returns Scriptable#NOT_FOUND Returns this document's body element.

Overrides:

jsxGet_body in class Document

Returns:

this document's body element

jsxFunction_getElementById

public Object jsxFunction_getElementById(String id)

Return the element with the specified id or null if that element could not be found

Overrides:

jsxFunction_getElementById in class Document

Parameters:

id - The ID to search for

Returns:

the element or null