fop 1.0

org.apache.fop.render
Class RendererFactory

java.lang.Object
  extended by org.apache.fop.render.RendererFactory

public class RendererFactory
extends java.lang.Object

Factory for FOEventHandlers and Renderers.


Constructor Summary
RendererFactory()
          Main constructor.
 
Method Summary
 void addDocumentHandlerMaker(AbstractIFDocumentHandlerMaker maker)
          Add a new document handler maker.
 void addDocumentHandlerMaker(java.lang.String className)
          Add a new document handler maker.
 void addFOEventHandlerMaker(AbstractFOEventHandlerMaker maker)
          Add a new FOEventHandlerMaker.
 void addFOEventHandlerMaker(java.lang.String className)
          Add a new FOEventHandlerMaker.
 void addRendererMaker(AbstractRendererMaker maker)
          Add a new RendererMaker.
 void addRendererMaker(java.lang.String className)
          Add a new RendererMaker.
 IFDocumentHandler createDocumentHandler(FOUserAgent userAgent, java.lang.String outputFormat)
          Creates a IFDocumentHandler object based on the desired output format.
 FOEventHandler createFOEventHandler(FOUserAgent userAgent, java.lang.String outputFormat, java.io.OutputStream out)
          Creates FOEventHandler instances based on the desired output.
 Renderer createRenderer(FOUserAgent userAgent, java.lang.String outputFormat)
          Creates a Renderer object based on render-type desired
 AbstractIFDocumentHandlerMaker getDocumentHandlerMaker(java.lang.String mime)
          Returns a RendererMaker which handles the given MIME type.
 AbstractFOEventHandlerMaker getFOEventHandlerMaker(java.lang.String mime)
          Returns a FOEventHandlerMaker which handles the given MIME type.
 AbstractRendererMaker getRendererMaker(java.lang.String mime)
          Returns a RendererMaker which handles the given MIME type.
 boolean isRendererPreferred()
          Indicates whether a Renderer is preferred over a IFDocumentHandler if both are available for the same MIME type.
 java.lang.String[] listSupportedMimeTypes()
           
 void setRendererPreferred(boolean value)
          Controls whether a Renderer is preferred over a IFDocumentHandler if both are available for the same MIME type.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RendererFactory

public RendererFactory()
Main constructor.

Method Detail

setRendererPreferred

public void setRendererPreferred(boolean value)
Controls whether a Renderer is preferred over a IFDocumentHandler if both are available for the same MIME type.

Parameters:
value - true to prefer the Renderer, false to prefer the IFDocumentHandler.

isRendererPreferred

public boolean isRendererPreferred()
Indicates whether a Renderer is preferred over a IFDocumentHandler if both are available for the same MIME type.

Returns:
true if the Renderer is preferred, false if the IFDocumentHandler is preferred.

addRendererMaker

public void addRendererMaker(AbstractRendererMaker maker)
Add a new RendererMaker. If another maker has already been registered for a particular MIME type, this call overwrites the existing one.

Parameters:
maker - the RendererMaker

addFOEventHandlerMaker

public void addFOEventHandlerMaker(AbstractFOEventHandlerMaker maker)
Add a new FOEventHandlerMaker. If another maker has already been registered for a particular MIME type, this call overwrites the existing one.

Parameters:
maker - the FOEventHandlerMaker

addDocumentHandlerMaker

public void addDocumentHandlerMaker(AbstractIFDocumentHandlerMaker maker)
Add a new document handler maker. If another maker has already been registered for a particular MIME type, this call overwrites the existing one.

Parameters:
maker - the intermediate format document handler maker

addRendererMaker

public void addRendererMaker(java.lang.String className)
Add a new RendererMaker. If another maker has already been registered for a particular MIME type, this call overwrites the existing one.

Parameters:
className - the fully qualified class name of the RendererMaker

addFOEventHandlerMaker

public void addFOEventHandlerMaker(java.lang.String className)
Add a new FOEventHandlerMaker. If another maker has already been registered for a particular MIME type, this call overwrites the existing one.

Parameters:
className - the fully qualified class name of the FOEventHandlerMaker

addDocumentHandlerMaker

public void addDocumentHandlerMaker(java.lang.String className)
Add a new document handler maker. If another maker has already been registered for a particular MIME type, this call overwrites the existing one.

Parameters:
className - the fully qualified class name of the document handler maker

getRendererMaker

public AbstractRendererMaker getRendererMaker(java.lang.String mime)
Returns a RendererMaker which handles the given MIME type.

Parameters:
mime - the requested output format
Returns:
the requested RendererMaker or null if none is available

getFOEventHandlerMaker

public AbstractFOEventHandlerMaker getFOEventHandlerMaker(java.lang.String mime)
Returns a FOEventHandlerMaker which handles the given MIME type.

Parameters:
mime - the requested output format
Returns:
the requested FOEventHandlerMaker or null if none is available

getDocumentHandlerMaker

public AbstractIFDocumentHandlerMaker getDocumentHandlerMaker(java.lang.String mime)
Returns a RendererMaker which handles the given MIME type.

Parameters:
mime - the requested output format
Returns:
the requested RendererMaker or null if none is available

createRenderer

public Renderer createRenderer(FOUserAgent userAgent,
                               java.lang.String outputFormat)
                        throws FOPException
Creates a Renderer object based on render-type desired

Parameters:
userAgent - the user agent for access to configuration
outputFormat - the MIME type of the output format to use (ex. "application/pdf").
Returns:
the new Renderer instance
Throws:
FOPException - if the renderer cannot be properly constructed

createFOEventHandler

public FOEventHandler createFOEventHandler(FOUserAgent userAgent,
                                           java.lang.String outputFormat,
                                           java.io.OutputStream out)
                                    throws FOPException
Creates FOEventHandler instances based on the desired output.

Parameters:
userAgent - the user agent for access to configuration
outputFormat - the MIME type of the output format to use (ex. "application/pdf").
out - the OutputStream where the output is written to (if applicable)
Returns:
the newly constructed FOEventHandler
Throws:
FOPException - if the FOEventHandler cannot be properly constructed

createDocumentHandler

public IFDocumentHandler createDocumentHandler(FOUserAgent userAgent,
                                               java.lang.String outputFormat)
                                        throws FOPException
Creates a IFDocumentHandler object based on the desired output format.

Parameters:
userAgent - the user agent for access to configuration
outputFormat - the MIME type of the output format to use (ex. "application/pdf").
Returns:
the new IFDocumentHandler instance
Throws:
FOPException - if the document handler cannot be properly constructed

listSupportedMimeTypes

public java.lang.String[] listSupportedMimeTypes()
Returns:
an array of all supported MIME types

fop 1.0

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