com.aspose.words
Class NodeCollection

java.lang.Object
    extended by com.aspose.words.NodeCollection
All Implemented Interfaces:
java.lang.Iterable
Direct Known Subclasses:
BuildingBlockCollection, CommentCollection, HeaderFooterCollection, ParagraphCollection, RunCollection, SectionCollection

public class NodeCollection 
extends java.lang.Object

Represents a collection of nodes of a specific type.

NodeCollection does not own the nodes it contains, rather, is just a selection of nodes of the specified type, but the nodes are stored in the tree under their respective parent nodes.

NodeCollection supports indexed access, iteration and provides add and remove methods.

The NodeCollection collection is "live", i.e. changes to the children of the node object that it was created from are immediately reflected in the nodes returned by the NodeCollection properties and methods.

NodeCollection is returned by CompositeNode.getChildNodes(int,boolean) and also serves as a base class for typed node collections such as SectionCollection, ParagraphCollection etc.

NodeCollection can be "flat" and contain only immediate children of the node it was created from, or it can be "deep" and contain all descendant children.


Property Getters/Setters Summary
intgetCount()
           Gets the number of nodes in the collection.
Nodeget(int index)
           Retrieves a node at the given index.
 
Method Summary
voidadd(Node node)
           Adds a node to the end of the collection.
voidclear()
           Removes all nodes from this collection and from the document.
booleancontains(Node node)
           Determines whether a node is in the collection.
CompositeNodegetContainer()
          Reserved for internal use.
NodegetNextMatchingNode(aspose.obfuscated.type curNode)
          Reserved for internal use.
intindexOf(Node node)
           Returns the zero-based index of the specified node.
voidinsert(int index, Node node)
           Inserts a node into the collection at the specified index.
java.util.Iteratoriterator()
           Provides a simple "foreach" style iteration over the collection of nodes.
voidremove(Node node)
           Removes the node from the collection and from the document.
voidremoveAt(int index)
           Removes the node at the specified index from the collection and from the document.
Aspose.Words.Node[]toArray()
           Copies all nodes from the collection to a new array of nodes.
 

Property Getters/Setters Detail

getCount

public int getCount()
Gets the number of nodes in the collection.

get

public Node get(int index)
Retrieves a node at the given index.

The index is zero-based.

Negative indexes are allowed and indicate access from the back of the collection. For example -1 means the last item, -2 means the second before last and so on.

If index is greater than or equal to the number of items in the list, this returns a null reference.

If index is negative and its absolute value is greater than the number of items in the list, this returns a null reference.

Parameters:
index - An index into the collection of nodes.

Method Detail

add

public void add(Node node)
Adds a node to the end of the collection.

The node is inserted as a child into the node object from which the collection was created.

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 DocumentBase.importNode(com.aspose.words.Node,boolean,int) to import the node to the current document. The imported node can then be inserted into the current document.

Parameters:
node - The node to be added to the end of the collection.

clear

public void clear()
Removes all nodes from this collection and from the document.

contains

public boolean contains(Node node)
Determines whether a node is in the collection.

This method performs a linear search; therefore, the average execution time is proportional to Count.

Parameters:
node - The node to locate.
Returns:
True if item is found in the collection; otherwise, false.

getContainer

public CompositeNode getContainer()
Reserved for internal use.

getNextMatchingNode

public Node getNextMatchingNode(aspose.obfuscated.type curNode)
                        throws java.lang.Exception
Reserved for internal use.

indexOf

public int indexOf(Node node)
Returns the zero-based index of the specified node.

This method performs a linear search; therefore, the average execution time is proportional to Count.

Parameters:
node - The node to locate.
Returns:
The zero-based index of the node within the collection, if found; otherwise, -1.

insert

public void insert(int index, Node node)
Inserts a node into the collection at the specified index.

The node is inserted as a child into the node object from which the collection was created.

If the index is equal to or greater than Count, the node is added at the end of the collection.

If the index is negative and its absolute value is greater than Count, the node is added at the end of the collection.

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 DocumentBase.importNode(com.aspose.words.Node,boolean,int) to import the node to the current document. The imported node can then be inserted into the current document.

Parameters:
index - The zero-based index of the node. Negative indexes are allowed and indicate access from the back of the list. For example -1 means the last node, -2 means the second before last and so on.
node - The node to insert.

iterator

public java.util.Iterator iterator()
Provides a simple "foreach" style iteration over the collection of nodes.
Returns:
Iterator<Node>.

remove

public void remove(Node node)
Removes the node from the collection and from the document.
Parameters:
node - The node to remove.

removeAt

public void removeAt(int index)
Removes the node at the specified index from the collection and from the document.
Parameters:
index - The zero-based index of the node. Negative indexes are allowed and indicate access from the back of the list. For example -1 means the last node, -2 means the second before last and so on.

toArray

public Aspose.Words.Node[] toArray()
Copies all nodes from the collection to a new array of nodes.

You should not be adding/removing nodes while iterating over a collection of nodes because it invalidates the iterator and requires refreshes for live collections.

To be able to add/remove nodes during iteration, use this method to copy nodes into a fixed-size array and then iterate over the array.

Returns:
An array of nodes.

See Also:
          Aspose.Words Documentation - the home page for the Aspose.Words Product Documentation.
          Aspose.Words Support Forum - our preferred method of support.