org.apache.poi.xwpf.usermodel
Class XWPFHeaderFooter

java.lang.Object
  extended by org.apache.poi.xwpf.usermodel.XWPFHeaderFooter
Direct Known Subclasses:
XWPFFooter, XWPFHeader

public abstract class XWPFHeaderFooter
extends java.lang.Object

Parent of XWPF headers and footers


Field Summary
protected  org.openxmlformats.schemas.wordprocessingml.x2006.main.CTHdrFtr headerFooter
           
 
Constructor Summary
protected XWPFHeaderFooter()
           
protected XWPFHeaderFooter(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTHdrFtr hdrFtr)
           
 
Method Summary
 org.openxmlformats.schemas.wordprocessingml.x2006.main.CTHdrFtr _getHdrFtr()
           
 XWPFParagraph[] getParagraphs()
          Returns the paragraph(s) that holds the text of the header or footer.
 XWPFTable[] getTables()
          Return the table(s) that holds the text of the header or footer, for complex cases where a paragraph isn't used.
 java.lang.String getText()
          Returns the textual content of the header/footer, by flattening out the text of its paragraph(s)
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

headerFooter

protected org.openxmlformats.schemas.wordprocessingml.x2006.main.CTHdrFtr headerFooter
Constructor Detail

XWPFHeaderFooter

protected XWPFHeaderFooter(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTHdrFtr hdrFtr)

XWPFHeaderFooter

protected XWPFHeaderFooter()
Method Detail

_getHdrFtr

public org.openxmlformats.schemas.wordprocessingml.x2006.main.CTHdrFtr _getHdrFtr()

getParagraphs

public XWPFParagraph[] getParagraphs()
Returns the paragraph(s) that holds the text of the header or footer. Normally there is only the one paragraph, but there could be more in certain cases, or a table.


getTables

public XWPFTable[] getTables()
Return the table(s) that holds the text of the header or footer, for complex cases where a paragraph isn't used. Normally there's just one paragraph, but some complex headers/footers have a table or two in addition.


getText

public java.lang.String getText()
Returns the textual content of the header/footer, by flattening out the text of its paragraph(s)



Copyright 2008 The Apache Software Foundation or its licensors, as applicable.