|
|
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.lowagie.text.DocWriter
com.lowagie.text.rtf.RtfWriter2
public class RtfWriter2
The RtfWriter allows the creation of rtf documents via the iText system Version: $Id: RtfWriter2.java 2996 2007-11-20 22:40:36Z hallm $
| Field Summary | |
|---|---|
private RtfDocument |
rtfDoc
The RtfDocument this RtfWriter is creating |
| Fields inherited from class com.lowagie.text.DocWriter |
|---|
closeStream, document, EQUALS, FORWARD, GT, LT, NEWLINE, open, os, pageSize, pause, QUOTE, SPACE, TAB |
| Constructor Summary | |
|---|---|
protected |
RtfWriter2(Document doc,
OutputStream os)
Constructs a new RtfWriter that listens to the specified Document and writes its output to the OutputStream. |
| Method Summary | |
|---|---|
boolean |
add(Element element)
Adds an Element to the Document |
void |
clearTextWrap()
This method is not supported in the RtfWriter |
void |
close()
Closes the RtfDocument. |
RtfDocumentSettings |
getDocumentSettings()
Gets the RtfDocumentSettings that specify how the rtf document is generated. |
static RtfWriter2 |
getInstance(Document doc,
OutputStream os)
Static method to generate RtfWriters |
void |
importRtfDocument(Reader documentSource)
Adds the complete RTF document to the current RTF document being generated. |
void |
importRtfFragment(Reader documentSource,
RtfImportMappings mappings)
Adds a fragment of an RTF document to the current RTF document being generated. |
boolean |
newPage()
Adds a page break |
void |
open()
Opens the RtfDocument |
void |
resetFooter()
Resets the footer |
void |
resetHeader()
Resets the header |
void |
resetPageCount()
This method is not supported in the RtfWriter |
void |
setAutogenerateTOCEntries(boolean autogenerate)
Whether to automagically generate table of contents entries when adding Chapters or Sections. |
void |
setDataCacheStyle(int dataCacheStyle)
Deprecated. As of iText 2.0.6 or earlier, replaced by RtfDocumentSettings.setDataCacheStyle(int) via getDocumentSettings(), scheduled for removal at or after 2.1.0 |
void |
setFooter(HeaderFooter hf)
Sets the footer to use |
void |
setHeader(HeaderFooter hf)
Sets the header to use |
boolean |
setMargins(float left,
float right,
float top,
float bottom)
Sets the page margins |
void |
setPageCount(int i)
This method is not supported in the RtfWriter |
boolean |
setPageSize(Rectangle rect)
Sets the size of the page |
| Methods inherited from class com.lowagie.text.DocWriter |
|---|
addTabs, flush, getISOBytes, isCloseStream, isPaused, pause, resume, setCloseStream, setMarginMirroring, write, write, writeEnd, writeEnd, writeMarkupAttributes, writeStart |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
private RtfDocument rtfDoc
| Constructor Detail |
|---|
protected RtfWriter2(Document doc,
OutputStream os)
doc - The Document that this RtfWriter listens toos - The OutputStream to write to| Method Detail |
|---|
public static RtfWriter2 getInstance(Document doc,
OutputStream os)
doc - The Document that this RtfWriter listens toos - The OutputStream to write to
public void setHeader(HeaderFooter hf)
setHeader in interface DocListenersetHeader in class DocWriterhf - The HeaderFooter to usepublic void resetHeader()
resetHeader in interface DocListenerresetHeader in class DocWriterpublic void setFooter(HeaderFooter hf)
setFooter in interface DocListenersetFooter in class DocWriterhf - The HeaderFooter to usepublic void resetFooter()
resetFooter in interface DocListenerresetFooter in class DocWriterpublic void setPageCount(int i)
setPageCount in interface DocListenersetPageCount in class DocWriteri - Unusedpublic void resetPageCount()
resetPageCount in interface DocListenerresetPageCount in class DocWriterpublic void clearTextWrap()
public void open()
open in interface DocListeneropen in class DocWriterIOExceptionpublic void close()
close in interface DocListenerclose in class DocWriter
public boolean add(Element element)
throws DocumentException
add in interface ElementListeneradd in class DocWriterelement - The element to be added
false
DocumentExceptionpublic boolean newPage()
newPage in interface DocListenernewPage in class DocWriterfalse
public boolean setMargins(float left,
float right,
float top,
float bottom)
setMargins in interface DocListenersetMargins in class DocWriterleft - The left marginright - The right margintop - The top marginbottom - The bottom margin
falsepublic boolean setPageSize(Rectangle rect)
setPageSize in interface DocListenersetPageSize in class DocWriterrect - A Rectangle representing the page
falsepublic void setAutogenerateTOCEntries(boolean autogenerate)
autogenerate - Whether to automatically generate TOC entriespublic void setDataCacheStyle(int dataCacheStyle)
RtfDocumentSettings.setDataCacheStyle(int) via getDocumentSettings(), scheduled for removal at or after 2.1.0
dataCacheStyle - The style to use.
DocumentException - If data has already been written into the data cache.
IOException - If the disk cache could not be initialised.public RtfDocumentSettings getDocumentSettings()
public void importRtfDocument(Reader documentSource)
throws IOException,
DocumentException
documentSource - The Reader to read the RTF document from.
IOException - On errors reading the RTF document.
DocumentException - On errors adding to this RTF document.
public void importRtfFragment(Reader documentSource,
RtfImportMappings mappings)
throws IOException,
DocumentException
documentSource - The Reader to read the RTF fragment from.mappings - The RtfImportMappings that contain font and color mappings to apply to the fragment.
IOException - On errors reading the RTF fragment.
DocumentException - On errors adding to this RTF fragment.
|
|
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||