moparisthebest/poi
1
0
Fork 0
Code Issues Pull Requests Releases 1 Wiki Activity

Add some javadocs for the XWPF Header/Footer creation methods

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1575594 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Nick Burch 2014-03-08 19:33:07 +00:00
parent 7e21a14172
commit 70e1b5edeb
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
src/ooxml/java/org/apache/poi/xwpf/model/XWPFHeaderFooterPolicy.java
View File

@ -149,10 +149,19 @@ public class XWPFHeaderFooterPolicy {
} }
} }
/**
* Creates an empty header of the specified type, to
* which you can then create paragraphs and set text etc.
*/
public XWPFHeader createHeader(Enum type) throws IOException { public XWPFHeader createHeader(Enum type) throws IOException {
return createHeader(type, null); return createHeader(type, null);
} }
/**
* Creates a new header of the specified type, to which the
* supplied (and previously unattached!) paragraphs are
* added to.
*/
public XWPFHeader createHeader(Enum type, XWPFParagraph[] pars) throws IOException { public XWPFHeader createHeader(Enum type, XWPFParagraph[] pars) throws IOException {
XWPFRelation relation = XWPFRelation.HEADER; XWPFRelation relation = XWPFRelation.HEADER;
String pStyle = "Header"; String pStyle = "Header";
@ -174,10 +183,19 @@ public class XWPFHeaderFooterPolicy {
return wrapper; return wrapper;
} }
/**
* Creates an empty footer of the specified type, to
* which you can then create paragraphs and set text etc.
*/
public XWPFFooter createFooter(Enum type) throws IOException { public XWPFFooter createFooter(Enum type) throws IOException {
return createFooter(type, null); return createFooter(type, null);
} }
/**
* Creates a new footer of the specified type, to which the
* supplied (and previously unattached!) paragraphs are
* added to.
*/
public XWPFFooter createFooter(Enum type, XWPFParagraph[] pars) throws IOException { public XWPFFooter createFooter(Enum type, XWPFParagraph[] pars) throws IOException {
XWPFRelation relation = XWPFRelation.FOOTER; XWPFRelation relation = XWPFRelation.FOOTER;
String pStyle = "Footer"; String pStyle = "Footer";