Package org.apache.poi.xwpf.usermodel

Class XWPFFootnote

java.lang.Object

org.apache.poi.xwpf.usermodel.XWPFAbstractFootnoteEndnote

org.apache.poi.xwpf.usermodel.XWPFFootnote

All Implemented Interfaces:

Iterable<XWPFParagraph>, IBody

public class XWPFFootnote
extends XWPFAbstractFootnoteEndnote

Represents a bottom-of-the-page footnote.

Create a new footnote using XWPFDocument.createFootnote() or XWPFFootnotes.createFootnote().

The first body element of a footnote should (or possibly must) be a paragraph with the first run containing a CTFtnEdnRef object. The XWPFAbstractFootnoteEndnote.createParagraph() and XWPFAbstractFootnoteEndnote.createTable() methods do this for you.

Footnotes have IDs that are unique across all footnotes in the document. You use the footnote ID to create a reference to a footnote from within a paragraph.

To create a reference to a footnote within a paragraph you create a run with a CTFtnEdnRef that specifies the ID of the target paragraph. The XWPFParagraph.addFootnoteReference(XWPFAbstractFootnoteEndnote) method does this for you.

Constructor Summary

Constructors

Constructor	Description
XWPFFootnote(XWPFDocument document, CTFtnEdn body)
XWPFFootnote(CTFtnEdn note, XWPFAbstractFootnotesEndnotes xFootnotes)

Method Summary

Modifier and Type	Method	Description
void	ensureFootnoteRef(XWPFParagraph p)	Ensure that the specified paragraph has a reference marker for this footnote by adding a footnote reference if one is not found.

Methods inherited from class org.apache.poi.xwpf.usermodel.XWPFAbstractFootnoteEndnote

addNewParagraph, addNewTbl, createParagraph, createTable, createTable, getBodyElements, getCTFtnEdn, getId, getOwner, getParagraph, getParagraphArray, getParagraphs, getPart, getPartType, getPictures, getTable, getTableArray, getTableCell, getTables, getXWPFDocument, insertNewParagraph, insertNewTbl, insertTable, iterator, setCTFtnEdn, spliterator

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach

Constructor Details

XWPFFootnote

@Internal
public XWPFFootnote(CTFtnEdn note,
 XWPFAbstractFootnotesEndnotes xFootnotes)

XWPFFootnote

@Internal
public XWPFFootnote(XWPFDocument document,
 CTFtnEdn body)

Method Details

ensureFootnoteRef

public void ensureFootnoteRef(XWPFParagraph p)

Ensure that the specified paragraph has a reference marker for this footnote by adding a footnote reference if one is not found.

This method is for the first paragraph in the footnote, not paragraphs that will refer to the footnote. For references to the footnote, use XWPFParagraph.addFootnoteReference(XWPFAbstractFootnoteEndnote).

The first run of the first paragraph in a footnote should contain a CTFtnEdnRef object.

Specified by:

ensureFootnoteRef in class XWPFAbstractFootnoteEndnote

Parameters:

p - The XWPFParagraph to ensure

Since:

4.0.0