fop 1.0

org.apache.fop.render.ps
Class PSDocumentHandler

java.lang.Object
  extended by org.apache.fop.render.intermediate.AbstractIFDocumentHandler
      extended by org.apache.fop.render.intermediate.AbstractBinaryWritingIFDocumentHandler
          extended by org.apache.fop.render.ps.PSDocumentHandler
All Implemented Interfaces:
IFDocumentHandler

public class PSDocumentHandler
extends AbstractBinaryWritingIFDocumentHandler

IFDocumentHandler implementation that produces PostScript.


Field Summary
protected  org.apache.xmlgraphics.ps.PSGenerator gen
          The PostScript generator used to output the PostScript
protected  PSRenderingUtil psUtil
          Utility class which enables all sorts of features that are not directly connected to the normal rendering process.
 
Fields inherited from class org.apache.fop.render.intermediate.AbstractBinaryWritingIFDocumentHandler
fontInfo, outputStream
 
Constructor Summary
PSDocumentHandler()
          Default constructor.
 
Method Summary
 void endDocument()
          Indicates the end of a document.
 void endDocumentHeader()
          Indicates the end of the document header.
 void endPage()
          Indicates the end of a page
 void endPageContent()
          Indicates the end of the page content.
 void endPageHeader()
          Indicates the end of the page header.
 void endPageSequence()
          Indicates the end of a page sequence.
 void endPageTrailer()
          Indicates the end of the page trailer.
 IFDocumentHandlerConfigurator getConfigurator()
          Returns the configurator for this document handler, if any.
protected  org.apache.xmlgraphics.ps.PSResource getFormForImage(java.lang.String uri)
          Returns a PSResource instance representing a image as a PostScript form.
 java.lang.String getMimeType()
          Returns the MIME type of the output format that is generated by this implementation.
protected  org.apache.xmlgraphics.ps.PSResource getPSResourceForFontKey(java.lang.String key)
          Returns the PSResource for the given font key.
 void handleExtensionObject(java.lang.Object extension)
          Handles an extension object.
 void setContext(IFContext context)
          Sets the intermediate format context object.
 void startDocument()
          Indicates the start of a document.
 void startPage(int index, java.lang.String name, java.lang.String pageMasterName, java.awt.Dimension size)
          Indicates the start of a new page.
 IFPainter startPageContent()
          Indicates the start of the page content.
 void startPageHeader()
          Indicates the start of the page header.
 void startPageSequence(java.lang.String id)
          Indicates the start of a new page sequence.
 void startPageTrailer()
          Indicates the start of the page trailer.
 boolean supportsPagesOutOfOrder()
          Indicates whether the painter supports to handle the pages in mixed order rather than ascending order.
 
Methods inherited from class org.apache.fop.render.intermediate.AbstractBinaryWritingIFDocumentHandler
getFontInfo, setDefaultFontInfo, setFontInfo, setResult
 
Methods inherited from class org.apache.fop.render.intermediate.AbstractIFDocumentHandler
endDocumentTrailer, getContext, getDocumentNavigationHandler, getUserAgent, startDocumentHeader, startDocumentTrailer
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

psUtil

protected PSRenderingUtil psUtil
Utility class which enables all sorts of features that are not directly connected to the normal rendering process.


gen

protected org.apache.xmlgraphics.ps.PSGenerator gen
The PostScript generator used to output the PostScript

Constructor Detail

PSDocumentHandler

public PSDocumentHandler()
Default constructor.

Method Detail

supportsPagesOutOfOrder

public boolean supportsPagesOutOfOrder()
Indicates whether the painter supports to handle the pages in mixed order rather than ascending order.

Returns:
true if out-of-order handling is supported

getMimeType

public java.lang.String getMimeType()
Returns the MIME type of the output format that is generated by this implementation.

Returns:
the MIME type

setContext

public void setContext(IFContext context)
Sets the intermediate format context object.

Specified by:
setContext in interface IFDocumentHandler
Overrides:
setContext in class AbstractIFDocumentHandler
Parameters:
context - the context object

getConfigurator

public IFDocumentHandlerConfigurator getConfigurator()
Returns the configurator for this document handler, if any.

Returns:
the configurator or null if there's no configurator

startDocument

public void startDocument()
                   throws IFException
Indicates the start of a document. This method may only be called once before any other event method.

Specified by:
startDocument in interface IFDocumentHandler
Overrides:
startDocument in class AbstractBinaryWritingIFDocumentHandler
Throws:
IFException - if an error occurs while handling this event

endDocumentHeader

public void endDocumentHeader()
                       throws IFException
Indicates the end of the document header. This method is called before the first page sequence.

Specified by:
endDocumentHeader in interface IFDocumentHandler
Overrides:
endDocumentHeader in class AbstractIFDocumentHandler
Throws:
IFException - if an error occurs while handling this event

endDocument

public void endDocument()
                 throws IFException
Indicates the end of a document. This method may only be called once after the whole document has been handled. Implementations can release resources (close streams). It is an error to call any event method after this method.

Specified by:
endDocument in interface IFDocumentHandler
Overrides:
endDocument in class AbstractBinaryWritingIFDocumentHandler
Throws:
IFException - if an error occurs while handling this event

startPageSequence

public void startPageSequence(java.lang.String id)
                       throws IFException
Indicates the start of a new page sequence.

Parameters:
id - the page sequence's identifier (or null if none is available)
Throws:
IFException - if an error occurs while handling this event

endPageSequence

public void endPageSequence()
                     throws IFException
Indicates the end of a page sequence.

Throws:
IFException - if an error occurs while handling this event

startPage

public void startPage(int index,
                      java.lang.String name,
                      java.lang.String pageMasterName,
                      java.awt.Dimension size)
               throws IFException
Indicates the start of a new page.

Parameters:
index - the index of the page (0-based)
name - the page name (usually the formatted page number)
pageMasterName - the name of the simple-page-master that generated this page
size - the size of the page (equivalent to the MediaBox in PDF)
Throws:
IFException - if an error occurs while handling this event

startPageHeader

public void startPageHeader()
                     throws IFException
Indicates the start of the page header.

Specified by:
startPageHeader in interface IFDocumentHandler
Overrides:
startPageHeader in class AbstractIFDocumentHandler
Throws:
IFException - if an error occurs while handling this event

endPageHeader

public void endPageHeader()
                   throws IFException
Indicates the end of the page header.

Specified by:
endPageHeader in interface IFDocumentHandler
Overrides:
endPageHeader in class AbstractIFDocumentHandler
Throws:
IFException - if an error occurs while handling this event

startPageContent

public IFPainter startPageContent()
                           throws IFException
Indicates the start of the page content. The method returns an IFPainter interface which is used to paint the page contents.

Returns:
the IFPainter for the page content
Throws:
IFException - if an error occurs while handling this event

endPageContent

public void endPageContent()
                    throws IFException
Indicates the end of the page content. Calls to the IFPainter returned by the respective IFDocumentHandler.startPageContent() method are illegal.

Throws:
IFException - if an error occurs while handling this event

startPageTrailer

public void startPageTrailer()
                      throws IFException
Indicates the start of the page trailer. The page trailer is used for writing down page elements which are only know after handling the page itself (like PDF targets).

Specified by:
startPageTrailer in interface IFDocumentHandler
Overrides:
startPageTrailer in class AbstractIFDocumentHandler
Throws:
IFException - if an error occurs while handling this event

endPageTrailer

public void endPageTrailer()
                    throws IFException
Indicates the end of the page trailer.

Specified by:
endPageTrailer in interface IFDocumentHandler
Overrides:
endPageTrailer in class AbstractIFDocumentHandler
Throws:
IFException - if an error occurs while handling this event

endPage

public void endPage()
             throws IFException
Indicates the end of a page

Throws:
IFException - if an error occurs while handling this event

handleExtensionObject

public void handleExtensionObject(java.lang.Object extension)
                           throws IFException
Handles an extension object. This can be a DOM document or any arbitrary object. If an implementation doesn't know how to handle a particular extension it is simply ignored.

Parameters:
extension - the extension object
Throws:
IFException - if an error occurs while handling this event

getPSResourceForFontKey

protected org.apache.xmlgraphics.ps.PSResource getPSResourceForFontKey(java.lang.String key)
Returns the PSResource for the given font key.

Parameters:
key - the font key ("F*")
Returns:
the matching PSResource

getFormForImage

protected org.apache.xmlgraphics.ps.PSResource getFormForImage(java.lang.String uri)
Returns a PSResource instance representing a image as a PostScript form.

Parameters:
uri - the image URI
Returns:
a PSResource instance

fop 1.0

Copyright 1999-2010 The Apache Software Foundation. All Rights Reserved.