|
![]() |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.lowagie.text.rtf.RtfElement
com.lowagie.text.rtf.document.RtfDocument
public class RtfDocument
The RtfDocument stores all document related data and also the main data stream. INTERNAL CLASS - NOT TO BE USED DIRECTLY
Field Summary | |
---|---|
private boolean |
autogenerateTOCEntries
Whether to automatically generate TOC entries for Chapters and Sections. |
private RtfDataCache |
data
Stores the actual document data |
private RtfDocumentHeader |
documentHeader
The RtfDocumentHeader that handles all document header methods |
private RtfDocumentSettings |
documentSettings
The RtfDocumentSettings for this RtfDocument. |
private static byte[] |
FSC_BACKSLASH
|
private static byte[] |
FSC_HEX_PREFIX
|
private static byte[] |
FSC_LINE
|
private static byte[] |
FSC_NEWPAGE
|
private static byte[] |
FSC_PAGE_PAR
|
private static byte[] |
FSC_PAR
|
private static byte[] |
FSC_TAB
|
private static byte[] |
FSC_UNI_PREFIX
|
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 |
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 | |
---|---|
RtfDocument()
The default constructor for a RtfDocument |
Method Summary | |
---|---|
void |
add(RtfBasicElement element)
Adds an element to the rtf document |
void |
filterSpecialChar(java.io.OutputStream out,
java.lang.String str,
boolean useHex,
boolean softLineBreaks)
Writes the given string to the given OutputStream encoding the string characters. |
java.lang.String |
filterSpecialChar(java.lang.String str,
boolean useHex,
boolean softLineBreaks)
Deprecated. As of iText 2.0.6 or earlier, replaced by filterSpecialChar(OutputStream, String, boolean, boolean) , scheduled for removal at or after 2.1.0 |
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. |
private static boolean |
subMatch(java.lang.String str,
int soff,
byte[] m)
Returns true if m.length characters in str, starting at offset soff
match the bytes in the given array m. |
byte[] |
write()
Deprecated. As of iText 2.0.6 or earlier, replaced by writeContent(OutputStream) , scheduled for removal at or after 2.1.0 |
void |
writeContent(java.io.OutputStream out)
unused |
void |
writeDocument(java.io.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 |
Field Detail |
---|
private RtfDataCache data
private RtfMapper mapper
private RtfDocumentHeader documentHeader
private java.util.ArrayList previousRandomInts
private boolean autogenerateTOCEntries
private RtfDocumentSettings documentSettings
private RtfBasicElement lastElementWritten
private static final byte[] RTF_DOCUMENT
private static final byte[] FSC_LINE
private static final byte[] FSC_PAR
private static final byte[] FSC_TAB
private static final byte[] FSC_PAGE_PAR
private static final byte[] FSC_NEWPAGE
private static final byte[] FSC_BACKSLASH
private static final byte[] FSC_HEX_PREFIX
private static final byte[] FSC_UNI_PREFIX
Constructor Detail |
---|
public RtfDocument()
Method Detail |
---|
public byte[] write()
writeContent(OutputStream)
, scheduled for removal at or after 2.1.0
write
in interface RtfBasicElement
write
in class RtfElement
public void writeContent(java.io.OutputStream out) throws java.io.IOException
writeContent
in interface RtfBasicElement
writeContent
in class RtfElement
java.io.IOException
public void writeDocument(java.io.OutputStream out)
out
- The OutputStream
to write the RTF document to.public void open()
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)
filterSpecialChar(OutputStream, String, boolean, boolean)
, scheduled for removal at or after 2.1.0
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 filterSpecialChar(java.io.OutputStream out, java.lang.String str, boolean useHex, boolean softLineBreaks) throws java.io.IOException
OutputStream
encoding the string characters.
out
- destination OutputStreamstr
- string to writeuseHex
- if true
hex encoding characters is preferred to unicode encoding if possiblesoftLineBreaks
- if true
return characters are written as soft line breaks
java.io.IOException
private static boolean subMatch(java.lang.String str, int soff, byte[] m)
true
if m.length characters in str, starting at offset soff
match the bytes in the given array m.
str
- the string to search for a matchsoff
- the starting offset in strm
- the array to match
true
if there is matchpublic void setAutogenerateTOCEntries(boolean autogenerate)
autogenerate
- Whether to automatically generate TOC entriespublic boolean getAutogenerateTOCEntries()
public RtfDocumentSettings getDocumentSettings()
public RtfBasicElement getLastElementWritten()
|
![]() |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |