Package org.apache.fop.render.rtf.rtflib.rtfdoc

Class RtfHeader

java.lang.Object

org.apache.fop.render.rtf.rtflib.rtfdoc.RtfElement

org.apache.fop.render.rtf.rtflib.rtfdoc.RtfContainer

org.apache.fop.render.rtf.rtflib.rtfdoc.RtfHeader

class RtfHeader
extends RtfContainer

RTF file header, contains style, font and other document-level information.

This work was authored by Bertrand Delacretaz (bdelacretaz@codeconsult.ch), Andreas Putz (a.putz@skynamics.com), and Marc Wilhelm Kuester.

Field Summary

Fields

Modifier and Type	Field	Description
private static java.lang.String	CHARSET
private java.util.Map	userProperties

Fields inherited from class org.apache.fop.render.rtf.rtflib.rtfdoc.RtfElement

attrib, parent, writer

Constructor Summary

Constructors

Constructor	Description
RtfHeader(RtfFile f, java.io.Writer w)	Create an RTF header

Method Summary

Modifier and Type	Method	Description
(package private) void	write(java.lang.String toWrite)	write directly to our Writer TODO should check that this done at the right point, or even better, store what is written here to render it in writeRtfContent.
private void	writeFootnoteProperties()	write properties for footnote handling
protected void	writeRtfContent()	Overridden to write our own data before our children's data
(package private) void	writeRtfString(java.lang.String toWrite)	write to our Writer using an RtfStringConverter
private void	writeUserProperties()	write user properties if any

Methods inherited from class org.apache.fop.render.rtf.rtflib.rtfdoc.RtfContainer

addChild, containsText, dump, findChildren, getChildCount, getChildren, getOptions, isEmpty, okToWriteRtf, setChildren, setOptions, toString

Methods inherited from class org.apache.fop.render.rtf.rtflib.rtfdoc.RtfElement

close, getParentOfClass, getRtfAttributes, getRtfFile, isClosed, newLine, writeAttributes, writeControlWord, writeControlWordNS, writeExceptionInRtf, writeGroupMark, writeOneAttribute, writeOneAttributeNS, writeRtf, writeRtfPrefix, writeRtfSuffix, writeStarControlWord, writeStarControlWordNS

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CHARSET

private static final java.lang.String CHARSET

See Also:

Constant Field Values

userProperties

private final java.util.Map userProperties

Constructor Detail

RtfHeader

RtfHeader(RtfFile f,
          java.io.Writer w)
   throws java.io.IOException

Create an RTF header

Throws:

java.io.IOException

Method Detail

writeRtfContent

protected void writeRtfContent()
                        throws java.io.IOException

Overridden to write our own data before our children's data

Overrides:

writeRtfContent in class RtfContainer

Throws:

java.io.IOException - for I/O problems

writeUserProperties

private void writeUserProperties()
                          throws java.io.IOException

write user properties if any

Throws:

java.io.IOException

write

void write(java.lang.String toWrite)
    throws java.io.IOException

write directly to our Writer TODO should check that this done at the right point, or even better, store what is written here to render it in writeRtfContent. <-- it is for the color table

Throws:

java.io.IOException

writeRtfString

void writeRtfString(java.lang.String toWrite)
             throws java.io.IOException

write to our Writer using an RtfStringConverter

Throws:

java.io.IOException

writeFootnoteProperties

private void writeFootnoteProperties()
                              throws java.io.IOException

write properties for footnote handling

Throws:

java.io.IOException