| java.lang.Object
 com.lowagie.text.rtf.RtfElement
com.lowagie.text.rtf.document.RtfDocument
| RtfDocument | | public class RtfDocument extends RtfElement (Code) | | The RtfDocument stores all document related data and also the main data stream.
INTERNAL CLASS - NOT TO BE USED DIRECTLY
version:
$Id: RtfDocument.java 2808 2007-05-30 10:58:16Z psoares33 $
author:
Mark Hall (mhall@edu.uni-klu.ac.at)
author:
Todd Bush [Tab support]
author:
Thomas Bickel (tmb99@inode.at) |
| RtfDocument | | public RtfDocument()(Code) | | The default constructor for a RtfDocument
|
| add | | public void add(RtfBasicElement element)(Code) | | Adds an element to the rtf document
Parameters:
element - The element to add |
| filterSpecialChar | | public String filterSpecialChar(String str, boolean useHex, boolean softLineBreaks)(Code) | | Replaces special characters with their unicode values
Parameters:
str - The original String
Parameters:
useHex - indicated if the hexadecimal value has to be used
Parameters:
softLineBreaks - whether to use soft line breaks instead of default hard ones.RtfDocument.filterSpecialChar(OutputStream,String,boolean,boolean) The converted String |
| filterSpecialChar | | public void filterSpecialChar(OutputStream out, String str, boolean useHex, boolean softLineBreaks) throws IOException(Code) | | Writes the given string to the given
OutputStream encoding the string characters.
Parameters:
out - destination OutputStream
Parameters:
str - string to write
Parameters:
useHex - if true hex encoding characters is preferred to unicode encoding if possible
Parameters:
softLineBreaks - if true return characters are written as soft line breaks
throws:
IOException - |
| getAutogenerateTOCEntries | | public boolean getAutogenerateTOCEntries()(Code) | | Get whether to autmatically generate table of contents entries
Wheter to automatically generate TOC entries |
| getDocumentHeader | | public RtfDocumentHeader getDocumentHeader()(Code) | | Gets the RtfDocumentHeader of this RtfDocument
The RtfDocumentHeader of this RtfDocument |
| getDocumentSettings | | public RtfDocumentSettings getDocumentSettings()(Code) | | Gets the RtfDocumentSettings that specify how the rtf document is generated.
The current RtfDocumentSettings. |
| getLastElementWritten | | public RtfBasicElement getLastElementWritten()(Code) | | Gets the last RtfBasicElement that was directly added to the RtfDocument.
The last RtfBasicElement that was directly added to the RtfDocument. |
| getMapper | | public RtfMapper getMapper()(Code) | | Gets the RtfMapper object of this RtfDocument
The RtfMapper |
| getRandomInt | | public int getRandomInt()(Code) | | Generates a random integer that is unique with respect to the document.
A random int |
| open | | public void open()(Code) | | 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)(Code) | | 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)(Code) | | Writes the document
Parameters:
out - The OutputStream to write the RTF document to. |
|
|