|
![]() |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.lowagie.text.rtf.RtfElement
com.lowagie.text.rtf.document.RtfDocumentHeader
public class RtfDocumentHeader
The RtfDocumentHeader contains all classes required for the generation of the document header area.
Field Summary | |
---|---|
private RtfCodePage |
codePage
The code page to use |
private RtfColorList |
colorList
Stores all the colors used in the document |
private static byte[] |
FACING_PAGES
Constant for facing pages |
private RtfFontList |
fontList
Stores all the fonts used in the document |
private HeaderFooter |
footer
The current RtfHeaderFooterGroup for the footer |
private RtfGenerator |
generator
Generator string in document |
private HeaderFooter |
header
The current RtfHeaderFooterGroup for the header |
private RtfInfoGroup |
infoGroup
The information group with author/subject/keywords/title/producer/creationdate data |
private RtfListTable |
listTable
Manages List tables |
private RtfPageSetting |
pageSetting
The page settings |
private RtfStylesheetList |
stylesheetList
Stores all paragraph styles used in the document. |
private static byte[] |
TITLE_PAGE
Constant for the title page |
Fields inherited from class com.lowagie.text.rtf.RtfElement |
---|
document, inHeader, inTable |
Fields inherited from interface com.lowagie.text.rtf.RtfBasicElement |
---|
CLOSE_GROUP, COMMA_DELIMITER, DELIMITER, OPEN_GROUP, TWIPS_FACTOR |
Constructor Summary | |
---|---|
protected |
RtfDocumentHeader(RtfDocument doc)
Constructs a RtfDocumentHeader for a RtfDocument |
Method Summary | |
---|---|
void |
addInfoElement(RtfInfoElement rtfInfoElement)
Adds an RtfInfoElement to the list of RtfInfoElements |
private RtfHeaderFooterGroup |
convertHeaderFooter(HeaderFooter hf,
int type)
Converts a HeaderFooter into a RtfHeaderFooterGroup. |
void |
freeListNumber(RtfList list)
Removes a RtfList from the list table |
int |
getColorNumber(RtfColor color)
Gets the number of the specified RtfColor |
int |
getFontNumber(RtfFont font)
Gets the number of the specified RtfFont |
int |
getListNumber(RtfList list)
Gets the number of the specified RtfList |
RtfPageSetting |
getPageSetting()
Gets the RtfPageSetting object of this RtfDocument |
RtfParagraphStyle |
getRtfParagraphStyle(java.lang.String styleName)
Gets the RtfParagraphStyle with the given style name. |
protected void |
init()
Initialises the RtfDocumentHeader. |
void |
registerParagraphStyle(RtfParagraphStyle rtfParagraphStyle)
Registers the RtfParagraphStyle for further use in the document. |
void |
setFooter(HeaderFooter footer)
Sets the current footer to use |
void |
setHeader(HeaderFooter header)
Sets the current header to use |
byte[] |
write()
Deprecated. As of iText 2.0.6 or earlier, replaced by writeContent(OutputStream) , scheduled for removal at or after 2.1.0 |
void |
writeContent(java.io.OutputStream result)
Writes the element content to the given output stream. |
byte[] |
writeSectionDefinition()
Deprecated. As of iText 2.0.6 or earlier, replaced by writeSectionDefinition(OutputStream) , scheduled for removal at or after 2.1.0 |
void |
writeSectionDefinition(java.io.OutputStream result)
Writes the section definition data |
Methods inherited from class com.lowagie.text.rtf.RtfElement |
---|
intToByteArray, isInTable, setInHeader, setInTable, setRtfDocument |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
private static final byte[] TITLE_PAGE
private static final byte[] FACING_PAGES
private RtfCodePage codePage
private RtfColorList colorList
private RtfFontList fontList
private RtfListTable listTable
private RtfStylesheetList stylesheetList
private RtfGenerator generator
private RtfInfoGroup infoGroup
private RtfPageSetting pageSetting
private HeaderFooter header
private HeaderFooter footer
Constructor Detail |
---|
protected RtfDocumentHeader(RtfDocument doc)
doc
- The RtfDocument this RtfDocumentHeader belongs toMethod Detail |
---|
protected void init()
public byte[] write()
writeContent(OutputStream)
, scheduled for removal at or after 2.1.0
write
in interface RtfBasicElement
write
in class RtfElement
public void writeContent(java.io.OutputStream result) throws java.io.IOException
writeContent
in interface RtfBasicElement
writeContent
in class RtfElement
java.io.IOException
public byte[] writeSectionDefinition()
writeSectionDefinition(OutputStream)
, scheduled for removal at or after 2.1.0
public void writeSectionDefinition(java.io.OutputStream result)
result
- public int getFontNumber(RtfFont font)
font
- The RtfFont for which to get the number
public int getColorNumber(RtfColor color)
color
- The RtfColor for which to get the number
public int getListNumber(RtfList list)
list
- The RtfList for which to get the number
public RtfParagraphStyle getRtfParagraphStyle(java.lang.String styleName)
styleName
- The style name of the RtfParagraphStyle to get.
public void freeListNumber(RtfList list)
list
- The RtfList to removepublic RtfPageSetting getPageSetting()
public void addInfoElement(RtfInfoElement rtfInfoElement)
rtfInfoElement
- The RtfInfoElement to addpublic void setHeader(HeaderFooter header)
header
- The HeaderFooter to use as headerpublic void setFooter(HeaderFooter footer)
footer
- The HeaderFooter to use as footerpublic void registerParagraphStyle(RtfParagraphStyle rtfParagraphStyle)
rtfParagraphStyle
- The RtfParagraphStyle to register.private RtfHeaderFooterGroup convertHeaderFooter(HeaderFooter hf, int type)
hf
- The HeaderFooter to convert.type
- Whether the conversion is being done on a footer or header
RtfHeaderFooter
,
RtfHeaderFooterGroup
|
![]() |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |