Package org.apache.poi.xwpf.usermodel
Class XWPFAbstractFootnoteEndnote
java.lang.Object
org.apache.poi.xwpf.usermodel.XWPFAbstractFootnoteEndnote
- All Implemented Interfaces:
Iterable<XWPFParagraph>,IBody
- Direct Known Subclasses:
XWPFEndnote,XWPFFootnote
public abstract class XWPFAbstractFootnoteEndnote
extends Object
implements Iterable<XWPFParagraph>, IBody
Base class for both bottom-of-the-page footnotes
XWPFFootnote and end
notes XWPFEndnote).
The only significant difference between footnotes and
end notes is which part they go on. Footnotes are managed by the Footnotes part
XWPFFootnotes and end notes are managed by the Endnotes part XWPFEndnotes.
- Since:
- 4.0.0
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFtnEdnprotected XWPFDocumentprotected XWPFAbstractFootnotesEndnotes -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedXWPFAbstractFootnoteEndnote(XWPFDocument document, org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFtnEdn body) protectedXWPFAbstractFootnoteEndnote(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFtnEdn note, XWPFAbstractFootnotesEndnotes footnotes) -
Method Summary
Modifier and TypeMethodDescriptionaddNewParagraph(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTP paragraph) Add a newXWPFParagraphto the end of the footnote.addNewTbl(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTbl table) Add a newXWPFTableto the end of the footnote.Appends a newXWPFParagraphto this footnote.Appends a newXWPFTableto this footnotecreateTable(int rows, int cols) Appends a newXWPFTableto this footnoteabstract voidEnsure that the specified paragraph has a reference marker for this footnote by adding a footnote reference if one is not found.Gets the body elements (IBodyElement) of the footnote.org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFtnEdnGets the underlying CTFtnEdn object for the footnote.getId()Get the ID of the footnote.getOwner()The owning object for this footnotegetParagraph(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTP p) if there is a correspondingXWPFParagraphof the parameter p in the paragraphList of this header or footer the method will return that paragraph, otherwise the method will return null.getParagraphArray(int pos) Returns theXWPFParagraphat position pos in footnote's paragraph array.Get the list ofXWPFParagraphs in the footnote.getPart()Get the Part to which the footnote belongs, which you need for adding relationships to other partsGet the part typeBodyTypeof the footnote.Gets the list ofXWPFPictureDatas in the footnote.getTable(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTbl ctTable) getTableArray(int pos) Gets theXWPFTableat the specified position from the footnote's table array.getTableCell(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTc cell) get theXWPFTableCellthat belongs to the CTTc cell.Get the list ofXWPFTables in the footnote.Get theXWPFDocumentthe footnote is part of.protected voidinit()insertNewParagraph(org.apache.xmlbeans.XmlCursor cursor) Add a newXWPFParagraphat position of the cursor.insertNewTbl(org.apache.xmlbeans.XmlCursor cursor) Insert a table constructed from OOXML table markup.voidinsertTable(int pos, XWPFTable table) Inserts an existing {@link XWPFTable) into the arrays bodyElements and tables.iterator()Get an iterator over theXWPFParagraphs in the footnote.voidsetCTFtnEdn(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFtnEdn footnote) Set the underlying CTFtnEdn for the footnote.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface java.lang.Iterable
forEach, spliterator
-
Field Details
-
ctFtnEdn
protected org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFtnEdn ctFtnEdn -
footnotes
-
document
-
-
Constructor Details
-
XWPFAbstractFootnoteEndnote
public XWPFAbstractFootnoteEndnote() -
XWPFAbstractFootnoteEndnote
@Internal protected XWPFAbstractFootnoteEndnote(XWPFDocument document, org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFtnEdn body) -
XWPFAbstractFootnoteEndnote
@Internal protected XWPFAbstractFootnoteEndnote(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFtnEdn note, XWPFAbstractFootnotesEndnotes footnotes)
-
-
Method Details
-
init
protected void init() -
getParagraphs
Get the list ofXWPFParagraphs in the footnote.- Specified by:
getParagraphsin interfaceIBody- Returns:
- List of paragraphs
-
iterator
Get an iterator over theXWPFParagraphs in the footnote.- Specified by:
iteratorin interfaceIterable<XWPFParagraph>- Returns:
- Iterator over the paragraph list.
-
getTables
Get the list ofXWPFTables in the footnote. -
getPictures
Gets the list ofXWPFPictureDatas in the footnote.- Returns:
- List of pictures
-
getBodyElements
Gets the body elements (IBodyElement) of the footnote.- Specified by:
getBodyElementsin interfaceIBody- Returns:
- List of body elements.
-
getCTFtnEdn
public org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFtnEdn getCTFtnEdn()Gets the underlying CTFtnEdn object for the footnote.- Returns:
- CTFtnEdn object
-
setCTFtnEdn
public void setCTFtnEdn(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFtnEdn footnote) Set the underlying CTFtnEdn for the footnote.Use
XWPFDocument.createFootnote()to create new footnotes.- Parameters:
footnote- The CTFtnEdn object that will underly the footnote.
-
getTableArray
Gets theXWPFTableat the specified position from the footnote's table array.- Specified by:
getTableArrayin interfaceIBody- Parameters:
pos- in table array- Returns:
- The
XWPFTableat position pos, or null if there is no table at position pos. - See Also:
-
insertTable
Inserts an existing {@link XWPFTable) into the arrays bodyElements and tables.- Specified by:
insertTablein interfaceIBody- Parameters:
pos- Position, in the bodyElements array, to insert the tabletable- {@link XWPFTable) to be inserted- See Also:
-
getTable
if there is a correspondingXWPFTableof the parameter ctTable in the tableList of this header the method will return this table, or null if there is no correspondingXWPFTable. -
getParagraph
if there is a correspondingXWPFParagraphof the parameter p in the paragraphList of this header or footer the method will return that paragraph, otherwise the method will return null.- Specified by:
getParagraphin interfaceIBody- Parameters:
p- The CTP paragraph to find the correspondingXWPFParagraphfor.- Returns:
- The
XWPFParagraphthat corresponds to the CTP paragraph in the paragraph list of this footnote or null if no paragraph is found. - See Also:
-
getParagraphArray
Returns theXWPFParagraphat position pos in footnote's paragraph array.- Specified by:
getParagraphArrayin interfaceIBody- Parameters:
pos- Array position of the paragraph to get.- Returns:
- the
XWPFParagraphat position pos, or null if there is no paragraph at that position. - See Also:
-
getTableCell
get theXWPFTableCellthat belongs to the CTTc cell.- Specified by:
getTableCellin interfaceIBody- Parameters:
cell-- Returns:
XWPFTableCellthat corresponds to the CTTc cell, if there is one, otherwise null.- See Also:
-
getOwner
The owning object for this footnote- Returns:
- The
XWPFFootnotesobject that contains this footnote.
-
insertNewTbl
Insert a table constructed from OOXML table markup.- Specified by:
insertNewTblin interfaceIBody- Parameters:
cursor-- Returns:
- the inserted
XWPFTable - See Also:
-
insertNewParagraph
Add a newXWPFParagraphat position of the cursor.- Specified by:
insertNewParagraphin interfaceIBody- Parameters:
cursor-- Returns:
- The inserted
XWPFParagraph - See Also:
-
addNewTbl
Add a newXWPFTableto the end of the footnote. -
addNewParagraph
public XWPFParagraph addNewParagraph(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTP paragraph) Add a newXWPFParagraphto the end of the footnote.- Parameters:
paragraph- CTP paragraph from which to construct theXWPFParagraph- Returns:
- The added
XWPFParagraph
-
getXWPFDocument
Get theXWPFDocumentthe footnote is part of.- Specified by:
getXWPFDocumentin interfaceIBody- See Also:
-
getPart
Get the Part to which the footnote belongs, which you need for adding relationships to other parts- Specified by:
getPartin interfaceIBody- Returns:
POIXMLDocumentPartthat contains the footnote.- See Also:
-
getPartType
Get the part typeBodyTypeof the footnote.- Specified by:
getPartTypein interfaceIBody- Returns:
- The
BodyTypevalue. - See Also:
-
getId
Get the ID of the footnote.Footnote IDs are unique across all bottom-of-the-page and end note footnotes.
- Returns:
- Footnote ID
- Since:
- 4.0.0
-
createParagraph
Appends a newXWPFParagraphto this footnote.- Returns:
- The new
XWPFParagraph - Since:
- 4.0.0
-
ensureFootnoteRef
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(XWPFFootnote).The first run of the first paragraph in a footnote should contain a
CTFtnEdnRefobject.- Parameters:
p- TheXWPFParagraphto ensure- Since:
- 4.0.0
-
createTable
Appends a newXWPFTableto this footnote- Returns:
- The new
XWPFTable - Since:
- 4.0.0
-
createTable
Appends a newXWPFTableto this footnote- Parameters:
rows- Number of rows to initialize the table withcols- Number of columns to initialize the table with- Returns:
- the new
XWPFTablewith the specified number of rows and columns - Since:
- 4.0.0
-