org.apache.poi.xwpf.usermodel
Class XWPFFootnotes

java.lang.Object
  org.apache.poi.POIXMLDocumentPart
      org.apache.poi.xwpf.usermodel.XWPFFootnotes

public class XWPFFootnotes
extends POIXMLDocumentPart

Looks after the collection of Footnotes for a document

document

protected XWPFDocument document

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.

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

getFootnotesList

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

getFootnoteById

public XWPFFootnote getFootnoteById(int id)

setFootnotes

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

Sets the ctFootnotes

Parameters:

footnotes -

addFootnote

public void addFootnote(XWPFFootnote footnote)

add an XWPFFootnote to the document

Parameters:

footnote -

Throws:

java.io.IOException

addFootnote

public XWPFFootnote addFootnote(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFtnEdn note)

add a footnote to the document

Parameters:

note -

Throws:

java.io.IOException

getXWPFDocument

public XWPFDocument getXWPFDocument()

See Also:

IBody.getPart()

setXWPFDocument

public void setXWPFDocument(XWPFDocument doc)