com.gargoylesoftware.htmlunit.javascript.host.dom

Class Node

java.lang.Object

net.sourceforge.htmlunit.corejs.javascript.ScriptableObject

com.gargoylesoftware.htmlunit.javascript.HtmlUnitScriptable

com.gargoylesoftware.htmlunit.javascript.SimpleScriptable

com.gargoylesoftware.htmlunit.javascript.host.event.EventTarget

com.gargoylesoftware.htmlunit.javascript.host.dom.Node

All Implemented Interfaces:

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

Direct Known Subclasses:

Attr, CharacterData, Document, DocumentFragment, DocumentType, Element

public class Node
extends EventTarget

The JavaScript object Node which is the base class for all DOM objects. This will typically wrap an instance of DomNode.

Author:

Mike Bowler, David K. Taylor, Barnaby Court, Christian Sell, George Murnock, Chris Erskine, Bruce Faulkner, Ahmed Ashour, Ronald Brill, Frank Danek

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class net.sourceforge.htmlunit.corejs.javascript.ScriptableObject

net.sourceforge.htmlunit.corejs.javascript.ScriptableObject.KeyComparator

Field Summary

Fields

Modifier and Type	Field and Description
static short	ATTRIBUTE_NODE
static short	CDATA_SECTION_NODE
static short	COMMENT_NODE
static short	DOCUMENT_FRAGMENT_NODE
static short	DOCUMENT_NODE
static short	DOCUMENT_POSITION_CONTAINED_BY
static short	DOCUMENT_POSITION_CONTAINS
static short	DOCUMENT_POSITION_DISCONNECTED
static short	DOCUMENT_POSITION_FOLLOWING
static short	DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC
static short	DOCUMENT_POSITION_PRECEDING
static short	DOCUMENT_TYPE_NODE
static short	ELEMENT_NODE
static short	ENTITY_NODE
static short	ENTITY_REFERENCE_NODE
static short	NOTATION_NODE
static short	PROCESSING_INSTRUCTION_NODE
static short	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

Constructors

Constructor and Description
Node() Creates an instance.

Method Summary

Modifier and Type	Method and Description
protected static void	after(net.sourceforge.htmlunit.corejs.javascript.Context context, net.sourceforge.htmlunit.corejs.javascript.Scriptable thisObj, Object[] args, net.sourceforge.htmlunit.corejs.javascript.Function function) Inserts a set of Node or DOMString objects in the children list of this ChildNode's parent, just after this ChildNode.
Object	appendChild(Object childObject) Adds a DOM node to the node.
protected net.sourceforge.htmlunit.corejs.javascript.RhinoException	asJavaScriptException(DOMException exception) Encapsulates the given DOMException into a Rhino-compatible exception.
protected static void	before(net.sourceforge.htmlunit.corejs.javascript.Context context, net.sourceforge.htmlunit.corejs.javascript.Scriptable thisObj, Object[] args, net.sourceforge.htmlunit.corejs.javascript.Function function) Inserts a set of Node or DOMString objects in the children list of this ChildNode's parent, just before this ChildNode.
Object	cloneNode(boolean deep) Clones this node.
short	compareDocumentPosition(Object node) Compares the positions of this node and the provided node within the document.
boolean	contains(Object element) Checks whether the given element is contained within this object.
Object	getAttributes() Returns the attributes of this XML element.
String	getBaseURI() Returns the Base URI as a string.
protected int	getChildElementCount() Returns the current number of child elements.
NodeList	getChildNodes() Returns the child nodes of the current element.
protected HTMLCollection	getChildren() Gets the children of the current node.
Node	getFirstChild() Gets the JavaScript property firstChild for the node that contains the current node.
protected Element	getFirstElementChild() Returns the first element child.
protected Node	getJavaScriptNode(DomNode domNode) Gets the JavaScript node for a given DomNode.
Node	getLastChild() Gets the JavaScript property lastChild for the node that contains the current node.
protected Element	getLastElementChild() Returns the last element child.
Object	getLocalName() Returns the local name of this attribute.
Object	getNamespaceURI() Returns the URI that identifies an XML namespace.
Node	getNextSibling() Gets the JavaScript property nextSibling for the node that contains the current node.
String	getNodeName() Gets the JavaScript property nodeName for the current node.
short	getNodeType() Gets the JavaScript property nodeType for the current node.
String	getNodeValue() Gets the JavaScript property nodeValue for the current node.
Object	getOwnerDocument() Returns the owner document.
Node	getParent() Returns this node's parent node.
Element	getParentElement() Gets the JavaScript property parentElement.
Object	getParentNode() Gets the JavaScript property parentNode for the node that contains the current node.
Object	getPrefix() Returns the namespace prefix.
Node	getPreviousSibling() Gets the JavaScript property previousSibling for the node that contains the current node.
String	getTextContent() Gets the textContent attribute.
boolean	hasAttributes() Returns true when the current element has any attributes or not.
boolean	hasChildNodes() Returns whether this node has any children.
static Object	insertBefore(net.sourceforge.htmlunit.corejs.javascript.Context context, net.sourceforge.htmlunit.corejs.javascript.Scriptable thisObj, Object[] args, net.sourceforge.htmlunit.corejs.javascript.Function function) Add a DOM node as a child to this node before the referenced node.
protected Object	insertBeforeImpl(Object[] args) Add a DOM node as a child to this node before the referenced node.
boolean	isSameNode(Object other) This method provides a way to determine whether two Node references returned by the implementation reference the same object.
void	normalize() Merges adjacent TextNode objects to produce a normalized document object model.
protected void	remove() Removes the DOM node from its parent.
Object	removeChild(Object childObject) Removes a DOM node from this node.
Object	replaceChild(Object newChildObject, Object oldChildObject) Replaces a child DOM node with another DOM node.
protected static void	replaceWith(net.sourceforge.htmlunit.corejs.javascript.Context context, net.sourceforge.htmlunit.corejs.javascript.Scriptable thisObj, Object[] args, net.sourceforge.htmlunit.corejs.javascript.Function function) Replaces this ChildNode in the children list of its parent with a set of Node or DOMString objects.
void	setNodeValue(String newValue) Sets the JavaScript property nodeValue for the current node.
void	setTextContent(Object value) Replace all children elements of this element with the supplied value.

Methods inherited from class com.gargoylesoftware.htmlunit.javascript.host.event.EventTarget

addEventListener, clearEventListenersContainer, dispatchEvent, executeEventLocally, fireEvent, getEventHandler, getEventListenersContainer, hasEventHandlers, isEventHandlerOnWindow, removeEventListener, setEventHandler

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

clone, equivalentValues, get, getBrowserVersion, getDefaultValue, getDomNodeOrDie, getDomNodeOrNull, getPrototype, getScriptableFor, getStartingScope, getWindow, getWindow, getWithPreemption, has, hasInstance, initParentScope, makeScriptableFor, setCaseSensitive, setDomNode, setDomNode, setHtmlElement

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

defineFunctionProperties, defineProperty, getClassName, put, setClassName, setParentScope

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, defineProperty, delete, delete, delete, deleteProperty, deleteProperty, ensureScriptable, ensureScriptableObject, ensureSymbolScriptable, get, get, get, getAllIds, getArrayPrototype, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getAttributes, getClassPrototype, getDefaultValue, getExternalArrayData, getExternalArrayLength, getFunctionPrototype, getGeneratorFunctionPrototype, getGetterOrSetter, getIds, getObjectPrototype, getOwnPropertyDescriptor, getParentScope, getProperty, getProperty, getProperty, getPropertyIds, getPrototype, getSlot, getTopLevelScope, getTopScopeValue, getTypedProperty, getTypedProperty, getTypeOf, has, has, hasProperty, hasProperty, hasProperty, isAccessorDescriptor, isConst, isDataDescriptor, isEmpty, isExtensible, isFalse, isGenericDescriptor, isGetterOrSetter, isReadOnlySettable, isSealed, isTrue, preventExtensions, put, put, putConst, putConstProperty, putProperty, putProperty, putProperty, redefineProperty, sameValue, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setAttributes, setExternalArrayData, setGetterOrSetter, setPrototype, size

Methods inherited from class java.lang.Object

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

Field Detail

ELEMENT_NODE

public static final short ELEMENT_NODE

See Also:

Node.ELEMENT_NODE, Constant Field Values

ATTRIBUTE_NODE

public static final short ATTRIBUTE_NODE

See Also:

Node.ATTRIBUTE_NODE, Constant Field Values

TEXT_NODE

public static final short TEXT_NODE

See Also:

Node.TEXT_NODE, Constant Field Values

CDATA_SECTION_NODE

public static final short CDATA_SECTION_NODE

See Also:

Node.CDATA_SECTION_NODE, Constant Field Values

ENTITY_REFERENCE_NODE

public static final short ENTITY_REFERENCE_NODE

See Also:

Node.ENTITY_REFERENCE_NODE, Constant Field Values

ENTITY_NODE

public static final short ENTITY_NODE

See Also:

Node.ENTITY_NODE, Constant Field Values

PROCESSING_INSTRUCTION_NODE

public static final short PROCESSING_INSTRUCTION_NODE

See Also:

Node.PROCESSING_INSTRUCTION_NODE, Constant Field Values

COMMENT_NODE

public static final short COMMENT_NODE

See Also:

Node.COMMENT_NODE, Constant Field Values

DOCUMENT_NODE

