com.aspose.words

Class HeaderFooter

java.lang.Object

com.aspose.words.Node

com.aspose.words.CompositeNode

com.aspose.words.Story

com.aspose.words.HeaderFooter

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Iterable

public class HeaderFooter
extends Story

Represents a container for the header or footer text of a section.

HeaderFooter can contain Paragraph and Table child nodes.

HeaderFooter is a section-level node and can only be a child of Section. There can only be one HeaderFooter or each getHeaderFooterType() in a Section.

If Section does not have a HeaderFooter of a specific type or the HeaderFooter has no child nodes, this header/footer is considered linked to the header/footer of the same type of the previous section in Microsoft Word.

When HeaderFooter contains at least one Paragraph, it is no longer considered linked to previous in Microsoft Word.

Constructor Summary

Constructors

Constructor and Description
HeaderFooter(DocumentBase doc, int headerFooterType) Initializes a new instance of this class.

Method Summary

Modifier and Type	Method and Description
boolean	accept(DocumentVisitor visitor) Accepts a visitor.
int	getHeaderFooterType() Gets the type of this header/footer.
int	getNodeType() Returns NodeType.HeaderFooter.
Section	getParentSection() Gets the parent section of this story.
boolean	isHeader() True if this HeaderFooter object is a header.
boolean	isLinkedToPrevious() True if this header or footer is linked to the corresponding header or footer in the previous section.
void	isLinkedToPrevious(boolean value) True if this header or footer is linked to the corresponding header or footer in the previous section.

Methods inherited from class com.aspose.words.Story

appendParagraph, deleteShapes, getFirstParagraph, getLastParagraph, getParagraphs, getStoryType, getTables

Methods inherited from class com.aspose.words.CompositeNode

acceptChildren, acceptCore, appendChild, coreRemoveSelfOnly, getChild, getChildNodes, getChildNodes, getContainer, getCount, getCurrentNode, getFirstChild, getLastChild, getNextMatchingNode, getText, hasChildNodes, indexOf, insertAfter, insertBefore, isComposite, iterator, prependChild, removeAllChildren, removeChild, removeSmartTags, selectNodes, selectSingleNode

Methods inherited from class com.aspose.words.Node

dd, deepClone, getAncestor, getAncestor, getCustomNodeId, getDocument, getNextSibling, 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

HeaderFooter

public HeaderFooter(DocumentBase doc,
                    int headerFooterType)

Initializes a new instance of this class.

Method Detail

getNodeType

public int getNodeType()

Returns NodeType.HeaderFooter.

Specified by:

getNodeType in class Node

Returns:

NodeType.HeaderFooter. The returned value is one of NodeType constants.

getParentSection

public Section getParentSection()

Gets the parent section of this story.

ParentSection is equivalent to (Section)ParentNode.

Returns:

The parent section of this story.

getHeaderFooterType

public int getHeaderFooterType()

Gets the type of this header/footer.

Returns:

The type of this header/footer. The returned value is one of HeaderFooterType constants.

isHeader

public boolean isHeader()

True if this HeaderFooter object is a header.

Returns:

The corresponding boolean value.

isLinkedToPrevious

public boolean isLinkedToPrevious()

True if this header or footer is linked to the corresponding header or footer in the previous section.

Default is true.

Note, when your link a header or footer, its contents is cleared.

Returns:

The corresponding boolean value.

isLinkedToPrevious

public void isLinkedToPrevious(boolean value)

True if this header or footer is linked to the corresponding header or footer in the previous section.

Default is true.

Note, when your link a header or footer, its contents is cleared.

Parameters:

value - The corresponding boolean value.

accept

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

Specified by:

accept in class Node

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