org.extex.backend.documentWriter.pdf
Class PdfSinglePageDocumentWriter

java.lang.Object
  org.extex.backend.documentWriter.pdf.PdfSinglePageDocumentWriter

All Implemented Interfaces:

DocumentWriter, MultipleDocumentStream

public class PdfSinglePageDocumentWriter
extends java.lang.Object
implements DocumentWriter, MultipleDocumentStream

Implementation of a pdf document writer.

Version:

$Revision: 5585 $

Author:

Michael Niedermair

Constructor Summary

PdfSinglePageDocumentWriter(Configuration cfg, DocumentWriterOptions options)
Creates a new object.

Method Summary

void	close() This method is invoked upon the end of the processing.
java.lang.String	getExtension() Getter for the extension associated with this kind of output.
void	setOutputStreamFactory(OutputStreamFactory writerFactory) 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 java.lang.Object

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

Constructor Detail

PdfSinglePageDocumentWriter

public PdfSinglePageDocumentWriter(Configuration cfg,
                                   DocumentWriterOptions options)

Creates a new object.

Parameters:

cfg - the configuration

options - the options

Method Detail

close

public void close()
           throws DocumentWriterIOException

This method is invoked upon the end of the processing.

Specified by:

close in interface DocumentWriter

Throws:

DocumentWriterIOException

See Also:

DocumentWriter.close()

getExtension

public java.lang.String getExtension()

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()

setOutputStreamFactory

public void setOutputStreamFactory(OutputStreamFactory writerFactory)

Setter for the output stream.

Specified by:

setOutputStreamFactory in interface MultipleDocumentStream

Parameters:

writerFactory - the output stream

See Also:

MultipleDocumentStream.setOutputStreamFactory( org.extex.backend.outputStream.OutputStreamFactory)

setParameter

public void setParameter(java.lang.String name,
                         java.lang.String value)

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 DocumentWriterException

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.

If the page is null then no page has to be shipped and 0 has to be returned.

Specified by:

shipout in interface DocumentWriter

Parameters:

page - the page to send

Returns:

returns the number of pages shipped

Throws:

DocumentWriterException

See Also:

DocumentWriter.shipout( org.extex.typesetter.type.page.Page)