com.aspose.words
Class HeadersFooters

java.lang.Object
  NodeCollection
      com.aspose.words.HeadersFooters

All Implemented Interfaces:

INodeCollection, java.lang.Iterable

public class HeadersFooters
extends NodeCollection

public int getCount()

Gets the number of nodes in the collection.

Example:

Shows how to enumerate immediate children of a CompositeNode using indexed access.

for (int i = 0; i <  paragraph.getChildNodes().getCount(); i++)
{
    Node childNode = paragraph.getChildNodes().get(i);

    // Paragraph may contain children of various types such as runs, inline shapes and so on.
    if (childNode.getNodeType() == NodeType.RUN)
    {
        // Say we found the node that we want, do something useful.
        Run run = (Run)childNode;
        System.out.println(run.getText());
    }
}

public HeaderFooter get(int index)

Retrieves a HeaderFooter 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.

public HeaderFooter getByHeaderFooterType(int headerFooterType)

Retrieves a HeaderFooter of the specified type.

Returns null if the header/footer of the specified type is not found.

Parameters:

headerFooterType - A HeaderFooterType value. A HeaderFooterType value that specifies the type of the header/footer to retrieve.

public void linkToPrevious(boolean isLinkToPrevious)
                   throws java.lang.Exception

Links or unlinks all headers and footers to the corresponding headers and footers in the previous section.

If any of the headers or footers do not exist, creates them automatically.

Parameters:

isLinkToPrevious - True to link the headers and footers to the previous section; false to unlink them.

public void linkToPrevious(int headerFooterType, boolean isLinkToPrevious)
                   throws java.lang.Exception

Links or unlinks the specified header or footer to the corresponding header or footer in the previous section.

If the header or footer of the specified type does not exist, creates it automatically.

Parameters:

headerFooterType - A HeaderFooterType value that specfies the header or footer to link/unlink.

isLinkToPrevious - True to link the header or footer to the previous section; false to unlink.

public void add(Node node)
        throws java.lang.Exception

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

public void insert(int index, Node node)
           throws java.lang.Exception

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

public void remove(Node node)
           throws java.lang.Exception

Removes the node from the collection and from the document.

Parameters:

node - The node to remove.

public void removeAt(int index)
             throws java.lang.Exception

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.

public void clear()
          throws java.lang.Exception

Removes all nodes from this collection and from the document.

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.

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.

public Aspose.Words.Node[] toArray()

Copies all nodes from the collection to a new array of nodes.