Package org.apache.poi.xwpf.usermodel
Interface IBody
- All Known Implementing Classes:
XWPFAbstractFootnoteEndnote,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 Summary
Modifier and TypeMethodDescriptionReturns an Iterator with paragraphs and tables, in the order that they occur in the text.getParagraph(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTP p) if there is a correspondingXWPFParagraphof the parameter ctTable in the paragraphList of this header or footer the method will return this paragraph if there is no correspondingXWPFParagraphthe method will return nullgetParagraphArray(int pos) Returns the paragraph that of position posReturns the paragraph(s) that holds the text of the header or footer.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.get the PartType of the body, for example DOCUMENT, HEADER, FOOTER, FOOTNOTE,getTable(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTbl ctTable) getTableArray(int pos) Returns the table at position posgetTableCell(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTc cell) returns the TableCell to which the Table belongsReturn the table(s) that holds the text of the IBodyPart, for complex cases where a paragraph isn't used.Return XWPFDocumentinsertNewParagraph(org.apache.xmlbeans.XmlCursor cursor) inserts a new paragraph at position of the cursorinsertNewTbl(org.apache.xmlbeans.XmlCursor cursor) inserts a new Table at the cursor position.voidinsertTable(int pos, XWPFTable table) inserts a new Table at position pos
-
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
Return the table(s) that holds the text of the IBodyPart, for complex cases where a paragraph isn't used. -
getParagraph
if there is a correspondingXWPFParagraphof the parameter ctTable in the paragraphList of this header or footer the method will return this paragraph if there is no correspondingXWPFParagraphthe method will return null- Parameters:
p- is instance of CTP and is searching for an XWPFParagraph- Returns:
- null if there is no XWPFParagraph with an corresponding CTPparagraph in the paragraphList of this header or footer XWPFParagraph with the correspondig CTP p
-
getTable
if there is a correspondingXWPFTableof the parameter ctTable in the tableList of this header the method will return this table if there is no correspondingXWPFTablethe method will return null- Parameters:
ctTable-
-
getParagraphArray
Returns the paragraph that of position pos -
getTableArray
Returns the table at position pos -
insertNewParagraph
inserts a new paragraph at position of the cursor- Parameters:
cursor-
-
insertNewTbl
inserts a new Table at the cursor position.- Parameters:
cursor-
-
insertTable
inserts a new Table at position pos- Parameters:
pos-table-
-
getTableCell
returns the TableCell to which the Table belongs- Parameters:
cell-
-
getXWPFDocument
XWPFDocument getXWPFDocument()Return XWPFDocument
-