public class XWPFHeaderFooterPolicy
extends java.lang.Object
Modifier and Type | Field | Description |
---|---|---|
static org.openxmlformats.schemas.wordprocessingml.x2006.main.STHdrFtr.Enum |
DEFAULT |
|
static org.openxmlformats.schemas.wordprocessingml.x2006.main.STHdrFtr.Enum |
EVEN |
|
static org.openxmlformats.schemas.wordprocessingml.x2006.main.STHdrFtr.Enum |
FIRST |
Constructor | Description |
---|---|
XWPFHeaderFooterPolicy(XWPFDocument doc) |
Figures out the policy for the given document,
and creates any header and footer objects
as required.
|
XWPFHeaderFooterPolicy(XWPFDocument doc,
org.openxmlformats.schemas.wordprocessingml.x2006.main.CTSectPr sectPr) |
Figures out the policy for the given document,
and creates any header and footer objects
as required.
|
Modifier and Type | Method | Description |
---|---|---|
XWPFFooter |
createFooter(org.openxmlformats.schemas.wordprocessingml.x2006.main.STHdrFtr.Enum type) |
Creates an empty footer of the specified type, containing a single
empty paragraph, to which you can then set text, add more paragraphs etc.
|
XWPFFooter |
createFooter(org.openxmlformats.schemas.wordprocessingml.x2006.main.STHdrFtr.Enum type,
XWPFParagraph[] pars) |
Creates a new footer of the specified type, to which the
supplied (and previously unattached!) paragraphs are
added to.
|
XWPFHeader |
createHeader(org.openxmlformats.schemas.wordprocessingml.x2006.main.STHdrFtr.Enum type) |
Creates an empty header of the specified type, containing a single
empty paragraph, to which you can then set text, add more paragraphs etc.
|
XWPFHeader |
createHeader(org.openxmlformats.schemas.wordprocessingml.x2006.main.STHdrFtr.Enum type,
XWPFParagraph[] pars) |
Creates a new header of the specified type, to which the
supplied (and previously unattached!) paragraphs are
added to.
|
void |
createWatermark(java.lang.String text) |
|
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.
|
public static final org.openxmlformats.schemas.wordprocessingml.x2006.main.STHdrFtr.Enum DEFAULT
public static final org.openxmlformats.schemas.wordprocessingml.x2006.main.STHdrFtr.Enum EVEN
public static final org.openxmlformats.schemas.wordprocessingml.x2006.main.STHdrFtr.Enum FIRST
public XWPFHeaderFooterPolicy(XWPFDocument doc) throws java.io.IOException, org.apache.xmlbeans.XmlException
java.io.IOException
org.apache.xmlbeans.XmlException
public XWPFHeaderFooterPolicy(XWPFDocument doc, org.openxmlformats.schemas.wordprocessingml.x2006.main.CTSectPr sectPr) throws java.io.IOException, org.apache.xmlbeans.XmlException
java.io.IOException
org.apache.xmlbeans.XmlException
public XWPFHeader createHeader(org.openxmlformats.schemas.wordprocessingml.x2006.main.STHdrFtr.Enum type) throws java.io.IOException
java.io.IOException
public XWPFHeader createHeader(org.openxmlformats.schemas.wordprocessingml.x2006.main.STHdrFtr.Enum type, XWPFParagraph[] pars) throws java.io.IOException
java.io.IOException
public XWPFFooter createFooter(org.openxmlformats.schemas.wordprocessingml.x2006.main.STHdrFtr.Enum type) throws java.io.IOException
java.io.IOException
public XWPFFooter createFooter(org.openxmlformats.schemas.wordprocessingml.x2006.main.STHdrFtr.Enum type, XWPFParagraph[] pars) throws java.io.IOException
java.io.IOException
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 numberpublic void createWatermark(java.lang.String text)
Copyright 2018 The Apache Software Foundation or its licensors, as applicable.