com.lowagie.text.rtf.headerfooter
public class RtfHeaderFooterGroup extends HeaderFooter implements RtfBasicElement
Version: $Id: RtfHeaderFooterGroup.java 2776 2007-05-23 20:01:40Z hallm $
Field Summary | |
---|---|
RtfDocument | document
The RtfDocument this RtfHeaderFooterGroup belongs to |
RtfHeaderFooter | headerAll
The RtfHeaderFooter for all pages |
RtfHeaderFooter | headerFirst
The RtfHeaderFooter for the first page |
RtfHeaderFooter | headerLeft
The RtfHeaderFooter for the left hand pages |
RtfHeaderFooter | headerRight
The RtfHeaderFooter for the right hand pages |
int | mode
The current mode of this RtfHeaderFooterGroup. |
static int | MODE_MULTIPLE
This RtfHeaderFooterGroup contains two or three RtfHeaderFooter objects |
static int | MODE_NONE
This RtfHeaderFooterGroup contains no RtfHeaderFooter objects |
static int | MODE_SINGLE
This RtfHeaderFooterGroup contains one RtfHeaderFooter object |
int | type
The current type of this RtfHeaderFooterGroup. |
Constructor Summary | |
---|---|
RtfHeaderFooterGroup()
Constructs a RtfHeaderGroup to which you add headers/footers using
via the setHeaderFooter method.
| |
RtfHeaderFooterGroup(RtfDocument doc, int type)
Constructs a certain type of RtfHeaderFooterGroup. | |
RtfHeaderFooterGroup(RtfDocument doc, RtfHeaderFooterGroup headerFooter, int type)
Constructs a RtfHeaderFooterGroup by copying the content of the original
RtfHeaderFooterGroup
| |
RtfHeaderFooterGroup(RtfDocument doc, RtfHeaderFooter headerFooter, int type)
Constructs a RtfHeaderFooterGroup for a certain RtfHeaderFooter.
| |
RtfHeaderFooterGroup(RtfDocument doc, HeaderFooter headerFooter, int type)
Constructs a RtfHeaderGroup for a certain HeaderFooter
|
Method Summary | |
---|---|
protected RtfHeaderFooter | getHeaderAll()
Gets the RtfHeaderFooter for all pages
|
protected RtfHeaderFooter | getHeaderFirst()
Gets the RtfHeaderFooter for the title page
|
protected RtfHeaderFooter | getHeaderLeft()
Gets the RtfHeaderFooter for all left hand pages
|
protected RtfHeaderFooter | getHeaderRight()
Gets the RtfHeaderFooter for all right hand pages
|
protected int | getMode()
Gets the mode of this RtfHeaderFooterGroup
|
boolean | hasFacingPages()
Get whether this RtfHeaderFooterGroup has facing pages
|
boolean | hasTitlePage()
Get whether this RtfHeaderFooterGroup has a titlepage
|
void | setHasFacingPages()
Set that this RtfHeaderFooterGroup should have facing pages. |
void | setHasTitlePage()
Set that this RtfHeaderFooterGroup should have a title page. |
void | setHeaderFooter(RtfHeaderFooter headerFooter, int displayAt)
Set a RtfHeaderFooter to be displayed at a certain position
|
void | setHeaderFooter(HeaderFooter headerFooter, int displayAt)
Set a HeaderFooter to be displayed at a certain position
|
void | setInHeader(boolean inHeader)
Unused |
void | setInTable(boolean inTable)
Unused |
void | setRtfDocument(RtfDocument doc)
Sets the RtfDocument this RtfElement belongs to
|
void | setType(int type)
Set the type of this RtfHeaderFooterGroup. |
byte[] | write()
Write the content of this RtfHeaderFooterGroup.
|
void | writeContent(OutputStream result)
Write the content of this RtfHeaderFooterGroup. |
Parameters: doc The RtfDocument this RtfHeaderFooter belongs to type The type of RtfHeaderFooterGroup to create
Parameters: doc The RtfDocument this RtfHeaderFooter belongs to headerFooter The RtfHeaderFooterGroup to copy type The type of RtfHeaderFooterGroup to create
Parameters: doc The RtfDocument this RtfHeaderFooter belongs to headerFooter The RtfHeaderFooter to display type The typ of RtfHeaderFooterGroup to create
Parameters: doc The RtfDocument this RtfHeaderFooter belongs to headerFooter The HeaderFooter to display type The typ of RtfHeaderFooterGroup to create
Returns: The RtfHeaderFooter for all pages
Returns: The RtfHeaderFooter for the title page
Returns: The RtfHeaderFooter for all left hand pages
Returns: The RtfHeaderFooter for all right hand pages
Returns: The mode of this RtfHeaderFooterGroup
Returns: Whether this RtfHeaderFooterGroup has facing pages
Returns: Whether this RtfHeaderFooterGroup has a titlepage
Parameters: headerFooter The RtfHeaderFooter to display displayAt The display location to use
Parameters: headerFooter The HeaderFooter to set displayAt The display location to use
Parameters: inHeader
Parameters: inTable
Parameters: doc The RtfDocument to use
Parameters: type The type to use
Deprecated: replaced by writeContent
Write the content of this RtfHeaderFooterGroup.Returns: A byte array with the content of this RtfHeaderFooterGroup