com.gargoylesoftware.htmlunit.javascript.host

Class Node

java.lang.Object

org.mozilla.javascript.ScriptableObject

com.gargoylesoftware.htmlunit.javascript.SimpleScriptable

com.gargoylesoftware.htmlunit.javascript.host.Node

All Implemented Interfaces:

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

Direct Known Subclasses:

CharacterDataImpl, Document, DocumentFragment, Element, XMLElement

public class Node
extends SimpleScriptable

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

Version:

$Revision: 2157 $

Author:

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

See Also:

Serialized Form

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_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 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
Node() Create an instance.

Method Summary

Methods

Modifier and Type	Method and Description
ScriptResult	executeEvent(Event event) Execute the event on this object only (needed for instance for onload on (i)frame tags)
ScriptResult	fireEvent(Event event) Fires the event on the node with capturing and bubbling phase
org.mozilla.javascript.Function	getEventHandler(String eventName) Gets an event handler
protected Object	getEventHandlerProp(String eventName) Gets the property defined as event handler (not necessary a Function if something else has been set)
protected Object	getJavaScriptNode(DomNode domNode) Get the JavaScript node for a given DomNode
void	jsxFunction_addEventListener(String type, org.mozilla.javascript.Function listener, boolean useCapture) Allows the registration of event listeners on the event target.
Object	jsxFunction_appendChild(Object childObject) Add a DOM node to the node
boolean	jsxFunction_attachEvent(String type, org.mozilla.javascript.Function listener) Allows the registration of event listeners on the event target.
Object	jsxFunction_cloneNode(boolean deep) Duplicate an XML node
void	jsxFunction_detachEvent(String type, org.mozilla.javascript.Function listener) Allows the removal of event listeners on the event target.
boolean	jsxFunction_hasChildNodes() Returns whether this node has any children.
Object	jsxFunction_insertBefore(Object newChildObject, Object refChildObject) Add a DOM node as a child to this node before the referenced node.
boolean	jsxFunction_isSameNode(Object other) This method provides a way to determine whether two Node references returned by the implementation reference the same object.
Object	jsxFunction_removeChild(Object childObject) Remove a DOM node from this node
void	jsxFunction_removeEventListener(String type, org.mozilla.javascript.Function listener, boolean useCapture) Allows the removal of event listeners on the event target.
Object	jsxFunction_replaceChild(Object newChildObject, Object oldChildObject) Replaces a child DOM node with another DOM node.
Object	jsxGet_childNodes() Returns the child nodes of the current element.
Object	jsxGet_firstChild() Get the JavaScript property "firstChild" for the node that contains the current node.
Object	jsxGet_lastChild() Get the JavaScript property "lastChild" for the node that contains the current node.
Object	jsxGet_nextSibling() Get the JavaScript property "nextSibling" for the node that contains the current node.
String	jsxGet_nodeName() Get the JavaScript property "nodeName" for the current node.
short	jsxGet_nodeType() Get the JavaScript property "nodeType" for the current node.
String	jsxGet_nodeValue() Get the JavaScript property "nodeValue" for the current node.
Object	jsxGet_parentNode() Get the JavaScript property "parentNode" for the node that contains the current node.
Object	jsxGet_previousSibling() Get the JavaScript property "previousSibling" for the node that contains the current node.
void	jsxSet_nodeValue(String newValue) Set the JavaScript property "nodeValue" for the current node.
void	setEventHandler(String eventName, org.mozilla.javascript.Function eventHandler) Defines an event handler
protected void	setEventHandlerProp(String eventName, Object value) Defines an event handler (or maybe any other object)

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, getWithPreemption, makeScriptableFor, 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

Field Detail

ELEMENT_NODE

public static final short ELEMENT_NODE

See Also:

org.w3c.dom.Node#ELEMENT_NODE}., Constant Field Values

ATTRIBUTE_NODE

public static final short ATTRIBUTE_NODE

See Also:

org.w3c.dom.Node#ATTRIBUTE_NODE}., Constant Field Values

TEXT_NODE

public static final short TEXT_NODE

See Also:

org.w3c.dom.Node#TEXT_NODE}., Constant Field Values

CDATA_SECTION_NODE

public static final short CDATA_SECTION_NODE

See Also:

org.w3c.dom.Node#CDATA_SECTION_NODE}., Constant Field Values

ENTITY_REFERENCE_NODE

public static final short ENTITY_REFERENCE_NODE

See Also:

org.w3c.dom.Node#ENTITY_REFERENCE_NODE}., Constant Field Values

ENTITY_NODE

public static final short ENTITY_NODE

See Also:

org.w3c.dom.Node#ENTITY_NODE}., Constant Field Values

PROCESSING_INSTRUCTION_NODE

public static final short PROCESSING_INSTRUCTION_NODE

See Also:

org.w3c.dom.Node#PROCESSING_INSTRUCTION_NODE}., Constant Field Values

COMMENT_NODE

public static final short COMMENT_NODE

See Also:

org.w3c.dom.Node#COMMENT_NODE}., Constant Field Values

DOCUMENT_NODE

public static final short DOCUMENT_NODE

See Also:

org.w3c.dom.Node#DOCUMENT_NODE}., Constant Field Values

DOCUMENT_TYPE_NODE

public static final short DOCUMENT_TYPE_NODE

See Also:

org.w3c.dom.Node#DOCUMENT_TYPE_NODE}., Constant Field Values

DOCUMENT_FRAGMENT_NODE

