public class XWPFFootnotes extends XWPFAbstractFootnotesEndnotes
XWPFFootnote).POIXMLDocumentPart.RelationPart| Modifier and Type | Field and Description |
|---|---|
protected org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFootnotes |
ctFootnotes |
document, listFootnote| Constructor and Description |
|---|
XWPFFootnotes()
Construct XWPFFootnotes from scratch for a new document.
|
XWPFFootnotes(PackagePart part)
Construct XWPFFootnotes from a package part
|
| Modifier and Type | Method and Description |
|---|---|
XWPFFootnote |
addFootnote(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFtnEdn note)
Add a CT footnote to the document
|
void |
addFootnote(XWPFFootnote footnote)
Add an
XWPFFootnote to the document |
protected void |
commit()
Save the content in the underlying package part.
|
XWPFFootnote |
createFootnote()
Create a new footnote and add it to the document.
|
List<XWPFFootnote> |
getFootnotesList()
Get the list of
XWPFFootnote in the Footnotes part. |
protected void |
onDocumentRead()
Read document
|
boolean |
removeFootnote(int pos)
Remove the specified footnote if present.
|
void |
setFootnotes(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFootnotes footnotes)
Sets the ctFootnotes
|
getFootnoteById, getIdManager, getXWPFDocument, setIdManager, setXWPFDocument_invokeOnDocumentRead, addRelation, createRelationship, createRelationship, createRelationship, getNextPartNumber, getPackagePart, getParent, getRelationById, getRelationId, getRelationPartById, getRelationParts, getRelations, getTargetPart, isCommitted, onDocumentCreate, onDocumentRemove, onSave, prepareForCommit, read, rebase, removeRelation, removeRelation, removeRelation, setCommitted, toStringprotected org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFootnotes ctFootnotes
public XWPFFootnotes(PackagePart part)
part - the package part holding the data of the footnotes,public XWPFFootnotes()
@Internal public void setFootnotes(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFootnotes footnotes)
footnotes - Collection of CTFntEdn objects.public XWPFFootnote createFootnote()
XWPFFootnotepublic boolean removeFootnote(int pos)
pos - Array position of the footnote to be removedprotected void onDocumentRead()
throws IOException
onDocumentRead in class POIXMLDocumentPartIOException - a subclass may throw an IOException when a document is readprotected void commit()
throws IOException
POIXMLDocumentPartSub-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();
try (OutputStream out = part.getOutputStream()) {
XmlObject bean = getXmlBean(); //the "model" which holds changes in memory
bean.save(out, DEFAULT_XML_OPTIONS);
}
}
commit in class POIXMLDocumentPartIOException - a subclass may throw an IOException if the changes can't be committedpublic void addFootnote(XWPFFootnote footnote)
XWPFFootnote to the documentfootnote - Footnote to add@Internal public XWPFFootnote addFootnote(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFtnEdn note)
note - CTFtnEdn to add.public List<XWPFFootnote> getFootnotesList()
XWPFFootnote in the Footnotes part.