public class RtfDocument extends RtfElement
Modifier and Type | Field and Description |
---|---|
private boolean |
autogenerateTOCEntries
Whether to automatically generate TOC entries for Chapters and Sections.
|
private RtfDataCache |
data
Stores the actual document data
|
private boolean |
dataWritten
Whether data has been written to the RtfDataCache.
|
private RtfDocumentHeader |
documentHeader
The RtfDocumentHeader that handles all document header methods
|
private RtfDocumentSettings |
documentSettings
The RtfDocumentSettings for this RtfDocument.
|
private RtfBasicElement |
lastElementWritten
The last RtfBasicElement that was added directly to the RtfDocument.
|
private RtfMapper |
mapper
The RtfMapper to use in this RtfDocument
|
private java.util.ArrayList |
previousRandomInts
Stores integers that have been generated as unique random numbers
|
private static byte[] |
RTF_DOCUMENT
Constant for the Rtf document start
|
document, inHeader, inTable
CLOSE_GROUP, COMMA_DELIMITER, DELIMITER, OPEN_GROUP, TWIPS_FACTOR
Constructor and Description |
---|
RtfDocument()
The default constructor for a RtfDocument
|
Modifier and Type | Method and Description |
---|---|
void |
add(RtfBasicElement element)
Adds an element to the rtf document
|
java.lang.String |
filterSpecialChar(java.lang.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 |
setAutogenerateTOCEntries(boolean autogenerate)
Whether to automagically generate table of contents entries when
adding Chapters or Sections.
|
void |
setDataCacheStyle(int dataCacheStyle)
Sets the rtf data cache style to use.
|
byte[] |
writeDocument()
Writes the document
|
intToByteArray, isInTable, setInHeader, setInTable, setRtfDocument, write
private RtfDataCache data
private RtfMapper mapper
private RtfDocumentHeader documentHeader
private java.util.ArrayList previousRandomInts
private boolean autogenerateTOCEntries
private boolean dataWritten
private RtfDocumentSettings documentSettings
private RtfBasicElement lastElementWritten
private static final byte[] RTF_DOCUMENT
public byte[] writeDocument()
public void add(RtfBasicElement element)
element
- The element to addpublic RtfMapper getMapper()
public int getRandomInt()
public RtfDocumentHeader getDocumentHeader()
public java.lang.String filterSpecialChar(java.lang.String str, boolean useHex, boolean softLineBreaks)
str
- The original String
useHex
- indicated if the hexadecimal value has to be usedsoftLineBreaks
- whether to use soft line breaks instead of default hard ones.public void setAutogenerateTOCEntries(boolean autogenerate)
autogenerate
- Whether to automatically generate TOC entriespublic boolean getAutogenerateTOCEntries()
public void setDataCacheStyle(int dataCacheStyle) throws DocumentException, java.io.IOException
dataCacheStyle
- The style to use.DocumentException
- If data has already been written into the data cache.java.io.IOException
- If the disk cache could not be initialised.public RtfDocumentSettings getDocumentSettings()
public RtfBasicElement getLastElementWritten()