public static final short DOCUMENT_FRAGMENT_NODE

See Also:

org.w3c.dom.Node#DOCUMENT_FRAGMENT_NODE}., Constant Field Values

NOTATION_NODE

public static final short NOTATION_NODE

See Also:

org.w3c.dom.Node#NOTATION_NODE}., Constant Field Values

Constructor Detail

Node

public Node()

Create an instance.

Method Detail

jsxGet_nodeType

public short jsxGet_nodeType()

Get the JavaScript property "nodeType" for the current node.

Returns:

The node type

jsxGet_nodeName

public String jsxGet_nodeName()

Get the JavaScript property "nodeName" for the current node.

Returns:

The node name

jsxGet_nodeValue

public String jsxGet_nodeValue()

Get the JavaScript property "nodeValue" for the current node.

Returns:

The node value

jsxSet_nodeValue

public void jsxSet_nodeValue(String newValue)

Set the JavaScript property "nodeValue" for the current node.

Parameters:

newValue - The new node value

jsxFunction_appendChild

public Object jsxFunction_appendChild(Object childObject)

Add a DOM node to the node

Parameters:

childObject - The node to add to this node

Returns:

The newly added child node.

jsxFunction_cloneNode

public Object jsxFunction_cloneNode(boolean deep)

Duplicate an XML node

Parameters:

deep - If true, recursively clone all descendants. Otherwise, just clone this node.

Returns:

The newly cloned node.

jsxFunction_insertBefore

public Object jsxFunction_insertBefore(Object newChildObject,
                              Object refChildObject)

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:

newChildObject - The node to add to this node

refChildObject - The node before which to add the new child

Returns:

The newly added child node.

jsxFunction_isSameNode

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

jsxFunction_removeChild

public Object jsxFunction_removeChild(Object childObject)

Remove a DOM node from this node

Parameters:

childObject - The node to remove from this node

Returns:

The removed child node.

jsxFunction_hasChildNodes

public boolean jsxFunction_hasChildNodes()

Returns whether this node has any children.

Returns:

boolean true if this node has any children, false otherwise.

jsxGet_childNodes

public Object jsxGet_childNodes()

Returns the child nodes of the current element.

Returns:

The child nodes of the current element.

jsxFunction_replaceChild

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

jsxGet_parentNode

public Object jsxGet_parentNode()

Get the JavaScript property "parentNode" for the node that contains the current node.

Returns:

The parent node

jsxGet_nextSibling

public Object jsxGet_nextSibling()

Get 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.

jsxGet_previousSibling

public Object jsxGet_previousSibling()

Get 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.

jsxGet_firstChild

public Object jsxGet_firstChild()

Get 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.

jsxGet_lastChild

public Object jsxGet_lastChild()

Get 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 Object getJavaScriptNode(DomNode domNode)

Get the JavaScript node for a given DomNode

Parameters:

domNode - The DomNode

Returns:

The JavaScript node or null if the DomNode was null.

jsxFunction_attachEvent

public boolean jsxFunction_attachEvent(String type,
                              org.mozilla.javascript.Function listener)

Allows the registration of event listeners on the event target.

Parameters:

type - the event type to listen for (like "onclick")

listener - the event listener

Returns:

true if the listener has been added

See Also:

MSDN documentation

jsxFunction_addEventListener

public void jsxFunction_addEventListener(String type,
                                org.mozilla.javascript.Function listener,
                                boolean useCapture)

Allows the registration of event listeners on the event target.

Parameters:

type - the event type to listen for (like "click")

listener - the event listener

useCapture - If true, indicates that the user wishes to initiate capture

See Also:

Mozilla documentation

jsxFunction_detachEvent

public void jsxFunction_detachEvent(String type,
                           org.mozilla.javascript.Function listener)

Allows the removal of event listeners on the event target.

Parameters:

type - the event type to listen for (like "onclick")

listener - the event listener

See Also:

MSDN documentation

jsxFunction_removeEventListener

public void jsxFunction_removeEventListener(String type,
                                   org.mozilla.javascript.Function listener,
                                   boolean useCapture)

Allows the removal of event listeners on the event target.

Parameters:

type - the event type to listen for (like "click")

listener - the event listener

useCapture - If true, indicates that the user wishes to initiate capture (not yet implemented)

See Also:

Mozilla documentation

executeEvent

public ScriptResult executeEvent(Event event)

Execute the event on this object only (needed for instance for onload on (i)frame tags)

Parameters:

event - the event

Returns:

the result

fireEvent

public ScriptResult fireEvent(Event event)

Fires the event on the node with capturing and bubbling phase

Parameters:

event - the event

Returns:

the result

getEventHandler

public org.mozilla.javascript.Function getEventHandler(String eventName)

Gets an event handler

Parameters:

eventName - the event name (ex: "onclick")

Returns:

the handler function, null if the property is null or not a function

setEventHandler

public void setEventHandler(String eventName,
                   org.mozilla.javascript.Function eventHandler)

Defines an event handler

Parameters:

eventName - the event name (like "onclick")

eventHandler - the handler (null to reset it)

setEventHandlerProp

protected void setEventHandlerProp(String eventName,
                       Object value)

Defines an event handler (or maybe any other object)

Parameters:

eventName - the event name (like "onclick")

value - the property (null to reset it)

getEventHandlerProp

protected Object getEventHandlerProp(String eventName)

Gets the property defined as event handler (not necessary a Function if something else has been set)

Parameters:

eventName - the event name (like "onclick")

Returns:

the property