com.aspose.words

Class Footnote

java.lang.Object

com.aspose.words.Node

com.aspose.words.CompositeNode

com.aspose.words.InlineStory

com.aspose.words.Footnote

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Iterable

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:

getFootnoteType(), FootnoteOptions, EndnoteOptions

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	accept(DocumentVisitor visitor) Accepts a visitor.
int	getFootnoteType() Returns a value that specifies whether this is a footnote or endnote.
int	getNodeType() Returns NodeType.Footnote.
java.lang.String	getReferenceMark() Gets/sets custom reference mark to be used for this footnote.
int	getStoryType() Returns StoryType.Footnotes or StoryType.Endnotes.
boolean	isAuto() Holds a value that specifies whether this is a auto-numbered footnote or footnote with user defined custom reference mark.
void	isAuto(boolean value) Holds a value that specifies whether this is a auto-numbered footnote or footnote with user defined custom reference mark.
void	removeMoveRevisions()
void	setReferenceMark(java.lang.String value) Gets/sets custom reference mark to be used for this footnote.

Methods inherited from class com.aspose.words.InlineStory

clearRunAttrs, ensureMinimum, fetchInheritedRunAttr, getDirectRunAttr, getDocument_IInline, getFirstParagraph, getFont, getLastParagraph, getParagraphs, getParentParagraph_IInline, getParentParagraph, getTables, isDeleteRevision, isInsertRevision, isMoveFromRevision, isMoveToRevision, removeRunAttr, setRunAttr

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

Footnote

public Footnote(DocumentBase doc,
                int footnoteType)

Initializes a new instance of this class.

Method Detail

getNodeType

public int getNodeType()

Returns NodeType.Footnote.

Specified by:

getNodeType in class Node

Returns:

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

getStoryType

public int getStoryType()

Returns StoryType.Footnotes or StoryType.Endnotes.

Specified by:

getStoryType in class InlineStory

Returns:

StoryType.Footnotes or StoryType.Endnotes. The returned value is one of StoryType constants.

getFootnoteType

public int getFootnoteType()

Returns a value that specifies whether this is a footnote or endnote.

Returns:

A value that specifies whether this is a footnote or endnote. The returned value is one of FootnoteType constants.

isAuto

public boolean isAuto()

Holds a value that specifies whether this is a auto-numbered footnote or footnote with user defined custom reference mark. getReferenceMark() / setReferenceMark(java.lang.String) initialized with empty string if IsAuto set to false.

Returns:

The corresponding boolean value.

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. getReferenceMark() / setReferenceMark(java.lang.String) initialized with empty string if IsAuto set to false.

Parameters:

value - The corresponding boolean value.

getReferenceMark

public java.lang.String getReferenceMark()

Gets/sets custom reference mark to be used for this footnote. Default value is empty string, meaning auto-numbered footnotes are used.

If this property is set to empty string or null, then isAuto() / isAuto(boolean) property will automatically be set to true, if set to anything else then isAuto() / isAuto(boolean) 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.

Returns:

The corresponding String value.

setReferenceMark

public void setReferenceMark(java.lang.String value)

Gets/sets custom reference mark to be used for this footnote. Default value is empty string, meaning auto-numbered footnotes are used.

If this property is set to empty string or null, then isAuto() / isAuto(boolean) property will automatically be set to true, if set to anything else then isAuto() / isAuto(boolean) 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.

Parameters:

value - The corresponding String 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

removeMoveRevisions

public void removeMoveRevisions()