org.apache.poi.xwpf.usermodel
Class XWPFHeader

java.lang.Object
  extended by org.apache.poi.POIXMLDocumentPart
      extended by org.apache.poi.xwpf.usermodel.XWPFHeaderFooter
          extended by org.apache.poi.xwpf.usermodel.XWPFHeader
All Implemented Interfaces:
IBody

public class XWPFHeader
extends XWPFHeaderFooter

Sketch of XWPF header class


Nested Class Summary
 
Nested classes/interfaces inherited from class org.apache.poi.POIXMLDocumentPart
POIXMLDocumentPart.RelationPart
 
Constructor Summary
XWPFHeader()
           
XWPFHeader(POIXMLDocumentPart parent, PackagePart part)
           
XWPFHeader(POIXMLDocumentPart parent, PackagePart part, PackageRelationship rel)
          Deprecated. in POI 3.14, scheduled for removal in POI 3.16
XWPFHeader(XWPFDocument doc, org.openxmlformats.schemas.wordprocessingml.x2006.main.CTHdrFtr hdrFtr)
           
 
Method Summary
protected  void commit()
          save and commit footer
 BodyType getPartType()
          get the PartType of the body
protected  void onDocumentRead()
          reads the document
 
Methods inherited from class org.apache.poi.xwpf.usermodel.XWPFHeaderFooter
_getHdrFtr, addPictureData, addPictureData, createParagraph, getAllPackagePictures, getAllPictures, getBodyElements, getListParagraph, getOwner, getParagraph, getParagraphArray, getParagraphs, getPart, getPictureDataByID, getTable, getTableArray, getTableCell, getTables, getText, getXWPFDocument, insertNewParagraph, insertNewTbl, insertTable, readHdrFtr, setHeaderFooter, setXWPFDocument
 
Methods inherited from class org.apache.poi.POIXMLDocumentPart
_invokeOnDocumentRead, addRelation, addRelation, createRelationship, createRelationship, createRelationship, getPackagePart, getPackageRelationship, getParent, getRelationById, getRelationId, getRelationParts, getRelations, getTargetPart, onDocumentCreate, onDocumentRemove, onSave, prepareForCommit, read, rebase, removeRelation, removeRelation, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

XWPFHeader

public XWPFHeader()

XWPFHeader

public XWPFHeader(POIXMLDocumentPart parent,
                  PackagePart part)
           throws java.io.IOException
Throws:
java.io.IOException
Since:
POI 3.14-Beta1

XWPFHeader

@Deprecated
public XWPFHeader(POIXMLDocumentPart parent,
                             PackagePart part,
                             PackageRelationship rel)
           throws java.io.IOException
Deprecated. in POI 3.14, scheduled for removal in POI 3.16

Throws:
java.io.IOException

XWPFHeader

public XWPFHeader(XWPFDocument doc,
                  org.openxmlformats.schemas.wordprocessingml.x2006.main.CTHdrFtr hdrFtr)
Method Detail

commit

protected void commit()
               throws java.io.IOException
save and commit footer

Overrides:
commit in class POIXMLDocumentPart
Throws:
java.io.IOException

onDocumentRead

protected void onDocumentRead()
                       throws java.io.IOException
reads the document

Overrides:
onDocumentRead in class XWPFHeaderFooter
Throws:
java.io.IOException

getPartType

public BodyType getPartType()
get the PartType of the body

Returns:
the PartType of the body
See Also:
IBody.getPartType()


Copyright 2016 The Apache Software Foundation or its licensors, as applicable.