public static final short DOCUMENT_NODE

See Also:

Node.DOCUMENT_NODE, Constant Field Values

DOCUMENT_TYPE_NODE

public static final short DOCUMENT_TYPE_NODE

See Also:

Node.DOCUMENT_TYPE_NODE, Constant Field Values

DOCUMENT_FRAGMENT_NODE

public static final short DOCUMENT_FRAGMENT_NODE

See Also:

Node.DOCUMENT_FRAGMENT_NODE, Constant Field Values

NOTATION_NODE

public static final short NOTATION_NODE

See Also:

Node.NOTATION_NODE, Constant Field Values

DOCUMENT_POSITION_DISCONNECTED

public static final short DOCUMENT_POSITION_DISCONNECTED

See Also:

Node.DOCUMENT_POSITION_DISCONNECTED, Constant Field Values

DOCUMENT_POSITION_PRECEDING

public static final short DOCUMENT_POSITION_PRECEDING

See Also:

Node.DOCUMENT_POSITION_PRECEDING, Constant Field Values

DOCUMENT_POSITION_FOLLOWING

public static final short DOCUMENT_POSITION_FOLLOWING

See Also:

Node.DOCUMENT_POSITION_FOLLOWING, Constant Field Values

DOCUMENT_POSITION_CONTAINS

public static final short DOCUMENT_POSITION_CONTAINS

See Also:

Node.DOCUMENT_POSITION_CONTAINS, Constant Field Values

DOCUMENT_POSITION_CONTAINED_BY

public static final short DOCUMENT_POSITION_CONTAINED_BY

See Also:

Node.DOCUMENT_POSITION_CONTAINED_BY, Constant Field Values

DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

public static final short DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

See Also:

Node.DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, Constant Field Values

Constructor Detail

Node

public Node()

Creates an instance.

Method Detail

getNodeType

public short getNodeType()

Gets the JavaScript property nodeType for the current node.

Returns:

the node type

getNodeName

public String getNodeName()

Gets the JavaScript property nodeName for the current node.

Returns:

the node name

getNodeValue

public String getNodeValue()

Gets the JavaScript property nodeValue for the current node.

Returns:

the node value

setNodeValue

public void setNodeValue(String newValue)

Sets the JavaScript property nodeValue for the current node.

Parameters:

newValue - the new node value

appendChild

public Object appendChild(Object childObject)

Adds a DOM node to the node.

Parameters:

childObject - the node to add to this node

Returns:

the newly added child node

asJavaScriptException

protected net.sourceforge.htmlunit.corejs.javascript.RhinoException asJavaScriptException(DOMException exception)

Encapsulates the given DOMException into a Rhino-compatible exception.

Parameters:

exception - the exception to encapsulate

Returns:

the created exception

insertBefore

public static Object insertBefore(net.sourceforge.htmlunit.corejs.javascript.Context context,
                                  net.sourceforge.htmlunit.corejs.javascript.Scriptable thisObj,
                                  Object[] args,
                                  net.sourceforge.htmlunit.corejs.javascript.Function function)

Add a DOM node as a child to this node before the referenced node. If the referenced node is null, append to the end.

Parameters:

context - the JavaScript context

thisObj - the scriptable

args - the arguments passed into the method

function - the function

Returns:

the newly added child node

insertBeforeImpl

protected Object insertBeforeImpl(Object[] args)

Add a DOM node as a child to this node before the referenced node. If the referenced node is null, append to the end.

Parameters:

args - the arguments

Returns:

the newly added child node

remove

protected void remove()

Removes the DOM node from its parent.

See Also:

MDN documentation

removeChild

public Object removeChild(Object childObject)

Removes a DOM node from this node.

Parameters:

childObject - the node to remove from this node

Returns:

the removed child node

replaceChild

public Object replaceChild(Object newChildObject,
                           Object oldChildObject)

Replaces a child DOM node with another DOM node.

Parameters:

newChildObject - the node to add as a child of this node

oldChildObject - the node to remove as a child of this node

Returns:

the removed child node

cloneNode

public Object cloneNode(boolean deep)

Clones this node.

Parameters:

deep - if true, recursively clones all descendants

Returns:

the newly cloned node

isSameNode

public boolean isSameNode(Object other)

This method provides a way to determine whether two Node references returned by the implementation reference the same object. When two Node references are references to the same object, even if through a proxy, the references may be used completely interchangeably, such that all attributes have the same values and calling the same DOM method on either reference always has exactly the same effect.

Parameters:

other - the node to test against

Returns:

whether this node is the same node as the given one

hasChildNodes

public boolean hasChildNodes()

Returns whether this node has any children.

Returns:

boolean true if this node has any children, false otherwise

getChildNodes

public NodeList getChildNodes()

Returns the child nodes of the current element.

Returns:

the child nodes of the current element

getParent

public final Node getParent()

Returns this node's parent node.

Returns:

this node's parent node

getParentNode

public Object getParentNode()

Gets the JavaScript property parentNode for the node that contains the current node.

Returns:

the parent node

getNextSibling

public Node getNextSibling()

Gets the JavaScript property nextSibling for the node that contains the current node.

Returns:

the next sibling node or null if the current node has no next sibling.

getPreviousSibling

public Node getPreviousSibling()

Gets the JavaScript property previousSibling for the node that contains the current node.

Returns:

the previous sibling node or null if the current node has no previous sibling.

getFirstChild

public Node getFirstChild()

Gets the JavaScript property firstChild for the node that contains the current node.

Returns:

the first child node or null if the current node has no children.

getLastChild

public Node getLastChild()

Gets the JavaScript property lastChild for the node that contains the current node.

Returns:

the last child node or null if the current node has no children.

getJavaScriptNode

protected Node getJavaScriptNode(DomNode domNode)

Gets the JavaScript node for a given DomNode.

Parameters:

domNode - the DomNode

Returns:

the JavaScript node or null if the DomNode was null

getOwnerDocument

public Object getOwnerDocument()

Returns the owner document.

Returns:

the document

compareDocumentPosition

public short compareDocumentPosition(Object node)

Compares the positions of this node and the provided node within the document.

Parameters:

node - node object that specifies the node to check

Returns:

how the node is positioned relatively to the reference node.

See Also:

DOM level 3, Node.compareDocumentPosition(org.w3c.dom.Node)

normalize

public void normalize()

Merges adjacent TextNode objects to produce a normalized document object model.

getTextContent

public String getTextContent()

Gets the textContent attribute.

Returns:

the contents of this node as text

setTextContent

public void setTextContent(Object value)

Replace all children elements of this element with the supplied value.

Parameters:

value - - the new value for the contents of this node

getParentElement

public Element getParentElement()

Gets the JavaScript property parentElement.

Returns:

the parent element

See Also:

getParentNode()

getAttributes

public Object getAttributes()

Returns the attributes of this XML element.

Returns:

the attributes of this XML element

See Also:

Gecko DOM Reference

contains

public boolean contains(Object element)

Checks whether the given element is contained within this object.

Parameters:

element - element object that specifies the element to check

Returns:

true if the element is contained within this object

getBaseURI

public String getBaseURI()

Returns the Base URI as a string.

Returns:

the Base URI as a string

hasAttributes

public boolean hasAttributes()

Returns true when the current element has any attributes or not.

Returns:

true if an attribute is specified on this element

getPrefix

public Object getPrefix()

Returns the namespace prefix.

Returns:

the namespace prefix

getLocalName

public Object getLocalName()

Returns the local name of this attribute.

Returns:

the local name of this attribute

getNamespaceURI

public Object getNamespaceURI()

Returns the URI that identifies an XML namespace.

Returns:

the URI that identifies an XML namespace

getChildElementCount

protected int getChildElementCount()

Returns the current number of child elements.

Returns:

the child element count

getFirstElementChild

protected Element getFirstElementChild()

Returns the first element child.

Returns:

the first element child

getLastElementChild

protected Element getLastElementChild()

Returns the last element child.

Returns:

the last element child

getChildren

protected HTMLCollection getChildren()

Gets the children of the current node.

Returns:

the child at the given position

See Also:

MSDN documentation

after

protected static void after(net.sourceforge.htmlunit.corejs.javascript.Context context,
                            net.sourceforge.htmlunit.corejs.javascript.Scriptable thisObj,
                            Object[] args,
                            net.sourceforge.htmlunit.corejs.javascript.Function function)

Inserts a set of Node or DOMString objects in the children list of this ChildNode's parent, just after this ChildNode.

Parameters:

context - the context

thisObj - this object

args - the arguments

function - the function

before

protected static void before(net.sourceforge.htmlunit.corejs.javascript.Context context,
                             net.sourceforge.htmlunit.corejs.javascript.Scriptable thisObj,
                             Object[] args,
                             net.sourceforge.htmlunit.corejs.javascript.Function function)

Inserts a set of Node or DOMString objects in the children list of this ChildNode's parent, just before this ChildNode.

Parameters:

context - the context

thisObj - this object

args - the arguments

function - the function

replaceWith

protected static void replaceWith(net.sourceforge.htmlunit.corejs.javascript.Context context,
                                  net.sourceforge.htmlunit.corejs.javascript.Scriptable thisObj,
                                  Object[] args,
                                  net.sourceforge.htmlunit.corejs.javascript.Function function)

Replaces this ChildNode in the children list of its parent with a set of Node or DOMString objects.

Parameters:

context - the context

thisObj - this object

args - the arguments

function - the function