com.lowagie.text.rtf.document

Class RtfDocument

public class RtfDocument extends RtfElement

The RtfDocument stores all document related data and also the main data stream. INTERNAL CLASS - NOT TO BE USED DIRECTLY Version: $Id: RtfDocument.java,v 1.21 2006/09/14 23:10:55 xlv Exp $

Author: Mark Hall (mhall@edu.uni-klu.ac.at) Todd Bush [Tab support]

Field Summary
boolean	autogenerateTOCEntries Whether to automatically generate TOC entries for Chapters and Sections.
RtfDataCache	data Stores the actual document data
RtfDocumentHeader	documentHeader The RtfDocumentHeader that handles all document header methods
RtfDocumentSettings	documentSettings The RtfDocumentSettings for this RtfDocument.
RtfBasicElement	lastElementWritten The last RtfBasicElement that was added directly to the RtfDocument.
RtfMapper	mapper The RtfMapper to use in this RtfDocument
ArrayList	previousRandomInts Stores integers that have been generated as unique random numbers
static byte[]	RTF_DOCUMENT Constant for the Rtf document start

Constructor Summary
	RtfDocument() The default constructor for a RtfDocument

Method Summary
void	add(RtfBasicElement element) Adds an element to the rtf document
String	filterSpecialChar(String str, boolean useHex, boolean softLineBreaks) Replaces special characters with their unicode values
boolean	getAutogenerateTOCEntries() Get whether to autmatically generate table of contents entries
RtfDocumentHeader	getDocumentHeader() Gets the RtfDocumentHeader of this RtfDocument
RtfDocumentSettings	getDocumentSettings() Gets the RtfDocumentSettings that specify how the rtf document is generated.
RtfBasicElement	getLastElementWritten() Gets the last RtfBasicElement that was directly added to the RtfDocument.
RtfMapper	getMapper() Gets the RtfMapper object of this RtfDocument
int	getRandomInt() Generates a random integer that is unique with respect to the document.
void	open() Opens the RtfDocument and initialises the data cache.
void	setAutogenerateTOCEntries(boolean autogenerate) Whether to automagically generate table of contents entries when adding Chapters or Sections.
void	writeDocument(OutputStream out) Writes the document

Field Detail

autogenerateTOCEntries

private boolean autogenerateTOCEntries

Whether to automatically generate TOC entries for Chapters and Sections. Defaults to false

data

private RtfDataCache data

Stores the actual document data

documentHeader

private RtfDocumentHeader documentHeader

The RtfDocumentHeader that handles all document header methods

documentSettings

private RtfDocumentSettings documentSettings

The RtfDocumentSettings for this RtfDocument.

lastElementWritten

private RtfBasicElement lastElementWritten

The last RtfBasicElement that was added directly to the RtfDocument.

mapper

private RtfMapper mapper

The RtfMapper to use in this RtfDocument

previousRandomInts

private ArrayList previousRandomInts

Stores integers that have been generated as unique random numbers

RTF_DOCUMENT

private static final byte[] RTF_DOCUMENT

Constant for the Rtf document start

Constructor Detail

RtfDocument

public RtfDocument()

The default constructor for a RtfDocument

Method Detail

add

public void add(RtfBasicElement element)

Adds an element to the rtf document

Parameters: element The element to add

filterSpecialChar

public String filterSpecialChar(String str, boolean useHex, boolean softLineBreaks)

Replaces special characters with their unicode values

Parameters: str The original String useHex indicated if the hexadecimal value has to be used softLineBreaks whether to use soft line breaks instead of default hard ones.

Returns: The converted String

getAutogenerateTOCEntries

public boolean getAutogenerateTOCEntries()

Get whether to autmatically generate table of contents entries

Returns: Wheter to automatically generate TOC entries

getDocumentHeader

public RtfDocumentHeader getDocumentHeader()

Gets the RtfDocumentHeader of this RtfDocument

Returns: The RtfDocumentHeader of this RtfDocument

getDocumentSettings

public RtfDocumentSettings getDocumentSettings()

Gets the RtfDocumentSettings that specify how the rtf document is generated.

Returns: The current RtfDocumentSettings.

getLastElementWritten

public RtfBasicElement getLastElementWritten()

Gets the last RtfBasicElement that was directly added to the RtfDocument.

Returns: The last RtfBasicElement that was directly added to the RtfDocument.

getMapper

public RtfMapper getMapper()

Gets the RtfMapper object of this RtfDocument

Returns: The RtfMapper

getRandomInt

public int getRandomInt()

Generates a random integer that is unique with respect to the document.

Returns: A random int

open

public void open()

Opens the RtfDocument and initialises the data cache. If the data cache is set to CACHE_DISK, but the cache cannot be initialised then the memory cache is used.

setAutogenerateTOCEntries

public void setAutogenerateTOCEntries(boolean autogenerate)

Whether to automagically generate table of contents entries when adding Chapters or Sections.

Parameters: autogenerate Whether to automatically generate TOC entries

writeDocument

public void writeDocument(OutputStream out)

Writes the document

Parameters: out The OutputStream to write the RTF document to.