com.lowagie.text.rtf.document

Class RtfDocumentHeader

public class RtfDocumentHeader extends RtfElement

The RtfDocumentHeader contains all classes required for the generation of the document header area.

Version: $Id: RtfDocumentHeader.java 3459 2008-05-26 16:27:06Z howard_s $

Author: Mark Hall (Mark.Hall@mail.room3b.eu) Thomas Bickel (tmb99@inode.at) Howard Shank (hgshank@yahoo.com)

Field Summary
RtfCodePage	codePage The code page to use
RtfColorList	colorList Stores all the colors used in the document
RtfFontList	fontList Stores all the fonts used in the document
HeaderFooter	footer The current RtfHeaderFooterGroup for the footer
static byte[]	FACING_PAGES Constant for facing pages
RtfGenerator	generator Generator string in document
HeaderFooter	header The current RtfHeaderFooterGroup for the header
RtfInfoGroup	infoGroup The information group with author/subject/keywords/title/producer/creationdate data
RtfListTable	listTable Manages List tables
RtfPageSetting	pageSetting The page settings
RtfProtectionSetting	protectionSetting The protection settings Author: Howard Shank (hgshank@yahoo.com)
RtfStylesheetList	stylesheetList Stores all paragraph styles used in the document.
static byte[]	TITLE_PAGE Constant for the title page

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
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
RtfListTable	getListTable() Get the `RtfListTable` object.
RtfPageSetting	getPageSetting() Gets the RtfPageSetting object of this RtfDocument
RtfParagraphStyle	getRtfParagraphStyle(String styleName) Gets the RtfParagraphStyle with the given style name.
protected void	init() initializes 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
void	writeContent(OutputStream result) Writes the contents of the document header area.
void	writeSectionDefinition(OutputStream result) Writes the section definition data

Field Detail

codePage

private RtfCodePage codePage

The code page to use

colorList

private RtfColorList colorList

Stores all the colors used in the document

fontList

private RtfFontList fontList

Stores all the fonts used in the document

footer

private HeaderFooter footer

The current RtfHeaderFooterGroup for the footer

FACING_PAGES

private static final byte[] FACING_PAGES

Constant for facing pages

generator

private RtfGenerator generator

Generator string in document

header

private HeaderFooter header

The current RtfHeaderFooterGroup for the header

infoGroup

private RtfInfoGroup infoGroup

The information group with author/subject/keywords/title/producer/creationdate data

listTable

private RtfListTable listTable

Manages List tables

pageSetting

private RtfPageSetting pageSetting

The page settings

protectionSetting

private RtfProtectionSetting protectionSetting

The protection settings Author: Howard Shank (hgshank@yahoo.com)

Since: 2.1.1

stylesheetList

private RtfStylesheetList stylesheetList

Stores all paragraph styles used in the document.

TITLE_PAGE

private static final byte[] TITLE_PAGE

Constant for the title page

Constructor Detail

RtfDocumentHeader

protected RtfDocumentHeader(RtfDocument doc)

Constructs a RtfDocumentHeader for a RtfDocument

Parameters: doc The RtfDocument this RtfDocumentHeader belongs to

Method Detail

addInfoElement

public void addInfoElement(RtfInfoElement rtfInfoElement)

Adds an RtfInfoElement to the list of RtfInfoElements

Parameters: rtfInfoElement The RtfInfoElement to add

convertHeaderFooter

private RtfHeaderFooterGroup convertHeaderFooter(HeaderFooter hf, int type)

Converts a HeaderFooter into a RtfHeaderFooterGroup. Depending on which class the HeaderFooter is, the correct RtfHeaderFooterGroup is created.

Parameters: hf The HeaderFooter to convert. type Whether the conversion is being done on a footer or header

Returns: The converted RtfHeaderFooterGroup.

freeListNumber

public void freeListNumber(RtfList list)

Removes a RtfList from the list table

Parameters: list The RtfList to remove

getColorNumber

public int getColorNumber(RtfColor color)

Gets the number of the specified RtfColor

Parameters: color The RtfColor for which to get the number

Returns: The number of the color

getFontNumber

public int getFontNumber(RtfFont font)

Gets the number of the specified RtfFont

Parameters: font The RtfFont for which to get the number

Returns: The number of the font

getListNumber

public int getListNumber(RtfList list)

Gets the number of the specified RtfList

Parameters: list The RtfList for which to get the number

Returns: The number of the list

getListTable

public RtfListTable getListTable()

Get the RtfListTable object.

Returns: the ListTable object.

Since: 2.1.3

getPageSetting

public RtfPageSetting getPageSetting()

Gets the RtfPageSetting object of this RtfDocument

Returns: The RtfPageSetting object

getRtfParagraphStyle

public RtfParagraphStyle getRtfParagraphStyle(String styleName)

Gets the RtfParagraphStyle with the given style name.

Parameters: styleName The style name of the RtfParagraphStyle to get.

Returns: The RtfParagraphStyle with the given style name or null.

init

protected void init()

initializes the RtfDocumentHeader.

registerParagraphStyle

public void registerParagraphStyle(RtfParagraphStyle rtfParagraphStyle)

Registers the RtfParagraphStyle for further use in the document.

Parameters: rtfParagraphStyle The RtfParagraphStyle to register.

setFooter

public void setFooter(HeaderFooter footer)

Sets the current footer to use

Parameters: footer The HeaderFooter to use as footer

setHeader

public void setHeader(HeaderFooter header)

Sets the current header to use

Parameters: header The HeaderFooter to use as header

writeContent

public void writeContent(OutputStream result)

Writes the contents of the document header area.

writeSectionDefinition

public void writeSectionDefinition(OutputStream result)

Writes the section definition data

Parameters: result