Node (Aspose.Words for Java API Reference)

java.lang.Object
- com.aspose.words.Node

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

BookmarkEnd, BookmarkStart, CommentRangeEnd, CommentRangeStart, CompositeNode, EditableRangeEnd, EditableRangeStart, Inline, StructuredDocumentTagRangeEnd, StructuredDocumentTagRangeStart, SubDocument
```
public abstract class Node
extends java.lang.Object
implements java.lang.Cloneable
```
Base class for all nodes of a Word document.
To learn more, visit the Aspose.Words Document Object Model (DOM) documentation article.

A document is represented as a tree of nodes, similar to DOM or XmlDocument.

For more info see the Composite design pattern.

The Node class:
- Defines the child node interface.
- Defines the interface for visiting nodes.
- Provides default cloning capability.
- Implements parent node and owner document mechanisms.
- Implements access to sibling nodes.

Constructor Summary

Constructors
Modifier Constructor and Description

protected Node()
Initializes a new instance of this class.

protected Node(DocumentBase doc)
Initializes a new instance of this class.

Constructors
Modifier	Constructor and Description
`protected`	`Node()` Initializes a new instance of this class.
`protected`	`Node(DocumentBase doc)` Initializes a new instance of this class.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract boolean`	`accept(DocumentVisitor visitor)` Accepts a visitor.
`void`	`dd()`
`Node`	`deepClone(boolean isCloneChildren)` Creates a duplicate of the node.
`CompositeNode`	`getAncestor(java.lang.Class ancestorType)` Gets the first ancestor of the specified object type.
`CompositeNode`	`getAncestor(int ancestorType)`
`int`	`getCustomNodeId()` Specifies custom node identifier.
`DocumentBase`	`getDocument()` Gets the document to which this node belongs.
`Node`	`getNextSibling()` Gets the node immediately following this node.
`abstract int`	`getNodeType()` Gets the type of this node.
`CompositeNode`	`getParentNode()` Gets the immediate parent of this node.
`Node`	`getPreviousSibling()` Gets the node immediately preceding this node.
`Range`	`getRange()` Returns a Range object that represents the portion of a document that is contained in this node.
`java.lang.String`	`getText()` Gets the text of this node and of all its children.
`boolean`	`isComposite()` Returns true if this node can contain other nodes.
`protected java.lang.Object`	`memberwiseClone()`
`Node`	`nextPreOrder(Node rootNode)` Gets next node according to the pre-order tree traversal algorithm.
`static java.lang.String`	`nodeTypeToString(int nodeType)`
`Node`	`previousPreOrder(Node rootNode)` Gets the previous node according to the pre-order tree traversal algorithm.
`void`	`remove()` Removes itself from the parent.
`void`	`setCustomNodeId(int value)` Specifies custom node identifier.
`java.lang.String`	`toString()`
`java.lang.String`	`toString(int saveFormat)`
`java.lang.String`	`toString(SaveOptions saveOptions)` Exports the content of the node into a string using the specified save options.
`protected static boolean`	`visitorActionToBool(int action)`

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

- Constructor Detail
  - Node
```
protected Node()
```
    Initializes a new instance of this class.
  - Node
```
protected Node(DocumentBase doc)
```
    Initializes a new instance of this class.
- Method Detail
  - getNodeType
```
public abstract int getNodeType()
```
    Gets the type of this node.
    
    Returns:
    
    The type of this node. The returned value is one of NodeType constants.
  - getParentNode
```
public CompositeNode getParentNode()
```
    Gets the immediate parent of this node.
    If a node has just been created and not yet added to the tree, or if it has been removed from the tree, the parent is null.
    
    Returns:
    
    The immediate parent of this node.
  - getDocument
```
public DocumentBase getDocument()
```
    Gets the document to which this node belongs.
    The node always belongs to a document even if it has just been created and not yet added to the tree, or if it has been removed from the tree.
    
    Returns:
    
    The document to which this node belongs.
  - getPreviousSibling
```
public Node getPreviousSibling()
```
    Gets the node immediately preceding this node. If there is no preceding node, a null is returned.
    
    Returns:
    
    The node immediately preceding this node.
  - getNextSibling
```
public Node getNextSibling()
```
    Gets the node immediately following this node. If there is no next node, a null is returned.
    
    Returns:
    
    The node immediately following this node.
  - isComposite
```
public boolean isComposite()
```
    Returns true if this node can contain other nodes. (31110,6)
    
    Returns:
    
    True if this node can contain other nodes.
  - getRange
```
public Range getRange()
```
    Returns a Range object that represents the portion of a document that is contained in this node.
    
    Returns:
    
    A Range object that represents the portion of a document that is contained in this node.
  - deepClone
```
public Node deepClone(boolean isCloneChildren)
```
    Creates a duplicate of the node.
    This method serves as a copy constructor for nodes. The cloned node has no parent, but belongs to the same document as the original node.
    
    This method always performs a deep copy of the node. The isCloneChildren parameter specifies whether to perform copy all child nodes as well.
    
    Parameters:
    
    isCloneChildren - True to recursively clone the subtree under the specified node; false to clone only the node itself.
    
    Returns:
    
    The cloned node.
  - accept
```
public abstract boolean accept(DocumentVisitor visitor)
                        throws java.lang.Exception
```
    Accepts a visitor.
    Enumerates over this node and all of its children. Each node calls a corresponding method on DocumentVisitor.
    
    For more info see the Visitor design pattern.
    
    Parameters:
    
    visitor - The visitor that will visit the nodes.
    
    Returns:
    
    True if all nodes were visited; false if DocumentVisitor stopped the operation before visiting all nodes.
    
    Throws:
    
    java.lang.Exception
  - visitorActionToBool
```
protected static boolean visitorActionToBool(int action)
```
  - getText
```
public java.lang.String getText()
```
    Gets the text of this node and of all its children.
    The returned string includes all control and special characters as described in ControlChar.
  - getAncestor
```
public CompositeNode getAncestor(java.lang.Class ancestorType)
```
    Gets the first ancestor of the specified object type.
    
    Parameters:
    
    ancestorType - The object type of the ancestor to retrieve.
    
    Returns:
    
    The ancestor of the specified type or null if no ancestor of this type was found.
  - getAncestor
```
public CompositeNode getAncestor(int ancestorType)
```
  - remove
```
public void remove()
```
    Removes itself from the parent.
  - nextPreOrder
```
public Node nextPreOrder(Node rootNode)
```
    Gets next node according to the pre-order tree traversal algorithm.
    
    Parameters:
    
    rootNode - The top node (limit) of traversal.
    
    Returns:
    
    Next node in pre-order order. Null if reached the rootNode.
  - previousPreOrder
```
public Node previousPreOrder(Node rootNode)
```
    Gets the previous node according to the pre-order tree traversal algorithm.
    
    Parameters:
    
    rootNode - The top node (limit) of traversal.
    
    Returns:
    
    Previous node in pre-order order. Null if reached the rootNode.
  - toString
```
public java.lang.String toString(int saveFormat)
                          throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - toString
```
public java.lang.String toString(SaveOptions saveOptions)
                          throws java.lang.Exception
```
    Exports the content of the node into a string using the specified save options.
    
    Parameters:
    
    saveOptions - Specifies the options that control how the node is saved.
    
    Returns:
    
    The content of the node in the specified format.
    
    Throws:
    
    java.lang.Exception
  - nodeTypeToString
```
public static java.lang.String nodeTypeToString(int nodeType)
```
  - getCustomNodeId
```
public int getCustomNodeId()
```
    Specifies custom node identifier.
    Default is zero.
    
    This identifier can be set and used arbitrarily. For example, as a key to get external data.
    
    Important note, specified value is not saved to an output file and exists only during the node lifetime.
    
    Returns:
    
    The corresponding int value.
  - setCustomNodeId
```
public void setCustomNodeId(int value)
```
    Specifies custom node identifier.
    Default is zero.
    
    This identifier can be set and used arbitrarily. For example, as a key to get external data.
    
    Important note, specified value is not saved to an output file and exists only during the node lifetime.
    
    Parameters:
    
    value - The corresponding int value.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - dd
```
public void dd()
```
  - memberwiseClone
```
protected java.lang.Object memberwiseClone()
```

Class Node

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Node

Node

Method Detail

getNodeType

getParentNode

getDocument

getPreviousSibling

getNextSibling

isComposite

getRange

deepClone

accept

visitorActionToBool

getText

getAncestor

getAncestor

remove

nextPreOrder

previousPreOrder

toString

toString

nodeTypeToString

getCustomNodeId

setCustomNodeId

toString

dd

memberwiseClone