de.dante.extex.backend.documentWriter.rtf
Class RtfDocumentWriter

java.lang.Object
  extended byde.dante.extex.backend.documentWriter.rtf.RtfDocument
      extended byde.dante.extex.backend.documentWriter.rtf.RtfDocumentWriter
All Implemented Interfaces:
ColorAware, Configurable, DocumentWriter, SingleDocumentStream

public class RtfDocumentWriter
extends RtfDocument
implements DocumentWriter, SingleDocumentStream, ColorAware, Configurable

This class provides a base implementation of a RTF document writer.

Version:
$Revision: 1.1 $
Author:
Gerd Neugebauer

Constructor Summary
RtfDocumentWriter(DocumentWriterOptions options)
          Creates a new object.
 
Method Summary
 void close()
          This method is invoked upon the end of the processing.
 void configure(Configuration config)
          Configure an object according to a given Configuration.
 java.lang.String getExtension()
          Getter for the extension associated with this kind of output.
protected  void optimize(java.util.List list)
          Optimize the description of a single page.
 void setColorConverter(ColorConverter converter)
          Setter for the color converter.
 void setOutputStream(java.io.OutputStream writer)
          Setter for the output stream.
 void setParameter(java.lang.String name, java.lang.String value)
          Setter for a named parameter.
 int shipout(Page page)
          This is the entry point for the document writer.
 
Methods inherited from class de.dante.extex.backend.documentWriter.rtf.RtfDocument
getAuthor, getCreator, getTitle, mapColor, mapFont, newPage, put, put, setAuthor, setCreator, setTitle, write
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RtfDocumentWriter

public RtfDocumentWriter(DocumentWriterOptions options)
Creates a new object.

Parameters:
options - the document writer options
Method Detail

close

public void close()
           throws GeneralException,
                  java.io.IOException
Description copied from interface: DocumentWriter
This method is invoked upon the end of the processing.

Specified by:
close in interface DocumentWriter
Throws:
java.io.IOException - in case of an IO exception
GeneralException - in case of a general exception
especially
DocumentWriterException in case of an error
See Also:
DocumentWriter.close()

configure

public void configure(Configuration config)
               throws ConfigurationException
Description copied from interface: Configurable
Configure an object according to a given Configuration.

Specified by:
configure in interface Configurable
Parameters:
config - the configuration object to consider
Throws:
ConfigurationException - in case that something went wrong
See Also:
Configurable.configure( de.dante.util.framework.configuration.Configuration)

getExtension

public java.lang.String getExtension()
Description copied from interface: DocumentWriter
Getter for the extension associated with this kind of output. For instance pdf is the expected value for PDF files and dvi is the expected value for DVI files.

Specified by:
getExtension in interface DocumentWriter
Returns:
the appropriate extension for file names
See Also:
DocumentWriter.getExtension()

optimize

protected void optimize(java.util.List list)
Optimize the description of a single page.

Parameters:
list - the list of codes for the page

setColorConverter

public void setColorConverter(ColorConverter converter)
Description copied from interface: ColorAware
Setter for the color converter.

Specified by:
setColorConverter in interface ColorAware
Parameters:
converter - the color converter
See Also:
ColorAware.setColorConverter( de.dante.extex.color.ColorConverter)

setOutputStream

public void setOutputStream(java.io.OutputStream writer)
Description copied from interface: SingleDocumentStream
Setter for the output stream.

Specified by:
setOutputStream in interface SingleDocumentStream
Parameters:
writer - the output stream
See Also:
SingleDocumentStream.setOutputStream( java.io.OutputStream)

setParameter

public void setParameter(java.lang.String name,
                         java.lang.String value)
Description copied from interface: DocumentWriter
Setter for a named parameter. Parameters are a general mechanism to influence the behavior of the document writer. Any parameter not known by the document writer has to be ignored.

Specified by:
setParameter in interface DocumentWriter
Parameters:
name - the name of the parameter
value - the value of the parameter
See Also:
DocumentWriter.setParameter( java.lang.String, java.lang.String)

shipout

public int shipout(Page page)
            throws GeneralException,
                   java.io.IOException
Description copied from interface: DocumentWriter
This is the entry point for the document writer. Here it receives a complete node list to be sent to the output writer. It can be assumed that all values for width, height, and depth of the node lists are properly filled. Thus all information should be present to place the ink on the paper.

Specified by:
shipout in interface DocumentWriter
Parameters:
page - the page to send
Returns:
returns the number of pages shipped
Throws:
java.io.IOException - in case of an IO exception
GeneralException - in case of a general exception
especially
DocumentWriterException in case of an error
See Also:
DocumentWriter.shipout( de.dante.extex.typesetter.type.page.Page)