com.gargoylesoftware.htmlunit.javascript.host.xml
Class XMLDocument

java.lang.Object
  net.sourceforge.htmlunit.corejs.javascript.ScriptableObject
      com.gargoylesoftware.htmlunit.javascript.SimpleScriptable
          com.gargoylesoftware.htmlunit.javascript.host.Node
              com.gargoylesoftware.htmlunit.javascript.host.EventNode
                  com.gargoylesoftware.htmlunit.javascript.host.Document
                      com.gargoylesoftware.htmlunit.javascript.host.xml.XMLDocument

All Implemented Interfaces:

Serializable, Cloneable, net.sourceforge.htmlunit.corejs.javascript.ConstProperties, net.sourceforge.htmlunit.corejs.javascript.debug.DebuggableObject, net.sourceforge.htmlunit.corejs.javascript.Scriptable

public class XMLDocument
extends Document

A JavaScript object for XMLDocument.

Version:

$Revision: 7582 $

Author:

Ahmed Ashour, Marc Guillemot, Sudhan Moghe, Ronald Brill

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_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Fields inherited from class net.sourceforge.htmlunit.corejs.javascript.ScriptableObject

CONST, DONTENUM, EMPTY, PERMANENT, READONLY, UNINITIALIZED_CONST

Fields inherited from interface net.sourceforge.htmlunit.corejs.javascript.Scriptable

NOT_FOUND

Constructor Summary

XMLDocument()
Creates a new instance.

XMLDocument(WebWindow enclosingWindow)
Creates a new instance, with associated XmlPage.

Method Summary

Object	createCDATASection(String data) Creates a new createCDATASection.
Object	createNode(Object type, String name, Object namespaceURI) Creates a node using the supplied type, name, and namespace.
Object	createProcessingInstruction(String target, String data) Creates a new ProcessingInstruction.
boolean	getAsync() Returns Whether or not to send the request to the server asynchronously.
Object	getElementById(String id) Returns the element with the specified ID, as long as it is an HTML element; null otherwise.
HTMLCollection	getElementsByTagName(String tagName) Returns all the descendant elements with the specified tag name.
XMLDOMParseError	getParseError() Gets the JavaScript property "parseError" for the document.
boolean	getPreserveWhiteSpace() Gets the current white space handling.
String	getXml() Contains the XML representation of the node and all its descendants.
protected void	initParentScope(DomNode domNode, SimpleScriptable scriptable) Initialize the parent scope of a newly created scriptable.
boolean	load(String xmlSource) Loads an XML document from the specified location.
boolean	loadXML(String strXML) Loads an XML document using the supplied string.
SimpleScriptable	makeScriptableFor(DomNode domNode) Builds a new the JavaScript object that corresponds to the specified object.
Object	nodeFromID(String id) Since we are not processing DTD, this method always returns null.
HTMLCollection	selectNodes(String expression) Applies the specified XPath expression to this node's context and returns the generated list of matching nodes.
Object	selectSingleNode(String expression) Applies the specified pattern-matching operation to this node's context and returns the first matching node.
void	setAsync(boolean async) Sets the async attribute.
void	setPreserveWhiteSpace(boolean preserveWhiteSpace) Specifies the white space handling.
void	setProperty(String name, String value) This method is used to set second-level properties on the DOM object.

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

captureEvents, createAttribute, createComment, createDocumentFragment, createElement, createElementNS, createNSResolver, createTextNode, evaluate, getBoxObjectFor, getDefaultView, getDesignMode, getDoctype, getDocumentElement, getElementsByTagNameNS, getImplementation, getLocation, getPage, getReferrer, importNode, setDesignMode, setLocation, setWindow

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

fireEvent, getOnblur, getOnclick, getOncontextmenu, getOndblclick, getOnerror, getOnfocus, getOnfocusin, getOnfocusout, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getOnpropertychange, getOnresize, setOnblur, setOnclick, setOncontextmenu, setOndblclick, setOnerror, setOnfocus, setOnfocusin, setOnfocusout, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setOnpropertychange, setOnresize

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

addEventListener, appendChild, attachEvent, cloneNode, compareDocumentPosition, detachEvent, executeEvent, fireEvent, fireEvent, getAttributes, getChildNodes, getEventHandler, getEventHandlerProp, getFirstChild, getJavaScriptNode, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParent, getParentElement, getParentNode, getPrefix, getPreviousSibling, getTextContent, hasChildNodes, hasEventHandlers, insertBefore, insertBeforeImpl, isSameNode, normalize, removeChild, removeEventListener, replaceChild, setDomNode, setEventHandler, setEventHandlerProp, setNodeValue, setTextContent

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

