Package org.apache.poi.xwpf.usermodel

Interface IBody

All Known Implementing Classes:
XWPFAbstractFootnoteEndnote, XWPFComment, XWPFDocument, XWPFEndnote, XWPFFooter, XWPFFootnote, XWPFHeader, XWPFHeaderFooter, XWPFTableCell
public interface IBody

An IBody represents the different parts of the document which can contain collections of Paragraphs and Tables. It provides a common way to work with these and their contents.

Typically, this is something like a XWPFDocument, or one of the parts in it like XWPFHeader, XWPFFooter, XWPFTableCell

  • Method Details

    • getPart

      POIXMLDocumentPart getPart()
      returns the Part, to which the body belongs, which you need for adding relationship to other parts Actually it is needed of the class XWPFTableCell. Because you have to know to which part the tableCell belongs.
      Returns:
      the Part, to which the body belongs

    • getPartType

      BodyType getPartType()
      get the PartType of the body, for example DOCUMENT, HEADER, FOOTER, FOOTNOTE,
      Returns:
      the PartType of the body

    • getBodyElements

      List<IBodyElement> getBodyElements()
      Returns an Iterator with paragraphs and tables, in the order that they occur in the text.

    • getParagraphs

      List<XWPFParagraph> getParagraphs()
      Returns the paragraph(s) that holds the text of the header or footer.

    • getTables

      List<XWPFTable> getTables()
      Return the table(s) that holds the text of the IBodyPart, for complex cases where a paragraph isn't used.

    • getParagraph

      XWPFParagraph getParagraph(CTP p)
      Returns the paragraph corresponding to the provided CTP.
      Parameters:
      p - is instance of CTP and is searching for an XWPFParagraph
      Returns:
      The paragraph corresponding to the CTP, or null if there is no corresponding paragraph in this body.

    • getTable

      XWPFTable getTable(CTTbl ctTable)
      if there is a corresponding XWPFTable of the parameter ctTable in the tableList of this header the method will return this table if there is no corresponding XWPFTable the method will return null

    • getParagraphArray

      XWPFParagraph getParagraphArray(int pos)
      Returns the paragraph that of position pos

    • getTableArray

      XWPFTable getTableArray(int pos)
      Returns the table at position pos

    • insertNewParagraph

      XWPFParagraph insertNewParagraph(XmlCursor cursor)
      inserts a new paragraph at position of the cursor

    • insertNewTbl

      XWPFTable insertNewTbl(XmlCursor cursor)
      inserts a new Table at the cursor position.

    • insertTable

      void insertTable(int pos, XWPFTable table)
      inserts a new Table at position pos

    • getTableCell

      XWPFTableCell getTableCell(CTTc cell)
      returns the TableCell to which the Table belongs

    • getXWPFDocument

      XWPFDocument getXWPFDocument()
      Return XWPFDocument