|
fop 0.95 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.fop.render.rtf.rtflib.rtfdoc.RtfElement
public abstract class RtfElement
Base class for all elements of an RTF file.
Field Summary | |
---|---|
protected RtfAttributes |
attrib
attributes of the element |
protected RtfContainer |
parent
parent element |
protected java.io.Writer |
writer
Writer to be used |
Method Summary | |
---|---|
void |
close()
Does nothing, meant to allow elements to write themselves without waiting for write(), but not implemented yet |
RtfAttributes |
getRtfAttributes()
Added by Normand Masse Used for attribute inheritance |
abstract boolean |
isEmpty()
|
void |
newLine()
Starts a new line in the RTF file being written. |
protected boolean |
okToWriteRtf()
can be overridden to suppress all RTF output |
java.lang.String |
toString()
minimal debugging display |
protected void |
writeAttributes(RtfAttributes attr,
java.lang.String[] nameList)
Write given attribute values to our Writer |
protected void |
writeControlWord(java.lang.String word)
Write an RTF control word to our Writer |
protected void |
writeControlWordNS(java.lang.String word)
Write rtf control word without the space behind it |
protected void |
writeExceptionInRtf(java.lang.Exception ie)
Make a visible entry in the RTF for an exception |
protected void |
writeGroupMark(boolean isStart)
Write a start or end group mark |
protected void |
writeOneAttribute(java.lang.String name,
java.lang.Object value)
Write one attribute to our Writer |
protected void |
writeOneAttributeNS(java.lang.String name,
java.lang.Object value)
Write one attribute to our Writer without a space |
void |
writeRtf()
Write the RTF code of this element to our Writer |
protected abstract void |
writeRtfContent()
Must be implemented to write RTF content to m_writer |
protected void |
writeRtfPrefix()
Called before writeRtfContent() |
protected void |
writeRtfSuffix()
Called after writeRtfContent() |
protected void |
writeStarControlWord(java.lang.String word)
Write an RTF control word to our Writer, preceeded by a star '*' meaning "ignore this if you don't know what it means" |
protected void |
writeStarControlWordNS(java.lang.String word)
Same as writeStarControlWord(String word), except with no space behind it |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected final java.io.Writer writer
protected final RtfContainer parent
protected final RtfAttributes attrib
Method Detail |
---|
public final void close() throws java.io.IOException
java.io.IOException
- for I/O problemspublic final void writeRtf() throws java.io.IOException
java.io.IOException
- for I/O problemspublic void newLine() throws java.io.IOException
java.io.IOException
- in case of an I/O problemprotected final void writeControlWord(java.lang.String word) throws java.io.IOException
word
- RTF control word to write
java.io.IOException
- for I/O problemsprotected final void writeStarControlWord(java.lang.String word) throws java.io.IOException
word
- RTF control word to write
java.io.IOException
- for I/O problemsprotected final void writeStarControlWordNS(java.lang.String word) throws java.io.IOException
word
- RTF control word to write
java.io.IOException
- for I/O problemsprotected final void writeControlWordNS(java.lang.String word) throws java.io.IOException
word
- RTF control word to write
java.io.IOException
- for I/O problemsprotected void writeRtfPrefix() throws java.io.IOException
java.io.IOException
- for I/O problemsprotected abstract void writeRtfContent() throws java.io.IOException
java.io.IOException
- for I/O problemsprotected void writeRtfSuffix() throws java.io.IOException
java.io.IOException
- for I/O problemsprotected final void writeGroupMark(boolean isStart) throws java.io.IOException
isStart
- set to true if this is a start mark
java.io.IOException
- for I/O problemsprotected void writeAttributes(RtfAttributes attr, java.lang.String[] nameList) throws java.io.IOException
attr
- RtfAttributes to be writtennameList
- if given, only attribute names from this list are considered
java.io.IOException
- for I/O problemsprotected void writeOneAttribute(java.lang.String name, java.lang.Object value) throws java.io.IOException
name
- name of attribute to writevalue
- value of attribute to be written
java.io.IOException
- for I/O problemsprotected void writeOneAttributeNS(java.lang.String name, java.lang.Object value) throws java.io.IOException
name
- name of attribute to writevalue
- value of attribute to be written
java.io.IOException
- for I/O problemsprotected boolean okToWriteRtf()
public java.lang.String toString()
toString
in class java.lang.Object
public abstract boolean isEmpty()
protected void writeExceptionInRtf(java.lang.Exception ie) throws java.io.IOException
ie
- Exception to flag
java.io.IOException
- for I/O problemspublic RtfAttributes getRtfAttributes()
|
fop 0.95 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |