CompositeNode (Aspose.Words for Java API Reference)

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

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Iterable

Direct Known Subclasses:

BuildingBlock, Cell, DocumentBase, InlineStory, OfficeMath, Paragraph, Row, Section, ShapeBase, SmartTag, Story, StructuredDocumentTag, Table
```
public abstract class CompositeNode
extends Node
implements java.lang.Iterable
```
Base class for nodes that can contain other nodes.
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 CompositeNode class:
- Provides access to the child nodes.
- Implements Composite operations such as insert and remove children.
- Provides methods for XPath navigation.

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected boolean`	`acceptChildren(DocumentVisitor visitor)`
`protected boolean`	`acceptCore(DocumentVisitor visitor)`
`Node`	`appendChild(Node newChild)` Adds the specified node to the end of the list of child nodes for this node.
`protected void`	`coreRemoveSelfOnly()`
`Node`	`getChild(int nodeType, int index, boolean isDeep)`
`NodeCollection`	`getChildNodes()` Gets all immediate child nodes of this node.
`NodeCollection`	`getChildNodes(int nodeType, boolean isDeep)`
`CompositeNode`	`getContainer()`
`int`	`getCount()` Gets the number of immediate children of this node.
`Node`	`getCurrentNode()`
`Node`	`getFirstChild()` Gets the first child of the node.
`Node`	`getLastChild()` Gets the last child of the node.
`Node`	`getNextMatchingNode(Node curNode)`
`java.lang.String`	`getText()` Gets the text of this node and of all its children.
`boolean`	`hasChildNodes()` Returns true if this node has any child nodes.
`int`	`indexOf(Node child)` Returns the index of the specified child node in the child node array.
`Node`	`insertAfter(Node newChild, Node refChild)` Inserts the specified node immediately after the specified reference node.
`Node`	`insertBefore(Node newChild, Node refChild)` Inserts the specified node immediately before the specified reference node.
`boolean`	`isComposite()` Returns true as this node can have child nodes.
`java.util.Iterator`	`iterator()` Provides support for the for each style iteration over the child nodes of this node.
`Node`	`prependChild(Node newChild)` Adds the specified node to the beginning of the list of child nodes for this node.
`void`	`removeAllChildren()` Removes all the child nodes of the current node.
`Node`	`removeChild(Node oldChild)` Removes the specified child node.
`void`	`removeSmartTags()` Removes all `SmartTag` descendant nodes of the current node.
`NodeList`	`selectNodes(java.lang.String xpath)` Selects a list of nodes matching the XPath expression.
`Node`	`selectSingleNode(java.lang.String xpath)` Selects the first Node that matches the XPath expression.

Methods inherited from class com.aspose.words.Node
accept, dd, deepClone, getAncestor, getAncestor, getCustomNodeId, getDocument, getNextSibling, getNodeType, getParentNode, getPreviousSibling, getRange, memberwiseClone, nextPreOrder, nodeTypeToString, previousPreOrder, remove, setCustomNodeId, toString, toString, toString, visitorActionToBool

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

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - CompositeNode
```
protected CompositeNode()
```
    Initializes a new instance of this class.
  - CompositeNode
```
protected CompositeNode(DocumentBase doc)
```
    Initializes a new instance of this class.
- Method Detail
  - coreRemoveSelfOnly
```
protected void coreRemoveSelfOnly()
```
  - isComposite
```
public boolean isComposite()
```
    Returns true as this node can have child nodes.
    
    Overrides:
    
    isComposite in class Node
    
    Returns:
    
    True as this node can have child nodes.
  - hasChildNodes
```
public boolean hasChildNodes()
```
    Returns true if this node has any child nodes.
    
    Returns:
    
    True if this node has any child nodes.
  - getChildNodes
```
public NodeCollection getChildNodes()
```
    Gets all immediate child nodes of this node.
    Note, getChildNodes() is equivalent to calling GetChildNodes(NodeType.Any, false) and creates and returns a new collection every time it is accessed.
    
    If there are no child nodes, this property returns an empty collection.
    
    Returns:
    
    All immediate child nodes of this node.
  - getFirstChild
```
public Node getFirstChild()
```
    Gets the first child of the node. If there is no first child node, a null is returned.
    
    Returns:
    
    The first child of the node.
  - getLastChild
```
public Node getLastChild()
```
    Gets the last child of the node. If there is no last child node, a null is returned.
    
    Returns:
    
    The last child of the node.
  - getCount
```
public int getCount()
```
    Gets the number of immediate children of this node.
    
    Returns:
    
    The number of immediate children of this node.
  - 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.
    
    Overrides:
    
    getText in class Node
  - getChildNodes
```
public NodeCollection getChildNodes(int nodeType,
                                    boolean isDeep)
```
  - getChild
```
public Node getChild(int nodeType,
                     int index,
                     boolean isDeep)
```
  - selectNodes
```
public NodeList selectNodes(java.lang.String xpath)
```
    Selects a list of nodes matching the XPath expression.
    Only expressions with element names are supported at the moment. Expressions that use attribute names are not supported.
    
    Parameters:
    
    xpath - The XPath expression.
    
    Returns:
    
    A list of nodes matching the XPath query.
  - selectSingleNode
```
public Node selectSingleNode(java.lang.String xpath)
```
    Selects the first Node that matches the XPath expression.
    Only expressions with element names are supported at the moment. Expressions that use attribute names are not supported.
    
    Parameters:
    
    xpath - The XPath expression.
    
    Returns:
    
    The first Node that matches the XPath query or null if no matching node is found.
  - iterator
```
public java.util.Iterator iterator()
```
    Provides support for the for each style iteration over the child nodes of this node.
    
    Specified by:
    
    iterator in interface java.lang.Iterable
  - appendChild
```
public Node appendChild(Node newChild)
```
    Adds the specified node to the end of the list of child nodes for this node.
    If the newChild is already in the tree, it is first removed.
    
    If the node being inserted was created from another document, you should use M:Aspose.Words.DocumentBase.ImportNode(Aspose.Words.Node,System.Boolean,Aspose.Words.ImportFormatMode) to import the node to the current document. The imported node can then be inserted into the current document.
    
    Parameters:
    
    newChild - The node to add.
    
    Returns:
    
    The node added.
  - prependChild
```
public Node prependChild(Node newChild)
```
    Adds the specified node to the beginning of the list of child nodes for this node.
    If the newChild is already in the tree, it is first removed.
    
    If the node being inserted was created from another document, you should use M:Aspose.Words.DocumentBase.ImportNode(Aspose.Words.Node,System.Boolean,Aspose.Words.ImportFormatMode) to import the node to the current document. The imported node can then be inserted into the current document.
    
    Parameters:
    
    newChild - The node to add.
    
    Returns:
    
    The node added.
  - insertAfter
```
public Node insertAfter(Node newChild,
                        Node refChild)
```
    Inserts the specified node immediately after the specified reference node.
    If refChild is null, inserts newChild at the beginning of the list of child nodes.
    
    If the newChild is already in the tree, it is first removed.
    
    If the node being inserted was created from another document, you should use M:Aspose.Words.DocumentBase.ImportNode(Aspose.Words.Node,System.Boolean,Aspose.Words.ImportFormatMode) to import the node to the current document. The imported node can then be inserted into the current document.
    
    Parameters:
    
    newChild - The Node to insert.
    
    refChild - The Node that is the reference node. The newNode is placed after the refNode.
    
    Returns:
    
    The inserted node.
  - insertBefore
```
public Node insertBefore(Node newChild,
                         Node refChild)
```
    Inserts the specified node immediately before the specified reference node.
    If refChild is null, inserts newChild at the end of the list of child nodes.
    
    If the newChild is already in the tree, it is first removed.
    
    If the node being inserted was created from another document, you should use M:Aspose.Words.DocumentBase.ImportNode(Aspose.Words.Node,System.Boolean,Aspose.Words.ImportFormatMode) to import the node to the current document. The imported node can then be inserted into the current document.
    
    Parameters:
    
    newChild - The Node to insert.
    
    refChild - The Node that is the reference node. The newChild is placed before this node.
    
    Returns:
    
    The inserted node.
  - removeChild
```
public Node removeChild(Node oldChild)
```
    Removes the specified child node.
    The parent of oldChild is set to null after the node is removed.
    
    Parameters:
    
    oldChild - The node to remove.
    
    Returns:
    
    The removed node.
  - removeAllChildren
```
public void removeAllChildren()
```
    Removes all the child nodes of the current node.
  - removeSmartTags
```
public void removeSmartTags()
```
    Removes all SmartTag descendant nodes of the current node. This method does not remove the content of the smart tags.
  - indexOf
```
public int indexOf(Node child)
```
    Returns the index of the specified child node in the child node array. Returns -1 if the node is not found in the child nodes.
  - acceptCore
```
protected boolean acceptCore(DocumentVisitor visitor)
                      throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - acceptChildren
```
protected boolean acceptChildren(DocumentVisitor visitor)
                          throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - getNextMatchingNode
```
public Node getNextMatchingNode(Node curNode)
```
  - getCurrentNode
```
public Node getCurrentNode()
```
  - getContainer
```
public CompositeNode getContainer()
```

Class CompositeNode

Constructor Summary

Method Summary

Methods inherited from class com.aspose.words.Node

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

CompositeNode

CompositeNode

Method Detail

coreRemoveSelfOnly

isComposite

hasChildNodes

getChildNodes

getFirstChild

getLastChild

getCount

getText

getChildNodes

getChild

selectNodes

selectSingleNode

iterator

appendChild

prependChild

insertAfter

insertBefore

removeChild

removeAllChildren

removeSmartTags

indexOf

acceptCore

acceptChildren

getNextMatchingNode

getCurrentNode

getContainer