com.lowagie.text.rtf.document

Class RtfDocument

java.lang.Object

com.lowagie.text.rtf.RtfElement

com.lowagie.text.rtf.document.RtfDocument

All Implemented Interfaces:

RtfBasicElement, RtfElementInterface

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

Since:

1.x

Version:

$Id: RtfDocument.java 4065 2009-09-16 23:09:11Z psoares33 $

Author:

Mark Hall (Mark.Hall@mail.room3b.eu), Todd Bush [Tab support], Thomas Bickel (tmb99@inode.at)

Field Summary

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

Constructors

Constructor and Description
RtfDocument() The default constructor for a RtfDocument

Method Summary

Modifier and Type	Method and Description
void	add(RtfBasicElement element) Adds an element to the rtf document
void	filterSpecialChar(OutputStream out, String str, boolean useHex, boolean softLineBreaks) Writes the given string to the given OutputStream encoding the string characters.
boolean	getAutogenerateTOCEntries() Get whether to automatically 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 initializes the data cache.
void	outputDebugLinebreak(OutputStream result) Helper method outputs linebreak in document if debugging is turned on.
void	setAutogenerateTOCEntries(boolean autogenerate) Whether to automagically generate table of contents entries when adding Chapters or Sections.
void	writeContent(OutputStream out) unused
void	writeDocument(OutputStream out) Writes the document

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

Constructor Detail

RtfDocument

public RtfDocument()

The default constructor for a RtfDocument

Method Detail

writeContent

public void writeContent(OutputStream out)
                  throws IOException

unused

Specified by:

writeContent in interface RtfBasicElement

Specified by:

writeContent in class RtfElement

Parameters:

out - The OutputStream to write the content to

Throws:

IOException

writeDocument

public void writeDocument(OutputStream out)

Writes the document

Parameters:

out - The OutputStream to write the RTF document to.

open

public void open()

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

add

public void add(RtfBasicElement element)

Adds an element to the rtf document

Parameters:

element - The element to add

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. Will not return a number between -1 and -5 because some values in that range are invalid.

Returns:

A random int

getDocumentHeader

public RtfDocumentHeader getDocumentHeader()

Gets the RtfDocumentHeader of this RtfDocument

Returns:

The RtfDocumentHeader of this RtfDocument

filterSpecialChar

public void filterSpecialChar(OutputStream out,
                              String str,
                              boolean useHex,
                              boolean softLineBreaks)
                       throws IOException

Writes the given string to the given OutputStream encoding the string characters.

Parameters:

out - destination OutputStream

str - string to write

useHex - if true hex encoding characters is preferred to unicode encoding if possible

softLineBreaks - if true return characters are written as soft line breaks

Throws:

IOException

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

getAutogenerateTOCEntries

public boolean getAutogenerateTOCEntries()

Get whether to automatically generate table of contents entries

Returns:

Whether to automatically generate TOC entries

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.

outputDebugLinebreak

public final void outputDebugLinebreak(OutputStream result)
                                throws IOException

Helper method outputs linebreak in document if debugging is turned on.

Parameters:

result - the OutputStream to write the linebreak to.

Throws:

IOException

Since:

2.1.3