|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jfor.jfor.rtflib.rtfdoc.RtfElement
org.jfor.jfor.rtflib.rtfdoc.RtfContainer
org.jfor.jfor.rtflib.rtfdoc.RtfFile
public class RtfFile
Models the top-level structure of an RTF file.
RtfFileExample
Field Summary |
---|
Fields inherited from class org.jfor.jfor.rtflib.rtfdoc.RtfElement |
---|
m_attrib, m_parent, m_writer |
Constructor Summary | |
---|---|
RtfFile(java.io.Writer w)
Create an RTF file that outputs to the given Writer |
Method Summary | |
---|---|
void |
flush()
must be called when done creating the document |
RtfDocumentArea |
getDocumentArea()
Call startDocumentArea if needed and return the document area object. |
(package private) ConverterLogChannel |
getLog()
Gets the log channel. |
RtfPageArea |
getPageArea()
Call startPageArea if needed and return the page area object. |
static void |
main(java.lang.String[] args)
minimal test and usage example |
void |
setLogChannel(ConverterLogChannel log)
optional log channel |
RtfDocumentArea |
startDocumentArea()
Closes the RtfHeader if not done yet, and starts the document area. |
RtfHeader |
startHeader()
If called, must be called before startDocumentArea |
RtfListTable |
startListTable(RtfAttributes attr)
Creates the list table. |
RtfPageArea |
startPageArea()
Closes the RtfHeader if not done yet, and starts the docment area. |
protected void |
writeRtfPrefix()
overridden to write RTF prefix code, what comes before our children |
protected void |
writeRtfSuffix()
overridden to write RTF suffix code, what comes after our children |
Methods inherited from class org.jfor.jfor.rtflib.rtfdoc.RtfContainer |
---|
addChild, containsText, dump, getChildCount, getChildren, getOptions, isEmpty, okToWriteRtf, setChildren, setOptions, toString, writeRtfContent |
Methods inherited from class org.jfor.jfor.rtflib.rtfdoc.RtfElement |
---|
close, getParentOfClass, getRtfAttributes, getRtfFile, isClosed, writeAttributes, writeControlWord, writeControlWordNS, writeExceptionInRtf, writeGroupMark, writeOneAttribute, writeOneAttributeNS, writeRtf, writeStarControlWord, writeStarControlWordNS |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public RtfFile(java.io.Writer w) throws java.io.IOException
java.io.IOException
Method Detail |
---|
public void setLogChannel(ConverterLogChannel log)
ConverterLogChannel getLog()
public RtfHeader startHeader() throws java.io.IOException
java.io.IOException
public RtfListTable startListTable(RtfAttributes attr) throws java.io.IOException
java.io.IOException
public RtfPageArea startPageArea() throws java.io.IOException, RtfStructureException
java.io.IOException
RtfStructureException
public RtfPageArea getPageArea() throws java.io.IOException, RtfStructureException
java.io.IOException
RtfStructureException
public RtfDocumentArea startDocumentArea() throws java.io.IOException, RtfStructureException
java.io.IOException
RtfStructureException
public RtfDocumentArea getDocumentArea() throws java.io.IOException, RtfStructureException
java.io.IOException
RtfStructureException
protected void writeRtfPrefix() throws java.io.IOException
writeRtfPrefix
in class RtfElement
java.io.IOException
protected void writeRtfSuffix() throws java.io.IOException
writeRtfSuffix
in class RtfElement
java.io.IOException
public void flush() throws java.io.IOException
java.io.IOException
public static void main(java.lang.String[] args) throws java.lang.Exception
java.lang.Exception
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |