Package org.apache.poi.xwpf.usermodel

Class XWPFFooter

java.lang.Object

org.apache.poi.POIXMLDocumentPart

org.apache.poi.xwpf.usermodel.XWPFHeaderFooter

org.apache.poi.xwpf.usermodel.XWPFFooter

All Implemented Interfaces:

IBody

public class XWPFFooter
extends XWPFHeaderFooter

Sketch of XWPF footer class

Field Summary

Fields inherited from class org.apache.poi.POIXMLDocumentPart

DEFAULT_XML_OPTIONS

Constructor Summary

Constructors

Constructor	Description
XWPFFooter()
XWPFFooter(POIXMLDocumentPart parent, PackagePart part, PackageRelationship rel)
XWPFFooter(XWPFDocument doc, org.openxmlformats.schemas.wordprocessingml.x2006.main.CTHdrFtr hdrFtr)

Method Summary

Modifier and Type	Method	Description
protected void	commit()	save and commit footer
BodyType	getPartType()	get the PartType of the body
protected void	onDocumentRead()	Fired when a package part is read

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from class org.apache.poi.POIXMLDocumentPart

addRelation, createRelationship, createRelationship, createRelationship, getPackagePart, getPackageRelationship, getParent, getRelationById, getRelationId, getRelations, getTargetPart, onDocumentCreate, onDocumentRemove, onSave, prepareForCommit, read, rebase, removeRelation, removeRelation, toString

Methods inherited from class org.apache.poi.xwpf.usermodel.XWPFHeaderFooter

_getHdrFtr, addPictureData, addPictureData, getAllPackagePictures, getAllPictures, getBodyElements, getListParagraph, getOwner, getParagraph, getParagraphArray, getParagraphs, getPart, getPictureDataByID, getTable, getTableArray, getTableCell, getTables, getText, getXWPFDocument, insertNewParagraph, insertNewTbl, insertTable, readHdrFtr, setHeaderFooter, setXWPFDocument

Constructor Detail

XWPFFooter

public XWPFFooter()

XWPFFooter

public XWPFFooter(XWPFDocument doc,
                  org.openxmlformats.schemas.wordprocessingml.x2006.main.CTHdrFtr hdrFtr)
           throws java.io.IOException

Throws:

java.io.IOException

XWPFFooter

public XWPFFooter(POIXMLDocumentPart parent,
                  PackagePart part,
                  PackageRelationship rel)
           throws java.io.IOException

Throws:

java.io.IOException

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

Description copied from class: POIXMLDocumentPart

Fired when a package part is read

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()