clone, defineFunctionProperties, defineProperty, equivalentValues, get, getBrowserVersion, getClassName, getDefaultValue, getDomNodeOrDie, getDomNodeOrNull, getPrototype, getScriptableFor, getStartingScope, getTransformerScriptableFor, getWindow, getWindow, getWithPreemption, hasInstance, isReadOnlySettable, setCaseSensitive, setDomNode, setHtmlElement

Methods inherited from class net.sourceforge.htmlunit.corejs.javascript.ScriptableObject

applyDescriptorToAttributeBitset, associateValue, avoidObjectDetection, buildDataDescriptor, callMethod, callMethod, checkPropertyChange, checkPropertyDefinition, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineOwnProperties, defineOwnProperty, defineOwnProperty, defineProperty, defineProperty, defineProperty, delete, delete, deleteProperty, deleteProperty, ensureScriptable, ensureScriptableObject, get, get, getAllIds, getArrayPrototype, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getClassPrototype, getDefaultValue, getFunctionPrototype, getGetterOrSetter, getIds, getObjectPrototype, getOwnPropertyDescriptor, getParentScope, getProperty, getProperty, getPropertyIds, getPrototype, getSlot, getTopLevelScope, getTopScopeValue, getTypedProperty, getTypedProperty, getTypeOf, has, has, hasProperty, hasProperty, isAccessorDescriptor, isConst, isDataDescriptor, isEmpty, isExtensible, isFalse, isGenericDescriptor, isGetterOrSetter, isSealed, isTrue, preventExtensions, put, put, putConst, putConstProperty, putProperty, putProperty, redefineProperty, sameValue, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setGetterOrSetter, setParentScope, setPrototype, size

Methods inherited from class java.lang.Object

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.

XMLDocument

public XMLDocument(WebWindow enclosingWindow)

Creates a new instance, with associated XmlPage.

Parameters:

enclosingWindow - the window

Method Detail

setAsync

public void setAsync(boolean async)

Sets the async attribute.

Parameters:

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

getAsync

public boolean getAsync()

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

Returns:

the async attribute

load

public boolean load(String xmlSource)

Loads an XML document from the specified location.

Parameters:

xmlSource - a string containing a URL that specifies the location of the XML file

Returns:

true if the load succeeded; false if the load failed

loadXML

public boolean 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

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

initParentScope

protected void initParentScope(DomNode domNode,
                               SimpleScriptable scriptable)

Initialize the parent scope of a newly created scriptable.

Overrides:

initParentScope in class SimpleScriptable

Parameters:

domNode - the DOM node for the script object

scriptable - the script object to initialize

getParseError

public XMLDOMParseError getParseError()

Gets the JavaScript property "parseError" for the document.

Returns:

the ParserError object for the document

getXml

public String getXml()

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

Overrides:

getXml in class Node

Returns:

an XML representation of this node and all its descendants

getPreserveWhiteSpace

public boolean getPreserveWhiteSpace()

Gets the current white space handling.

Returns:

the current white space handling

setPreserveWhiteSpace

public void setPreserveWhiteSpace(boolean preserveWhiteSpace)

Specifies the white space handling.

Parameters:

preserveWhiteSpace - white space handling

setProperty

public void 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

selectNodes

public HTMLCollection 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

selectSingleNode

public Object 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.

getElementsByTagName

public HTMLCollection getElementsByTagName(String tagName)

Returns all the descendant elements with the specified tag name.

Overrides:

getElementsByTagName in class Document

Parameters:

tagName - the name to search for

Returns:

all the descendant elements with the specified tag name

getElementById

public Object getElementById(String id)

Returns the element with the specified ID, as long as it is an HTML element; null otherwise.

Parameters:

id - the ID to search for

Returns:

the element with the specified ID, as long as it is an HTML element; null otherwise

nodeFromID

public Object nodeFromID(String id)

Since we are not processing DTD, this method always returns null.

Parameters:

id - the ID to search for

Returns:

null

createProcessingInstruction

public Object createProcessingInstruction(String target,
                                          String data)

Creates a new ProcessingInstruction.

Parameters:

target - the target

data - the data

Returns:

the new ProcessingInstruction

createCDATASection

public Object createCDATASection(String data)

Creates a new createCDATASection.

Parameters:

data - the data

Returns:

the new CDATASection

createNode

public Object createNode(Object type,
                         String name,
                         Object namespaceURI)

Creates a node using the supplied type, name, and namespace.

Parameters:

type - a value that uniquely identifies the node type

name - the value for the new node's nodeName property

namespaceURI - A string defining the namespace URI. If specified, the node is created in the context of the namespaceURI parameter with the prefix specified on the node name. If the name parameter does not have a prefix, this is treated as the default namespace.

Returns:

the newly created node