Node (Aspose.HTML for Java (21.6) API Documentation)

java.lang.Object
- com.aspose.html.dom.DOMObject
- - com.aspose.html.dom.EventTarget
  - - com.aspose.html.dom.Node

All Implemented Interfaces:

IEventTarget, IXPathNSResolver, com.aspose.ms.System.IDisposable

Direct Known Subclasses:

Attr, com.aspose.html.dom.CharacterDataDOM, Document, DocumentFragment, DocumentType, Element, Entity, EntityReference, Notation
```
@DOMObjectAttribute
 @DOMNameAttribute(name="Node")
public abstract class Node
extends EventTarget
implements IXPathNSResolver
```
The Node interface is the primary datatype for the entire Document object Model. It represents a single node in the document tree.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Node.Flags

Nested Classes
Modifier and Type	Class and Description
`static class`	`Node.Flags`

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ATTRIBUTE_NODE` An attribute node
`static int`	`CDATA_SECTION_NODE` A cdata section node
`static int`	`COMMENT_NODE` A comment node
`static int`	`DOCUMENT_FRAGMENT_NODE` A document fragment node
`static int`	`DOCUMENT_NODE` A document node
`static int`	`DOCUMENT_TYPE_NODE` A document type node
`static int`	`ELEMENT_NODE` An element node
`static int`	`ENTITY_NODE` An entity node
`static int`	`ENTITY_REFERENCE_NODE` An entity reference node
`Node.Flags`	`flags`
`Document`	`nodeDocument`
`static int`	`NOTATION_NODE` A notation node
`protected Node`	`parent`
`static int`	`PROCESSING_INSTRUCTION_NODE` A processing instruction node
`static int`	`TEXT_NODE` A text node

Fields inherited from class com.aspose.html.dom.EventTarget
EventMap

Fields inherited from class com.aspose.html.dom.DOMObject
PropertyChanged, PropertyChangedDelegate

Constructor Summary

Constructors
Modifier Constructor and Description

protected Node(Document document)
Initializes a new instance of the Node class.

Constructors
Modifier	Constructor and Description
`protected`	`Node(Document document)` Initializes a new instance of the `Node` class.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`adoptNode(Node node, Document document)`
`Node`	`appendChild(Node node)` Adds the node newChild to the end of the list of children of this node.
`Node`	`cloneNode(boolean deep)` Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes.
`static Node`	`deepClone(Node node, Document document, boolean cloneChildren)`
`protected void`	`dispose(boolean disposing)` Releases unmanaged and - optionally - managed resources.
`protected void`	`finalize()` Finalizes an instance of the `Node` class.
`NamedNodeMap`	`getAttributes()` A NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise.
`java.lang.String`	`getBaseURI()` The absolute base URI of this node or null if the implementation wasn't able to obtain an absolute URI.
`NodeList`	`getChildNodes()` A NodeList that contains all children of this node.
`NodeList`	`getChildNodesInternal()`
`Node`	`getFirstChild()` The first child of this node.
`Node`	`getLastChild()` The last child of this node.
`java.lang.String`	`getLocalName()` Returns the local part of the qualified name of this node.
`java.lang.String`	`getNamespaceURI()` The namespace URI of this node, or null if it is unspecified.
`Node`	`getNextSibling()` The node immediately following this node.
`abstract java.lang.String`	`getNodeName()` The name of this node, depending on its type.
`abstract int`	`getNodeType()` A code representing the type of the underlying object.
`java.lang.String`	`getNodeValue()` The value of this node, depending on its type.
`Document`	`getOwnerDocument()` The Document object associated with this node.
`Element`	`getParentElement()` Gets the parent `Element` of this node.
`Node`	`getParentNode()` The parent of this node.
`java.lang.String`	`getPrefix()` The namespace prefix of this node, or null if it is unspecified.
`Node`	`getPreviousSibling()` The node immediately preceding this node.
`com.aspose.html.dom.mutations.collections.RegisteredObserverList`	`getRegisteredObservers()`
`java.lang.String`	`getTextContent()` This attribute returns the text content of this node and its descendants.
`boolean`	`hasAttributes()` Returns whether this node (if it is an element) has any attributes
`boolean`	`hasChildNodes()` Returns whether this node has any children.
`Node`	`insertBefore(Node node, Node child)` Inserts the node before the existing child node child.
`boolean`	`isDefaultNamespace(java.lang.String namespaceURI)` This method checks if the specified namespaceURI is the default namespace or not.
`boolean`	`isEqualNode(Node otherNode)` Tests whether two nodes are equal.
`boolean`	`isSameNode(Node otherNode)` Returns whether this node is the same node as the given one.
`java.lang.String`	`lookupNamespaceURI(java.lang.String prefix)` Look up the namespace URI associated to the given prefix, starting from this node.
`java.lang.String`	`lookupPrefix(java.lang.String namespaceURI)` Look up the prefix associated to the given namespace URI, starting from this node.
`void`	`normalize()` Puts all Text nodes in the full depth of the sub-tree underneath this Node, including attribute nodes, into a "normal" form where only structure (e.g., elements, comments, processing instructions, CDATA sections, and entity references) separates Text nodes, i.e., there are neither adjacent Text nodes nor empty Text nodes.
`Node`	`removeChild(Node child)` Removes the child node indicated by oldChild from the list of children, and returns it.
`static void`	`replaceAll(Node node, Node parent)`
`Node`	`replaceChild(Node node, Node child)` Replaces the child node oldChild with newChild in the list of children, and returns the oldChild node.
`protected void`	`setLocalName(java.lang.String value)` Returns the local part of the qualified name of this node.
`protected void`	`setNamespaceURI(java.lang.String value)` The namespace URI of this node, or null if it is unspecified.
`void`	`setNodeValue(java.lang.String value)` The value of this node, depending on its type.
`void`	`setParentNode(Node parent)`
`void`	`setPrefix(java.lang.String value)` The namespace prefix of this node, or null if it is unspecified.
`void`	`setTextContent(java.lang.String value)` This attribute returns the text content of this node and its descendants.
`java.lang.String`	`toString()` Returns a `String` that represents this instance.

Methods inherited from class com.aspose.html.dom.EventTarget
addEventListener, addEventListener, addEventListener, addEventListener, dispatchEvent, dispose, removeEventListener, removeEventListener, removeEventListener

Methods inherited from class com.aspose.html.dom.DOMObject
fireNotifyPropertyChanged, getCurrentValues, getRuntimesBinding, setCurrentValues, setField, setRuntimesBinding

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - ELEMENT_NODE
```
@DOMNameAttribute(name="ELEMENT_NODE")
public static final int ELEMENT_NODE
```
    An element node
    
    See Also:
    
    Constant Field Values
  - ATTRIBUTE_NODE
```
@DOMNameAttribute(name="ATTRIBUTE_NODE")
public static final int ATTRIBUTE_NODE
```
    An attribute node
    
    See Also:
    
    Constant Field Values
  - TEXT_NODE
```
@DOMNameAttribute(name="TEXT_NODE")
public static final int TEXT_NODE
```
    A text node
    
    See Also:
    
    Constant Field Values
  - CDATA_SECTION_NODE
```
@DOMNameAttribute(name="CDATA_SECTION_NODE")
public static final int CDATA_SECTION_NODE
```
    A cdata section node
    
    See Also:
    
    Constant Field Values
  - ENTITY_REFERENCE_NODE
```
@DOMNameAttribute(name="ENTITY_REFERENCE_NODE")
public static final int ENTITY_REFERENCE_NODE
```
    An entity reference node
    
    See Also:
    
    Constant Field Values
  - ENTITY_NODE
```
@DOMNameAttribute(name="ENTITY_NODE")
public static final int ENTITY_NODE
```
    An entity node
    
    See Also:
    
    Constant Field Values
  - PROCESSING_INSTRUCTION_NODE
```
@DOMNameAttribute(name="PROCESSING_INSTRUCTION_NODE")
public static final int PROCESSING_INSTRUCTION_NODE
```
    A processing instruction node
    
    See Also:
    
    Constant Field Values
  - COMMENT_NODE
```
@DOMNameAttribute(name="COMMENT_NODE")
public static final int COMMENT_NODE
```
    A comment node
    
    See Also:
    
    Constant Field Values
  - DOCUMENT_NODE
```
@DOMNameAttribute(name="DOCUMENT_NODE")
public static final int DOCUMENT_NODE
```
    A document node
    
    See Also:
    
    Constant Field Values
  - DOCUMENT_TYPE_NODE
```
@DOMNameAttribute(name="DOCUMENT_TYPE_NODE")
public static final int DOCUMENT_TYPE_NODE
```
    A document type node
    
    See Also:
    
    Constant Field Values
  - DOCUMENT_FRAGMENT_NODE
```
@DOMNameAttribute(name="DOCUMENT_FRAGMENT_NODE")
public static final int DOCUMENT_FRAGMENT_NODE
```
    A document fragment node
    
    See Also:
    
    Constant Field Values
  - NOTATION_NODE
```
@DOMNameAttribute(name="NOTATION_NODE")
public static final int NOTATION_NODE
```
    A notation node
    
    See Also:
    
    Constant Field Values
  - flags
```
public Node.Flags flags
```
  - nodeDocument
```
public Document nodeDocument
```
  - parent
```
protected Node parent
```
- Constructor Detail
  - Node
```
protected Node(Document document)
```
    Initializes a new instance of the Node class.
    
    Parameters:
    
    document - The document.
    
    Throws:
    
    com.aspose.ms.System.ArgumentException
- Method Detail
  - adoptNode
```
public static void adoptNode(Node node,
                             Document document)
```
  - replaceAll
```
public static void replaceAll(Node node,
                              Node parent)
```
  - deepClone
```
public static Node deepClone(Node node,
                             Document document,
                             boolean cloneChildren)
```
  - finalize
```
protected void finalize()
                 throws java.lang.Throwable
```
    Finalizes an instance of the Node class.
    
    Overrides:
    
    finalize in class java.lang.Object
    
    Throws:
    
    java.lang.Throwable
  - getRegisteredObservers
```
public com.aspose.html.dom.mutations.collections.RegisteredObserverList getRegisteredObservers()
```
  - getNodeType
```
@DOMNameAttribute(name="nodeType")
public abstract int getNodeType()
```
    A code representing the type of the underlying object.
    Value: The type of the node.
  - getLocalName
```
@DOMNameAttribute(name="localName")
public java.lang.String getLocalName()
```
    Returns the local part of the qualified name of this node. For nodes of any type other than ELEMENT_NODE and ATTRIBUTE_NODE and nodes created with a DOM Level 1 method, such as Document.createElement(), this is always null.
    Value: The name of the local.
  - setLocalName
```
@DOMNameAttribute(name="localName")
protected void setLocalName(java.lang.String value)
```
    Returns the local part of the qualified name of this node. For nodes of any type other than ELEMENT_NODE and ATTRIBUTE_NODE and nodes created with a DOM Level 1 method, such as Document.createElement(), this is always null.
    Value: The name of the local.
  - getNamespaceURI
```
@DOMNameAttribute(name="namespaceURI")
 @DOMNullableAttribute
public java.lang.String getNamespaceURI()
```
    The namespace URI of this node, or null if it is unspecified.
  - setNamespaceURI
```
@DOMNameAttribute(name="namespaceURI")
 @DOMNullableAttribute
protected void setNamespaceURI(java.lang.String value)
```
    The namespace URI of this node, or null if it is unspecified.
  - getPrefix
```
@DOMNameAttribute(name="prefix")
 @DOMNullableAttribute
public java.lang.String getPrefix()
```
    The namespace prefix of this node, or null if it is unspecified. When it is defined to be null, setting it has no effect
    Value: The prefix.
  - setPrefix
```
@DOMNameAttribute(name="prefix")
 @DOMNullableAttribute
public void setPrefix(java.lang.String value)
```
    The namespace prefix of this node, or null if it is unspecified. When it is defined to be null, setting it has no effect
    Value: The prefix.
  - getNodeName
```
@DOMNameAttribute(name="nodeName")
public abstract java.lang.String getNodeName()
```
    The name of this node, depending on its type.
    Value: The name of the node.
  - getBaseURI
```
@DOMNameAttribute(name="baseURI")
public java.lang.String getBaseURI()
```
    The absolute base URI of this node or null if the implementation wasn't able to obtain an absolute URI.
  - getOwnerDocument
```
@DOMNameAttribute(name="ownerDocument")
 @DOMNullableAttribute
public Document getOwnerDocument()
```
    The Document object associated with this node. This is also the Document object used to create new nodes. When this node is a Document or a DocumentType which is not used with any Document yet, this is null.
  - getParentNode
```
@DOMNameAttribute(name="parentNode")
 @DOMNullableAttribute
public Node getParentNode()
```
    The parent of this node. All nodes, except Attr, Document, DocumentFragment, Entity, and Notation may have a parent. However, if a node has just been created and not yet added to the tree, or if it has been removed from the tree, this is null.
  - setParentNode
```
public void setParentNode(Node parent)
```
  - getParentElement
```
@DOMNameAttribute(name="parentElement")
 @DOMNullableAttribute
