|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.poi.xwpf.model.XWPFHeaderFooterPolicy
public class XWPFHeaderFooterPolicy
A .docx file can have no headers/footers, the same header/footer on each page, odd/even page footers, and optionally also a different header/footer on the first page. This class handles sorting out what there is, and giving you the right headers and footers for the document.
Constructor Summary | |
---|---|
XWPFHeaderFooterPolicy(XWPFDocument doc)
Figures out the policy for the given document, and creates any header and footer objects as required. |
Method Summary | |
---|---|
XWPFFooter |
getDefaultFooter()
|
XWPFHeader |
getDefaultHeader()
|
XWPFFooter |
getEvenPageFooter()
|
XWPFHeader |
getEvenPageHeader()
|
XWPFFooter |
getFirstPageFooter()
|
XWPFHeader |
getFirstPageHeader()
|
XWPFFooter |
getFooter(int pageNumber)
Get the footer that applies to the given (1 based) page. |
XWPFHeader |
getHeader(int pageNumber)
Get the header that applies to the given (1 based) page. |
XWPFFooter |
getOddPageFooter()
Returns the odd page footer. |
XWPFHeader |
getOddPageHeader()
Returns the odd page header. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public XWPFHeaderFooterPolicy(XWPFDocument doc) throws java.io.IOException, org.apache.xmlbeans.XmlException
java.io.IOException
org.apache.xmlbeans.XmlException
Method Detail |
---|
public XWPFHeader getFirstPageHeader()
public XWPFFooter getFirstPageFooter()
public XWPFHeader getOddPageHeader()
public XWPFFooter getOddPageFooter()
public XWPFHeader getEvenPageHeader()
public XWPFFooter getEvenPageFooter()
public XWPFHeader getDefaultHeader()
public XWPFFooter getDefaultFooter()
public XWPFHeader getHeader(int pageNumber)
pageNumber
- The one based page numberpublic XWPFFooter getFooter(int pageNumber)
pageNumber
- The one based page number
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |