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

public class XWPFFootnotes
extends XWPFAbstractFootnotesEndnotes

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

Fields

Modifier and Type	Field and Description
protected org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFootnotes	ctFootnotes

Fields inherited from class org.apache.poi.xwpf.usermodel.XWPFAbstractFootnotesEndnotes

document, listFootnote

Constructor Summary

Constructors

Constructor and Description
XWPFFootnotes() Construct XWPFFootnotes from scratch for a new document.
XWPFFootnotes(PackagePart part) Construct XWPFFootnotes from a package part

Method Summary

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.
java.util.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

Methods 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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ctFootnotes

protected org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFootnotes ctFootnotes

Constructor Detail

XWPFFootnotes

public XWPFFootnotes(PackagePart part)
              throws java.io.IOException,
                     OpenXML4JException

Construct XWPFFootnotes from a package part

Parameters:

part - the package part holding the data of the footnotes,

Throws:

java.io.IOException

OpenXML4JException

Since:

POI 3.14-Beta1

XWPFFootnotes

public XWPFFootnotes()

Construct XWPFFootnotes from scratch for a new document.

Method Detail

setFootnotes

@Internal
public void setFootnotes(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFootnotes footnotes)

Sets the ctFootnotes

Parameters:

footnotes - Collection of CTFntEdn objects.

createFootnote

public XWPFFootnote 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

protected void onDocumentRead()
                       throws java.io.IOException

Read document

Overrides:

onDocumentRead in class POIXMLDocumentPart

Throws:

java.io.IOException - a subclass may throw an IOException when a document is read

commit

protected void commit()
               throws java.io.IOException

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 class POIXMLDocumentPart

Throws:

java.io.IOException - a subclass may throw an IOException if the changes can't be committed

addFootnote

public void addFootnote(XWPFFootnote footnote)

Add an XWPFFootnote to the document

Parameters:

footnote - Footnote to add

Throws:

java.io.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:

java.io.IOException

getFootnotesList

public java.util.List<XWPFFootnote> getFootnotesList()

Get the list of XWPFFootnote in the Footnotes part.

Returns:

List, possibly empty, of footnotes.