Package org.apache.poi.xwpf.usermodel
Interface IBody
-
- All Known Implementing Classes:
XWPFAbstractFootnoteEndnote,XWPFComment,XWPFDocument,XWPFEndnote,XWPFFooter,XWPFFootnote,XWPFHeader,XWPFHeaderFooter,XWPFTableCell
public interface IBodyAn 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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description List<IBodyElement>getBodyElements()Returns an Iterator with paragraphs and tables, in the order that they occur in the text.XWPFParagraphgetParagraph(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTP p)Returns the paragraph corresponding to the providedCTP.XWPFParagraphgetParagraphArray(int pos)Returns the paragraph that of position posList<XWPFParagraph>getParagraphs()Returns the paragraph(s) that holds the text of the header or footer.POIXMLDocumentPartgetPart()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.BodyTypegetPartType()get the PartType of the body, for example DOCUMENT, HEADER, FOOTER, FOOTNOTE,XWPFTablegetTable(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTbl ctTable)XWPFTablegetTableArray(int pos)Returns the table at position posXWPFTableCellgetTableCell(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTc cell)returns the TableCell to which the Table belongsList<XWPFTable>getTables()Return the table(s) that holds the text of the IBodyPart, for complex cases where a paragraph isn't used.XWPFDocumentgetXWPFDocument()Return XWPFDocumentXWPFParagraphinsertNewParagraph(XmlCursor cursor)inserts a new paragraph at position of the cursorXWPFTableinsertNewTbl(XmlCursor cursor)inserts a new Table at the cursor position.voidinsertTable(int pos, XWPFTable table)inserts a new Table at position pos
-
-
-
Method Detail
-
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(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTP p)
Returns the paragraph corresponding to the providedCTP.- Parameters:
p- is instance of CTP and is searching for an XWPFParagraph- Returns:
- The paragraph corresponding to the
CTP, ornullif there is no corresponding paragraph in this body.
-
getTable
XWPFTable getTable(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTbl ctTable)
-
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
-
insertTable
void insertTable(int pos, XWPFTable table)inserts a new Table at position pos
-
getTableCell
XWPFTableCell getTableCell(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTc cell)
returns the TableCell to which the Table belongs
-
getXWPFDocument
XWPFDocument getXWPFDocument()
Return XWPFDocument
-
-