Class XWPFEndnotes


public class XWPFEndnotes extends XWPFAbstractFootnotesEndnotes
Looks after the collection of end notes for a document. Managed end notes (XWPFEndnote).
Since:
4.0.0
  • Field Details

    • ctEndnotes

      protected org.openxmlformats.schemas.wordprocessingml.x2006.main.CTEndnotes ctEndnotes
  • Constructor Details

  • Method Details

    • setEndnotes

      @Internal public void setEndnotes(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTEndnotes endnotes)
      Set the end notes for this part.
      Parameters:
      endnotes - The endnotes to be added.
    • createEndnote

      public XWPFEndnote createEndnote()
      Create a new end note and add it to the document.
      Returns:
      New XWPFEndnote
      Since:
      4.0.0
    • removeFootnote

      public boolean removeFootnote(int pos)
      Remove the specified footnote if present.
      Parameters:
      pos -
      Returns:
      True if the footnote was removed.
      Since:
      4.0.0
    • onDocumentRead

      protected void onDocumentRead() throws IOException
      Read document
      Overrides:
      onDocumentRead in class POIXMLDocumentPart
      Throws:
      IOException - a subclass may throw an IOException when a document is read
    • commit

      protected void commit() throws 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:
      IOException - a subclass may throw an IOException if the changes can't be committed
    • addEndnote

      public void addEndnote(XWPFEndnote endnote)
      add an XWPFEndnote to the document
      Parameters:
      endnote -
      Throws:
      IOException
    • addEndnote

      @Internal public XWPFEndnote addEndnote(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFtnEdn note)
      Add an endnote to the document
      Parameters:
      note - Note to add
      Returns:
      New XWPFEndnote
      Throws:
      IOException
    • getFootnoteById

      public XWPFEndnote getFootnoteById(int id)
      Get the end note with the specified ID, if any.
      Overrides:
      getFootnoteById in class XWPFAbstractFootnotesEndnotes
      Parameters:
      id - End note ID.
      Returns:
      The end note or null if not found.
    • getEndnotesList

      public List<XWPFEndnote> getEndnotesList()
      Get the list of XWPFEndnote in the Endnotes part.
      Returns:
      List, possibly empty, of end notes.
    • removeEndnote

      public boolean removeEndnote(int pos)
      Remove the specified end note if present.
      Parameters:
      pos - Array position of the endnote to be removed
      Returns:
      True if the end note was removed.
      Since:
      4.0.0