Package org.apache.poi.xwpf.usermodel
Class XWPFFootnotes
java.lang.Object
org.apache.poi.ooxml.POIXMLDocumentPart
org.apache.poi.xwpf.usermodel.XWPFAbstractFootnotesEndnotes
org.apache.poi.xwpf.usermodel.XWPFFootnotes
Looks after the collection of Footnotes for a document.
Manages bottom-of-the-page footnotes (
XWPFFootnote
).-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.poi.ooxml.POIXMLDocumentPart
POIXMLDocumentPart.RelationPart
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFootnotes
Fields inherited from class org.apache.poi.xwpf.usermodel.XWPFAbstractFootnotesEndnotes
document, listFootnote
-
Constructor Summary
ConstructorsConstructorDescriptionConstruct XWPFFootnotes from scratch for a new document.XWPFFootnotes
(PackagePart part) Construct XWPFFootnotes from a package part -
Method Summary
Modifier and TypeMethodDescriptionvoid
addFootnote
(XWPFFootnote footnote) Add anXWPFFootnote
to the documentaddFootnote
(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFtnEdn note) Add a CT footnote to the documentprotected void
commit()
Save the content in the underlying package part.Create a new footnote and add it to the document.Get the list ofXWPFFootnote
in the Footnotes part.protected void
Read documentboolean
removeFootnote
(int pos) Remove the specified footnote if present.void
setFootnotes
(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFootnotes footnotes) Sets the ctFootnotesMethods inherited from class org.apache.poi.xwpf.usermodel.XWPFAbstractFootnotesEndnotes
getFootnoteById, getIdManager, getXWPFDocument, setIdManager, setXWPFDocument
Methods inherited from class org.apache.poi.ooxml.POIXMLDocumentPart
_invokeOnDocumentRead, addRelation, createRelationship, createRelationship, createRelationship, getNextPartNumber, getPackagePart, getParent, getRelationById, getRelationId, getRelationPartById, getRelationParts, getRelations, getTargetPart, isCommited, onDocumentCreate, onDocumentRemove, onSave, prepareForCommit, read, rebase, removeRelation, removeRelation, removeRelation, setCommited, toString
-
Field Details
-
ctFootnotes
protected org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFootnotes ctFootnotes
-
-
Constructor Details
-
XWPFFootnotes
Construct XWPFFootnotes from a package part- Parameters:
part
- the package part holding the data of the footnotes,- Throws:
IOException
OpenXML4JException
- Since:
- POI 3.14-Beta1
-
XWPFFootnotes
public XWPFFootnotes()Construct XWPFFootnotes from scratch for a new document.
-
-
Method Details
-
setFootnotes
@Internal public void setFootnotes(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFootnotes footnotes) Sets the ctFootnotes- Parameters:
footnotes
- Collection of CTFntEdn objects.
-
createFootnote
Create a new footnote and add it to the document.- Returns:
- New
XWPFFootnote
- Since:
- 4.0.0
-
removeFootnote
public boolean removeFootnote(int pos) Remove the specified footnote if present.- Parameters:
pos
- Array position of the footnote to be removed- Returns:
- True if the footnote was removed.
- Since:
- 4.0.0
-
onDocumentRead
Read document- Overrides:
onDocumentRead
in classPOIXMLDocumentPart
- Throws:
IOException
- a subclass may throw an IOException when a document is read
-
commit
Description copied from class:POIXMLDocumentPart
Save the content in the underlying package part. Default implementation is empty meaning that the package part is left unmodified.Sub-classes should override and add logic to marshal the "model" into Ooxml4J.
For example, the code saving a generic XML entry may look as follows:
protected void commit() throws IOException { PackagePart part = getPackagePart(); OutputStream out = part.getOutputStream(); XmlObject bean = getXmlBean(); //the "model" which holds changes in memory bean.save(out, DEFAULT_XML_OPTIONS); out.close(); }
- Overrides:
commit
in classPOIXMLDocumentPart
- Throws:
IOException
- a subclass may throw an IOException if the changes can't be committed
-
addFootnote
Add anXWPFFootnote
to the document- Parameters:
footnote
- Footnote to add- Throws:
IOException
-
addFootnote
@Internal public XWPFFootnote addFootnote(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFtnEdn note) Add a CT footnote to the document- Parameters:
note
- CTFtnEdn to add.- Throws:
IOException
-
getFootnotesList
Get the list ofXWPFFootnote
in the Footnotes part.- Returns:
- List, possibly empty, of footnotes.
-