com.aspose.words
Class Footnote

java.lang.Object
  extended by Node
      extended by CompositeNode
          extended by InlineStory
              extended by com.aspose.words.Footnote
All Implemented Interfaces:
java.lang.Iterable, java.lang.Cloneable

public class Footnote 
extends InlineStory

Represents a container for text of a footnote or endnote.

The Footnote class is used to represent both footnotes and endnotes in a Word document.

Footnote is an inline-level node and can only be a child of Paragraph.

Footnote can contain Paragraph and Table child nodes.

See Also:
FootnoteType, DocumentBuilder.insertFootnote(int,java.lang.String), FootnoteOptions, EndnoteOptions

Constructor Summary
Footnote(DocumentBase doc, int footnoteType)
           Initializes an instance of the Footnote class.
 
Property Getters/Setters Summary
NodeCollectiongetChildNodes()→ inherited from CompositeNode
           Gets all immediate child nodes of this node.
intgetCount()→ inherited from CompositeNode
           Gets the number of immediate children of this node.
DocumentBasegetDocument()→ inherited from Node
           Gets the document to which this node belongs.
NodegetFirstChild()→ inherited from CompositeNode
           Gets the first child of the node.
ParagraphgetFirstParagraph()→ inherited from InlineStory
           Gets the first paragraph in the story.
FontgetFont()→ inherited from InlineStory
           Provides access to the font formatting of the anchor character of this object.
intgetFootnoteType()
           Returns a value that specifies whether this is a footnote or endnote. The value of the property is FootnoteType integer constant.
booleanhasChildNodes()→ inherited from CompositeNode
           Returns true if this node has any child nodes.
booleanisAuto()
voidisAuto(boolean value)
           Holds a value that specifies whether this is a auto-numbered footnote or footnote with user defined custom reference mark.
booleanisComposite()→ inherited from CompositeNode
           Returns true as this node can have child nodes.
booleanisDeleteRevision()→ inherited from InlineStory
           Returns true if this object was deleted in Microsoft Word while change tracking was enabled.
booleanisInsertRevision()→ inherited from InlineStory
           Returns true if this object was inserted in Microsoft Word while change tracking was enabled.
NodegetLastChild()→ inherited from CompositeNode
           Gets the last child of the node.
ParagraphgetLastParagraph()→ inherited from InlineStory
           Gets the last paragraph in the story.
NodegetNextSibling()→ inherited from Node
           Gets the node immediately following this node.
intgetNodeType()
           Returns NodeType.Footnote. The value of the property is NodeType integer constant.
ParagraphCollectiongetParagraphs()→ inherited from InlineStory
           Gets a collection of paragraphs that are immediate children of the story.
CompositeNodegetParentNode()→ inherited from Node
           Gets the immediate parent of this node.
ParagraphgetParentParagraph()→ inherited from InlineStory
           Retrieves the parent Paragraph of this node.
NodegetPreviousSibling()→ inherited from Node
           Gets the node immediately preceding this node.
RangegetRange()→ inherited from Node
           Returns a Range object that represents the portion of a document that is contained in this node.
java.lang.StringgetReferenceMark()
voidsetReferenceMark(java.lang.String value)
           Gets/sets custom reference mark to be used for this footnote. Default value is #Error Cref: F:System.String.Empty, meaning auto-numbered footnotes are used.
intgetStoryType()
           Returns StoryType.Footnotes or StoryType.Endnotes. The value of the property is StoryType integer constant.
Aspose.Words.Tables.TableCollectiongetTables()→ inherited from InlineStory
           Gets a collection of tables that are immediate children of the story.
 
Method Summary
booleanaccept(DocumentVisitor visitor)
           Accepts a visitor.
NodeappendChild(Node newChild)→ inherited from CompositeNode
           Adds the specified node to the end of the list of child nodes for this node.
voidclearRunAttrs()→ inherited from InlineStory
          Reserved for internal use.
NodedeepClone(boolean isCloneChildren)→ inherited from Node
           Creates a duplicate of the node.
voidensureMinimum()→ inherited from InlineStory
           If the last child is not a paragraph, creates and appends one empty paragraph.
java.lang.ObjectfetchInheritedRunAttr(int fontAttr)→ inherited from InlineStory
          Reserved for internal use.
CompositeNodegetAncestor(int ancestorType)→ inherited from Node
           Gets the first ancestor of the specified NodeType.
CompositeNodegetAncestor(java.lang.Class ancestorType)→ inherited from Node
           Gets the first ancestor of the specified object type.
NodegetChild(int nodeType, int index, boolean isDeep)→ inherited from CompositeNode
           Returns an Nth child node that matches the specified type.
NodeCollectiongetChildNodes(int nodeType, boolean isDeep)→ inherited from CompositeNode
           Returns a live collection of child nodes that match the specified type.
CompositeNodegetContainer()→ inherited from CompositeNode
          Reserved for internal use.
aspose.obfuscated.typegetDeleteRevision()
          Reserved for internal use.
java.lang.ObjectgetDirectRunAttr(int fontAttr)→ inherited from InlineStory
          Reserved for internal use.
intgetDirectRunAttrsCount()→ inherited from InlineStory
          Reserved for internal use.
DocumentBasegetDocument_IInline()→ inherited from InlineStory
          Reserved for internal use.
aspose.obfuscated.typegetExpandedRunPr_IInline(aspose.obfuscated.type flags)→ inherited from InlineStory
          Reserved for internal use.
aspose.obfuscated.typegetInsertRevision()
          Reserved for internal use.
aspose.obfuscated.typegetMoveFromRevision()
          Reserved for internal use.
aspose.obfuscated.typegetMoveToRevision()
          Reserved for internal use.
NodegetNextMatchingNode(aspose.obfuscated.type curNode)→ inherited from CompositeNode
          Reserved for internal use.
ParagraphgetParentParagraph_IInline()→ inherited from InlineStory
          Reserved for internal use.
aspose.obfuscated.typegetRunPr_IInline()→ inherited from InlineStory
          Reserved for internal use.
java.lang.StringgetText()→ inherited from CompositeNode
           Gets the text of this node and of all its children.
intindexOf(Node child)→ inherited from CompositeNode
           Returns the index of the specified child node in the child node array.
NodeinsertAfter(Node newChild, Node refChild)→ inherited from CompositeNode
           Inserts the specified node immediately after the specified reference node.
NodeinsertBefore(Node newChild, Node refChild)→ inherited from CompositeNode
           Inserts the specified node immediately before the specified reference node.
java.util.Iteratoriterator()→ inherited from CompositeNode
           Provides support for the for each style iteration over the child nodes of this node.
NodenextPreOrder(Node rootNode)→ inherited from Node
           Gets next node according to the pre-order tree traversal algorithm.
NodeprependChild(Node newChild)→ inherited from CompositeNode
           Adds the specified node to the beginning of the list of child nodes for this node.
NodepreviousPreOrder(Node rootNode)→ inherited from Node
           Gets the previous node according to the pre-order tree traversal algorithm.
voidremove()→ inherited from Node
           Removes itself from the parent.
voidremoveAllChildren()→ inherited from CompositeNode
           Removes all the child nodes of the current node.
NoderemoveChild(Node oldChild)→ inherited from CompositeNode
           Removes the specified child node.
voidremoveRunAttr(int key)→ inherited from InlineStory
          Reserved for internal use.
voidremoveSmartTags()→ inherited from CompositeNode
           Removes all Aspose.Words.Markup.SmartTag descendant nodes of the current node.
NodeListselectNodes(java.lang.String xpath)→ inherited from CompositeNode
           Selects a list of nodes matching the XPath expression.
NodeselectSingleNode(java.lang.String xpath)→ inherited from CompositeNode
           Selects the first Node that matches the XPath expression.
voidsetDeleteRevision(aspose.obfuscated.type value)
          Reserved for internal use.
voidsetInsertRevision(aspose.obfuscated.type value)
          Reserved for internal use.
voidsetMoveFromRevision(aspose.obfuscated.type value)
          Reserved for internal use.
voidsetMoveToRevision(aspose.obfuscated.type value)
          Reserved for internal use.
voidsetRunAttr(int fontAttr, java.lang.Object value)→ inherited from InlineStory
          Reserved for internal use.
voidsetRunPr_IInline(aspose.obfuscated.type value)→ inherited from InlineStory
          Reserved for internal use.
java.lang.StringtoString(int saveFormat)→ inherited from Node
           Exports the content of the node into a string in the specified format.
java.lang.StringtoTxt()→ inherited from Node
           Exports the content of the node into a string in plain text format.
 

Constructor Detail

Footnote

public Footnote(DocumentBase doc, int footnoteType)
Initializes an instance of the Footnote class.

When Footnote is created, it belongs to the specified document, but is not yet part of the document and ParentNode is null.

To append Footnote to the document use InsertAfter or InsertBefore on the paragraph where you want the footnote inserted.

Parameters:
doc - The owner document.
footnoteType - A FootnoteType value. A FootnoteType value that specifies whether this is a footnote or endnote.

Property Getters/Setters Detail

getChildNodes

→ inherited from CompositeNode
public NodeCollection getChildNodes()
Gets all immediate child nodes of this node.

Note, ChildNodes 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.


getCount

→ inherited from CompositeNode
public int getCount()
Gets the number of immediate children of this node.

getDocument

→ inherited from Node
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.


getFirstChild

→ inherited from CompositeNode
public Node getFirstChild()
Gets the first child of the node. If there is no first child node, a null is returned.

getFirstParagraph

→ inherited from InlineStory
public Paragraph getFirstParagraph()
Gets the first paragraph in the story.

getFont

→ inherited from InlineStory
public Font getFont()
Provides access to the font formatting of the anchor character of this object.

getFootnoteType

public int getFootnoteType()
Returns a value that specifies whether this is a footnote or endnote. The value of the property is FootnoteType integer constant.

hasChildNodes

→ inherited from CompositeNode
public boolean hasChildNodes()
Returns true if this node has any child nodes.

isAuto/isAuto

public boolean isAuto() / public void isAuto(boolean value)
Holds a value that specifies whether this is a auto-numbered footnote or footnote with user defined custom reference mark. ReferenceMark initialized with empty string if IsAuto set to false.

isComposite

→ inherited from CompositeNode
public boolean isComposite()
Returns true as this node can have child nodes.

isDeleteRevision

→ inherited from InlineStory
public boolean isDeleteRevision()
Returns true if this object was deleted in Microsoft Word while change tracking was enabled.

isInsertRevision

→ inherited from InlineStory
public boolean isInsertRevision()
Returns true if this object was inserted in Microsoft Word while change tracking was enabled.

getLastChild

→ inherited from CompositeNode
public Node getLastChild()
Gets the last child of the node. If there is no last child node, a null is returned.

getLastParagraph

→ inherited from InlineStory
public Paragraph getLastParagraph()
Gets the last paragraph in the story.

getNextSibling

→ inherited from Node
public Node getNextSibling()
Gets the node immediately following this node. If there is no next node, a null is returned.

getNodeType

public int getNodeType()
Returns NodeType.Footnote. The value of the property is NodeType integer constant.

getParagraphs

→ inherited from InlineStory
public ParagraphCollection getParagraphs()
Gets a collection of paragraphs that are immediate children of the story.

getParentNode

→ inherited from Node
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.


getParentParagraph

→ inherited from InlineStory
public Paragraph getParentParagraph()
Retrieves the parent Paragraph of this node.

getPreviousSibling

→ inherited from Node
public Node getPreviousSibling()
Gets the node immediately preceding this node. If there is no preceding node, a null is returned.

getRange

→ inherited from Node
public Range getRange()
Returns a Range object that represents the portion of a document that is contained in this node.

getReferenceMark/setReferenceMark

