public class XWPFHeaderFooterPolicy extends Object
Modifier and Type | Field and Description |
---|---|
static STHdrFtr.Enum |
DEFAULT |
static STHdrFtr.Enum |
EVEN |
static STHdrFtr.Enum |
FIRST |
Constructor and Description |
---|
XWPFHeaderFooterPolicy(XWPFDocument doc)
Figures out the policy for the given document,
and creates any header and footer objects
as required.
|
XWPFHeaderFooterPolicy(XWPFDocument doc,
CTSectPr sectPr)
Figures out the policy for the given document,
and creates any header and footer objects
as required.
|
Modifier and Type | Method and Description |
---|---|
XWPFFooter |
createFooter(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(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(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(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(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.
|
XWPFFooter |
getFooter(STHdrFtr.Enum type)
Get this section footer for the given type
|
XWPFHeader |
getHeader(int pageNumber)
Get the header that applies to the given
(1 based) page.
|
XWPFHeader |
getHeader(STHdrFtr.Enum type)
Get this section header for the given type
|
XWPFFooter |
getOddPageFooter()
Returns the odd page footer.
|
XWPFHeader |
getOddPageHeader()
Returns the odd page header.
|
public static final STHdrFtr.Enum DEFAULT
public static final STHdrFtr.Enum EVEN
public static final STHdrFtr.Enum FIRST
public XWPFHeaderFooterPolicy(XWPFDocument doc)
public XWPFHeaderFooterPolicy(XWPFDocument doc, CTSectPr sectPr)
public XWPFHeader createHeader(STHdrFtr.Enum type)
public XWPFHeader createHeader(STHdrFtr.Enum type, XWPFParagraph[] pars)
public XWPFFooter createFooter(STHdrFtr.Enum type)
public XWPFFooter createFooter(STHdrFtr.Enum type, XWPFParagraph[] pars)
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 XWPFHeader getHeader(STHdrFtr.Enum type)
type
- of header to returnXWPFHeader
objectpublic XWPFFooter getFooter(int pageNumber)
pageNumber
- The one based page numberpublic XWPFFooter getFooter(STHdrFtr.Enum type)
type
- of footer to returnXWPFFooter
objectpublic void createWatermark(String text)
Copyright © 2010 - 2020 Adobe. All Rights Reserved