Overview Package Class Use Tree Deprecated Index Help
Prev Class Next Class Frames NoFrames All Classes
Summary: Nested Field Constr Method Detail: Field Constr Method
com.lowagie.text.rtf.headerfooter
public class RtfHeaderFooter extends HeaderFooter implements RtfBasicElement
Version: $Id: RtfHeaderFooter.java 3373 2008-05-12 16:21:24Z xlv $
| Field Summary | |
|---|---|
| Object[] | content
The content of this RtfHeaderFooter |
| int | displayAt
The display location of this RtfHeaderFooter. |
| RtfDocument | document
The RtfDocument this RtfHeaderFooter belongs to |
| static int | DISPLAY_ALL_PAGES
Constant for displaying the header/footer on all pages |
| static int | DISPLAY_FIRST_PAGE
Constant for displaying the header/footer on the first page |
| static int | DISPLAY_LEFT_PAGES
Constant for displaying the header/footer on all left hand pages |
| static int | DISPLAY_RIGHT_PAGES
Constant for displaying the header/footer on all right hand pages |
| static byte[] | FOOTER_ALL
Constant for a footer on all pages |
| static byte[] | FOOTER_FIRST
Constant for a footer on the first page |
| static byte[] | FOOTER_LEFT
Constant for a footer on the left hand pages |
| static byte[] | FOOTER_RIGHT
Constant for a footer on the right hand pages |
| static byte[] | HEADER_ALL
Constant for a header on all pages |
| static byte[] | HEADER_FIRST
Constant for a header on the first page |
| static byte[] | HEADER_LEFT
Constant for a header on all left hand pages |
| static byte[] | HEADER_RIGHT
Constant for a header on all right hand pages |
| int | type
The display type of this RtfHeaderFooter. |
| static int | TYPE_FOOTER
Constant for the footer type |
| static int | TYPE_HEADER
Constant for the header type |
| Constructor Summary | |
|---|---|
| protected | RtfHeaderFooter(RtfDocument doc, HeaderFooter headerFooter, int type, int displayAt)
Constructs a RtfHeaderFooter based on a HeaderFooter with a certain type and displayAt
location. |
| protected | RtfHeaderFooter(RtfDocument doc, RtfHeaderFooter headerFooter, int displayAt)
Constructs a RtfHeaderFooter as a copy of an existing RtfHeaderFooter.
|
| protected | RtfHeaderFooter(RtfDocument doc, HeaderFooter headerFooter)
Constructs a RtfHeaderFooter for a HeaderFooter.
|
| RtfHeaderFooter(Element element)
Constructs a RtfHeaderFooter for any Element.
| |
| RtfHeaderFooter(Element[] elements)
Constructs a RtfHeaderFooter for an array of Elements.
| |
| Method Summary | |
|---|---|
| Object[] | getContent()
Gets the content of this RtfHeaderFooter
|
| void | setAlignment(int alignment)
Set the alignment of this RtfHeaderFooter. |
| void | setDisplayAt(int displayAt)
Sets the display location of this RtfHeaderFooter
|
| 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)
Sets the type of this RtfHeaderFooter
|
| void | writeContent(OutputStream result)
Writes the content of this RtfHeaderFooter |
Parameters: doc The RtfDocument this RtfHeaderFooter belongs to headerFooter The HeaderFooter to base this RtfHeaderFooter on type The type of RtfHeaderFooter displayAt The display location of this RtfHeaderFooter
Parameters: doc The RtfDocument this RtfHeaderFooter belongs to headerFooter The RtfHeaderFooter to copy displayAt The display location of this RtfHeaderFooter
Parameters: doc The RtfDocument this RtfHeaderFooter belongs to headerFooter The HeaderFooter to base this RtfHeaderFooter on
Parameters: element The Element to display as content of this RtfHeaderFooter
Parameters: elements The Elements to display as the content of this RtfHeaderFooter.
Returns: The content of this RtfHeaderFooter
Parameters: displayAt The display location to use.
Parameters: inHeader
Parameters: inTable
Parameters: doc The RtfDocument to use
Parameters: type The type to use.