public java.lang.String getReferenceMark() / public void setReferenceMark(java.lang.String value)
Gets/sets custom reference mark to be used for this footnote. Default value is #Error Cref: F:System.String.Empty, meaning auto-numbered footnotes are used.

If this property is set to #Error Cref: F:System.String.Empty or null, then IsAuto property will automatically be set to true, if set to anything else then IsAuto will be set to false.

RTF-format can only store 1 symbol as custom reference mark, so upon export only the first symbol will be written others will be discard.


getStoryType

public int getStoryType()
Returns StoryType.Footnotes or StoryType.Endnotes. The value of the property is StoryType integer constant.

getTables

→ inherited from InlineStory
public Aspose.Words.Tables.TableCollection getTables()
Gets a collection of tables that are immediate children of the story.

Method Detail

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.

Calls DocumentVisitor.VisitFootnoteStart, then calls Accept for all child nodes of the footnote and calls DocumentVisitor.VisitFootnoteEnd at the end.
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.

appendChild

→ inherited from CompositeNode
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 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:
newChild - The node to add.
Returns:
The node added.

clearRunAttrs

→ inherited from InlineStory
public void clearRunAttrs()
Reserved for internal use.

deepClone

→ inherited from Node
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.

ensureMinimum

→ inherited from InlineStory
public void ensureMinimum()
If the last child is not a paragraph, creates and appends one empty paragraph.

fetchInheritedRunAttr

→ inherited from InlineStory
public java.lang.Object fetchInheritedRunAttr(int fontAttr)
Reserved for internal use.

getAncestor

→ inherited from Node
public CompositeNode getAncestor(int ancestorType)
Gets the first ancestor of the specified NodeType.
Parameters:
ancestorType - A NodeType value. The node type of the ancestor to retrieve.
Returns:
The ancestor of the specified type or null if no ancestor of this type was found.

getAncestor

→ inherited from Node
public CompositeNode getAncestor(java.lang.Class ancestorType)
Gets the first ancestor of the specified object type.

The ancestor type matches if it is equal to ancestorType or derived from ancestorType.

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.

getChild

→ inherited from CompositeNode
public Node getChild(int nodeType, int index, boolean isDeep)
Returns an Nth child node that matches the specified type.

If index is out of range, a null is returned.

Note that markup nodes (NodeType.STRUCTURED_DOCUMENT_TAG and NodeType.SMART_TAG) are traversed even when isDeep = false and GetChild is invoked for non-markup node type. For example if the first run in a para is wrapped in a StructuredDocumentTag, it will still be returned by GetChild(NodeType.Run, 0, false).
Parameters:
nodeType - A NodeType value. Specifies the type of the child node.
index - Zero based index of the child node to select. Negative indexes are also allowed and indicate access from the end, that is -1 means the last node.
isDeep - True to select from all child nodes recursively. False to select only among immediate children. See remarks for more info.
Returns:
The child node that matches the criteria or null if no matching node is found.

getChildNodes

→ inherited from CompositeNode
public NodeCollection getChildNodes(int nodeType, boolean isDeep)
Returns a live collection of child nodes that match the specified type.

The collection of nodes returned by this method is always live.

A live collection is always in sync with the document. For example, if you selected all sections in a document and enumerate through the collection deleting the sections, the section is removed from the collection immediately when it is removed from the document.

Parameters:
nodeType - A NodeType value. Specifies the type of nodes to select.
isDeep - True to select from all child nodes recursively. False to select only among immediate children.
Returns:
A live collection of child nodes of the specified type.

getContainer

→ inherited from CompositeNode
public CompositeNode getContainer()
Reserved for internal use.

getDeleteRevision

public aspose.obfuscated.type getDeleteRevision()
Reserved for internal use.

getDirectRunAttr

→ inherited from InlineStory
public java.lang.Object getDirectRunAttr(int fontAttr)
Reserved for internal use.

getDirectRunAttrsCount

→ inherited from InlineStory
public int getDirectRunAttrsCount()
Reserved for internal use.

