Package org.apache.poi.xwpf.usermodel
Class XWPFHeader
java.lang.Object
org.apache.poi.ooxml.POIXMLDocumentPart
org.apache.poi.xwpf.usermodel.XWPFHeaderFooter
org.apache.poi.xwpf.usermodel.XWPFHeader
- All Implemented Interfaces:
IBody
Sketch of XWPF header class
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.poi.ooxml.POIXMLDocumentPart
POIXMLDocumentPart.RelationPart
-
Constructor Summary
ConstructorsConstructorDescriptionXWPFHeader
(POIXMLDocumentPart parent, PackagePart part) XWPFHeader
(XWPFDocument doc, org.openxmlformats.schemas.wordprocessingml.x2006.main.CTHdrFtr hdrFtr) -
Method Summary
Modifier and TypeMethodDescriptionprotected void
commit()
save and commit footerget the PartType of the bodyprotected void
reads the documentMethods inherited from class org.apache.poi.xwpf.usermodel.XWPFHeaderFooter
_getHdrFtr, addPictureData, addPictureData, clearHeaderFooter, createParagraph, createTable, getAllPackagePictures, getAllPictures, getBodyElements, getListParagraph, getOwner, getParagraph, getParagraphArray, getParagraphs, getPart, getPictureDataByID, getTable, getTableArray, getTableCell, getTables, getText, getXWPFDocument, insertNewParagraph, insertNewTbl, insertTable, prepareForCommit, readHdrFtr, removeParagraph, removeTable, setHeaderFooter, setXWPFDocument
Methods inherited from class org.apache.poi.ooxml.POIXMLDocumentPart
_invokeOnDocumentRead, addRelation, createRelationship, createRelationship, createRelationship, getNextPartNumber, getPackagePart, getParent, getRelationById, getRelationId, getRelationPartById, getRelationParts, getRelations, getTargetPart, isCommited, onDocumentCreate, onDocumentRemove, onSave, read, rebase, removeRelation, removeRelation, removeRelation, setCommited, toString
-
Constructor Details
-
XWPFHeader
public XWPFHeader() -
XWPFHeader
- Throws:
IOException
- Since:
- POI 3.14-Beta1
-
XWPFHeader
public XWPFHeader(XWPFDocument doc, org.openxmlformats.schemas.wordprocessingml.x2006.main.CTHdrFtr hdrFtr)
-
-
Method Details
-
commit
save and commit footer- Overrides:
commit
in classPOIXMLDocumentPart
- Throws:
IOException
- a subclass may throw an IOException if the changes can't be committed
-
onDocumentRead
reads the document- Overrides:
onDocumentRead
in classXWPFHeaderFooter
- Throws:
IOException
-
getPartType
get the PartType of the body- Returns:
- the PartType of the body
- See Also:
-