public Element getParentElement()
```
    Gets the parent Element of this node.
  - hasChildNodes
```
@DOMNameAttribute(name="hasChildNodes")
public boolean hasChildNodes()
```
    Returns whether this node has any children.
    
    Returns:
    
    true if has child nodes otherwise, false.
  - getChildNodes
```
@DOMNameAttribute(name="childNodes")
public NodeList getChildNodes()
```
    A NodeList that contains all children of this node. If there are no children, this is a NodeList containing no nodes..
  - getFirstChild
```
@DOMNameAttribute(name="firstChild")
public Node getFirstChild()
```
    The first child of this node. If there is no such node, this returns null.
  - getLastChild
```
@DOMNameAttribute(name="lastChild")
public Node getLastChild()
```
    The last child of this node. If there is no such node, this returns null.
  - getPreviousSibling
```
@DOMNameAttribute(name="previousSibling")
public Node getPreviousSibling()
```
    The node immediately preceding this node. If there is no such node, this returns null.
  - getNextSibling
```
@DOMNameAttribute(name="nextSibling")
public Node getNextSibling()
```
    The node immediately following this node. If there is no such node, this returns null.
  - getAttributes
```
@DOMNameAttribute(name="attributes")
public NamedNodeMap getAttributes()
```
    A NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise.
  - hasAttributes
```
@DOMNameAttribute(name="hasAttributes")
public boolean hasAttributes()
```
    Returns whether this node (if it is an element) has any attributes
    
    Returns:
    
    boolean true if this node has any attributes, false otherwise.
  - getNodeValue
```
@DOMNameAttribute(name="nodeValue")
public java.lang.String getNodeValue()
```
    The value of this node, depending on its type.
    Value: The node value.
  - setNodeValue
```
@DOMNameAttribute(name="nodeValue")
public void setNodeValue(java.lang.String value)
```
    The value of this node, depending on its type.
    Value: The node value.
  - getTextContent
```
@DOMNameAttribute(name="textContent")
public java.lang.String getTextContent()
```
    This attribute returns the text content of this node and its descendants. When it is defined to be null, setting it has no effect. On setting, any possible children this node may have are removed and, if it the new string is not empty or null, replaced by a single Text node containing the string this attribute is set to.
    Value: The content of the text.
  - setTextContent
```
@DOMNameAttribute(name="textContent")
public void setTextContent(java.lang.String value)
```
    This attribute returns the text content of this node and its descendants. When it is defined to be null, setting it has no effect. On setting, any possible children this node may have are removed and, if it the new string is not empty or null, replaced by a single Text node containing the string this attribute is set to.
    Value: The content of the text.
  - getChildNodesInternal
```
public final NodeList getChildNodesInternal()
```
  - normalize
```
@DOMNameAttribute(name="normalize")
public void normalize()
```
    Puts all Text nodes in the full depth of the sub-tree underneath this Node, including attribute nodes, into a "normal" form where only structure (e.g., elements, comments, processing instructions, CDATA sections, and entity references) separates Text nodes, i.e., there are neither adjacent Text nodes nor empty Text nodes. This can be used to ensure that the DOM view of a document is the same as if it were saved and re-loaded, and is useful when operations (such as XPointer [XPointer] lookups) that depend on a particular document tree structure are to be used. If the parameter "normalize-characters" of the DOMConfiguration object attached to the Node.ownerDocument is true, this method will also fully normalize the characters of the Text nodes.
  - cloneNode
```
@DOMNameAttribute(name="cloneNode")
public Node cloneNode(@DOMParameterAttribute(name="deep",optional=true)
                                                          boolean deep)
```
    Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes. The duplicate node has no parent (parentNode is null) and no user data.
    
    Parameters:
    
    deep - if set to true [deep].
    
    Returns:
    
    Returns node
  - isEqualNode
```
@DOMNameAttribute(name="isEqualNode")
public boolean isEqualNode(@DOMNullableAttribute
                                                                 Node otherNode)
```
    Tests whether two nodes are equal. This method tests for equality of nodes, not sameness (i.e., whether the two nodes are references to the same object) which can be tested with Node.isSameNode(). All nodes that are the same will also be equal, though the reverse may not be true.
    
    Parameters:
    
    otherNode - The other node.
    
    Returns:
    
    true if [is equal node] [the specified arg]; otherwise, false.
  - isSameNode
```
@DOMNameAttribute(name="isSameNode")
public boolean isSameNode(Node otherNode)
```
    Returns whether this node is the same node as the given one. 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:
    
    otherNode - The other node.
    
    Returns:
    
    true if [is same node] [the specified other]; otherwise, false.
  - lookupPrefix
```
@DOMNameAttribute(name="lookupPrefix")
public java.lang.String lookupPrefix(@DOMNullableAttribute
                                                                            java.lang.String namespaceURI)
```
    Look up the prefix associated to the given namespace URI, starting from this node. The default namespace declarations are ignored by this method. See Namespace Prefix Lookup for details on the algorithm used by this method.
    
    Parameters:
    
    namespaceURI - The namespace URI.
    
    Returns:
    
    Returns prefix
  - lookupNamespaceURI
```
@DOMNameAttribute(name="lookupNamespaceURI")
public java.lang.String lookupNamespaceURI(@DOMNullableAttribute
                                                                                        java.lang.String prefix)
```
    Look up the namespace URI associated to the given prefix, starting from this node.
    
    Specified by:
    
    lookupNamespaceURI in interface IXPathNSResolver
    
    Parameters:
    
    prefix - The prefix.
    
    Returns:
    
    Returns namespace URI
  - isDefaultNamespace
```
@DOMNameAttribute(name="isDefaultNamespace")
public boolean isDefaultNamespace(@DOMNullableAttribute
                                                                               java.lang.String namespaceURI)
```
    This method checks if the specified namespaceURI is the default namespace or not.
    
    Parameters:
    
    namespaceURI - The namespace URI.
    
    Returns:
    
    true if [is default namespace] [the specified namespace URI]; otherwise, false.
  - insertBefore
```
@DOMNameAttribute(name="insertBefore")
public Node insertBefore(Node node,
                                                                @DOMNullableAttribute
                                                                Node child)
```
    Inserts the node before the existing child node child. If child is null, insert node at the end of the list of children. If child is a DocumentFragment object, all of its children are inserted, in the same order, before child. If the child is already in the tree, it is first removed.
    
    Parameters:
    
    node - The new child.
    
    child - The ref child.
    
    Returns:
    
    Returns inserted node
  - replaceChild
```
@DOMNameAttribute(name="replaceChild")
public Node replaceChild(Node node,
                                                                @DOMNullableAttribute
                                                                Node child)
```
    Replaces the child node oldChild with newChild in the list of children, and returns the oldChild node. If newChild is a DocumentFragment object, oldChild is replaced by all of the DocumentFragment children, which are inserted in the same order. If the newChild is already in the tree, it is first removed.
    
    Parameters:
    
    node - The new node.
    
    child - The old child.
    
    Returns:
    
    Returns node
  - removeChild
```
@DOMNameAttribute(name="removeChild")
public Node removeChild(Node child)
```
    Removes the child node indicated by oldChild from the list of children, and returns it.
    
    Parameters:
    
    child - The old child.
    
    Returns:
    
    Returns node
  - appendChild
```
@DOMNameAttribute(name="appendChild")
public Node appendChild(Node node)
```
    Adds the node newChild to the end of the list of children of this node. If the newChild is already in the tree, it is first removed.
    
    Parameters:
    
    node - The node to append.
    
    Returns:
    
    Returns node
  - dispose
```
protected void dispose(boolean disposing)
```
    Releases unmanaged and - optionally - managed resources.
    
    Overrides:
    
    dispose in class EventTarget
    
    Parameters:
    
    disposing - true to release both managed and unmanaged resources; false to release only unmanaged resources.
  - toString
```
public java.lang.String toString()
```
    Returns a String that represents this instance.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A String that represents this instance.

Class Node

Nested Class Summary

Field Summary

Fields inherited from class com.aspose.html.dom.EventTarget

Fields inherited from class com.aspose.html.dom.DOMObject

Constructor Summary

Method Summary

Methods inherited from class com.aspose.html.dom.EventTarget

Methods inherited from class com.aspose.html.dom.DOMObject

Methods inherited from class java.lang.Object

Field Detail

ELEMENT_NODE

ATTRIBUTE_NODE

TEXT_NODE

CDATA_SECTION_NODE

ENTITY_REFERENCE_NODE

ENTITY_NODE

PROCESSING_INSTRUCTION_NODE

COMMENT_NODE

DOCUMENT_NODE

DOCUMENT_TYPE_NODE

DOCUMENT_FRAGMENT_NODE

NOTATION_NODE

flags

nodeDocument

parent

Constructor Detail

Node

Method Detail

adoptNode

replaceAll

deepClone

finalize

getRegisteredObservers

getNodeType

getLocalName

setLocalName

getNamespaceURI

setNamespaceURI

getPrefix

setPrefix

getNodeName

getBaseURI

getOwnerDocument

getParentNode

setParentNode

getParentElement

hasChildNodes

getChildNodes

getFirstChild

getLastChild

getPreviousSibling

getNextSibling

getAttributes

hasAttributes

getNodeValue

setNodeValue

getTextContent

setTextContent

getChildNodesInternal

normalize

cloneNode

isEqualNode

isSameNode

lookupPrefix

lookupNamespaceURI

isDefaultNamespace

insertBefore

replaceChild

removeChild

appendChild

dispose

toString