getDocument_IInline

→ inherited from InlineStory
public DocumentBase getDocument_IInline()
Reserved for internal use.

getExpandedRunPr_IInline

→ inherited from InlineStory
public aspose.obfuscated.type getExpandedRunPr_IInline(aspose.obfuscated.type flags)
Reserved for internal use.

getInsertRevision

public aspose.obfuscated.type getInsertRevision()
Reserved for internal use.

getMoveFromRevision

public aspose.obfuscated.type getMoveFromRevision()
Reserved for internal use.

getMoveToRevision

public aspose.obfuscated.type getMoveToRevision()
Reserved for internal use.

getNextMatchingNode

→ inherited from CompositeNode
public Node getNextMatchingNode(aspose.obfuscated.type curNode)
Reserved for internal use.

getParentParagraph_IInline

→ inherited from InlineStory
public Paragraph getParentParagraph_IInline()
Reserved for internal use.

getRunPr_IInline

→ inherited from InlineStory
public aspose.obfuscated.type getRunPr_IInline()
Reserved for internal use.

getText

→ inherited from CompositeNode
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.


indexOf

→ inherited from CompositeNode
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.

insertAfter

→ inherited from CompositeNode
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 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:
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

→ inherited from CompositeNode
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 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:
newChild - The Node to insert.
refChild - The Node that is the reference node. The newChild is placed before this node.
Returns:
The inserted node.

iterator

→ inherited from CompositeNode
public java.util.Iterator iterator()
Provides support for the for each style iteration over the child nodes of this node.

nextPreOrder

→ inherited from Node
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.

prependChild

→ inherited from CompositeNode
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 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:
newChild - The node to add.
Returns:
The node added.

previousPreOrder

→ inherited from Node
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.

remove

→ inherited from Node
public void remove()
Removes itself from the parent.

removeAllChildren

→ inherited from CompositeNode
public void removeAllChildren()
Removes all the child nodes of the current node.

removeChild

→ inherited from CompositeNode
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.

removeRunAttr

→ inherited from InlineStory
public void removeRunAttr(int key)
Reserved for internal use.

removeSmartTags

→ inherited from CompositeNode
public void removeSmartTags()
Removes all Aspose.Words.Markup.SmartTag descendant nodes of the current node. This method does not remove the content of the smart tags.

selectNodes

→ inherited from CompositeNode
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

→ inherited from CompositeNode
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.

setDeleteRevision

public void setDeleteRevision(aspose.obfuscated.type value)
Reserved for internal use.

setInsertRevision

public void setInsertRevision(aspose.obfuscated.type value)
Reserved for internal use.

setMoveFromRevision

public void setMoveFromRevision(aspose.obfuscated.type value)
Reserved for internal use.

setMoveToRevision

public void setMoveToRevision(aspose.obfuscated.type value)
Reserved for internal use.

setRunAttr

→ inherited from InlineStory
public void setRunAttr(int fontAttr, java.lang.Object value)
Reserved for internal use.

setRunPr_IInline

→ inherited from InlineStory
public void setRunPr_IInline(aspose.obfuscated.type value)
Reserved for internal use.

toString

→ inherited from Node
public java.lang.String toString(int saveFormat)
               throws java.lang.Exception
Exports the content of the node into a string in the specified format.
Returns:
The content of the node in the specified format.
Parameters:
saveFormat - A SaveFormat value.

toTxt

→ inherited from Node
public java.lang.String toTxt()
            throws java.lang.Exception
Exports the content of the node into a string in plain text format.

This method removes field codes and Microsoft Word control characters, uses CrLf (or any other) combination of characters to mark ends of paragraphs in the resulting string. It produces a different result from getText() which just gets the text from the node without removing field codes or special characters.

Returns:
The content of the node in plain text format.
See Also:
#Error Cref: P:Aspose.Words.Saving.TxtSaveOptions.ParagraphBreak, #Error Cref: P:Aspose.Words.Saving.TxtSaveOptions.ExportHeadersFooters

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