| java.lang.Object
 org.apache.fop.render.rtf.rtflib.rtfdoc.RtfElement
All known Subclasses: org.apache.fop.render.rtf.rtflib.rtfdoc.RtfLineBreak, org.apache.fop.render.rtf.rtflib.rtfdoc.RtfBookmark, org.apache.fop.render.rtf.rtflib.rtfdoc.RtfText, org.apache.fop.render.rtf.rtflib.rtfdoc.RtfString, org.apache.fop.render.rtf.rtflib.rtfdoc.RtfPageBreak, org.apache.fop.render.rtf.rtflib.rtfdoc.RtfContainer, org.apache.fop.render.rtf.rtflib.rtfdoc.RtfGenerator, org.apache.fop.render.rtf.rtflib.rtfdoc.RtfFontTable, org.apache.fop.render.rtf.rtflib.rtfdoc.RtfExternalGraphic,
| RtfElement | | abstract public class RtfElement (Code) | | Base class for all elements of an RTF file.
author:
Bertrand Delacretaz bdelacretaz@codeconsult.ch
author:
Andreas Putz a.putz@skynamics.com |
| close | | final public void close() throws IOException(Code) | | Does nothing, meant to allow elements to write themselves without waiting
for write(), but not implemented yet
throws:
IOException - for I/O problems |
| getParentOfClass | | RtfElement getParentOfClass(Class c)(Code) | | find the first parent where c.isAssignableFrom(parent.getClass()) is true
null if not found |
| getRtfAttributes | | public RtfAttributes getRtfAttributes()(Code) | | Added by Normand Masse
Used for attribute inheritance
RtfAttributes |
| getRtfFile | | RtfFile getRtfFile()(Code) | | access our RtfFile, which is always the topmost parent
|
| isClosed | | boolean isClosed()(Code) | | true if close() has been called
|
| isEmpty | | abstract public boolean isEmpty()(Code) | | true if this element would generate no "useful" RTF content |
| newLine | | public void newLine() throws IOException(Code) | | Starts a new line in the RTF file being written. This is only to format
the RTF file itself (for easier debugging), not its content.
throws:
IOException - in case of an I/O problem |
| okToWriteRtf | | protected boolean okToWriteRtf()(Code) | | can be overridden to suppress all RTF output
true if this object can be written into the RTF |
| toString | | public String toString()(Code) | | minimal debugging display
String representation of object |
| writeAttributes | | protected void writeAttributes(RtfAttributes attr, String[] nameList) throws IOException(Code) | | Write given attribute values to our Writer
Parameters:
attr - RtfAttributes to be written
Parameters:
nameList - if given, only attribute names from this list are considered
throws:
IOException - for I/O problems |
| writeControlWord | | final protected void writeControlWord(String word) throws IOException(Code) | | Write an RTF control word to our Writer
Parameters:
word - RTF control word to write
throws:
IOException - for I/O problems |
| writeControlWordNS | | final protected void writeControlWordNS(String word) throws IOException(Code) | | Write rtf control word without the space behind it
Parameters:
word - RTF control word to write
throws:
IOException - for I/O problems |
| writeExceptionInRtf | | protected void writeExceptionInRtf(Exception ie) throws IOException(Code) | | Make a visible entry in the RTF for an exception
Parameters:
ie - Exception to flag
throws:
IOException - for I/O problems |
| writeGroupMark | | final protected void writeGroupMark(boolean isStart) throws IOException(Code) | | Write a start or end group mark
Parameters:
isStart - set to true if this is a start mark
throws:
IOException - for I/O problems |
| writeOneAttribute | | protected void writeOneAttribute(String name, Object value) throws IOException(Code) | | Write one attribute to our Writer
Parameters:
name - name of attribute to write
Parameters:
value - value of attribute to be written
throws:
IOException - for I/O problems |
| writeOneAttributeNS | | protected void writeOneAttributeNS(String name, Object value) throws IOException(Code) | | Write one attribute to our Writer without a space
Parameters:
name - name of attribute to write
Parameters:
value - value of attribute to be written
throws:
IOException - for I/O problems |
| writeRtf | | final public void writeRtf() throws IOException(Code) | | Write the RTF code of this element to our Writer
throws:
IOException - for I/O problems |
| writeRtfContent | | abstract protected void writeRtfContent() throws IOException(Code) | | Must be implemented to write RTF content to m_writer
throws:
IOException - for I/O problems |
| writeRtfPrefix | | protected void writeRtfPrefix() throws IOException(Code) | | Called before writeRtfContent()
throws:
IOException - for I/O problems |
| writeRtfSuffix | | protected void writeRtfSuffix() throws IOException(Code) | | Called after writeRtfContent()
throws:
IOException - for I/O problems |
| writeStarControlWord | | final protected void writeStarControlWord(String word) throws IOException(Code) | | Write an RTF control word to our Writer, preceeded by a star '*'
meaning "ignore this if you don't know what it means"
Parameters:
word - RTF control word to write
throws:
IOException - for I/O problems |
| writeStarControlWordNS | | final protected void writeStarControlWordNS(String word) throws IOException(Code) | | Same as writeStarControlWord(String word), except with no space behind it
Parameters:
word - RTF control word to write
throws:
IOException - for I/O problems |
|
|