Package org.apache.fop.render
Class RendererFactory
java.lang.Object
org.apache.fop.render.RendererFactory
Factory for FOEventHandlers and Renderers.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addDocumentHandlerMaker
(String className) Add a new document handler maker.void
Add a new document handler maker.void
addFOEventHandlerMaker
(String className) Add a new FOEventHandlerMaker.void
Add a new FOEventHandlerMaker.void
addRendererMaker
(String className) Add a new RendererMaker.void
Add a new RendererMaker.createDocumentHandler
(FOUserAgent userAgent, String outputFormat) Creates aIFDocumentHandler
object based on the desired output format.createFOEventHandler
(FOUserAgent userAgent, String outputFormat, OutputStream out) Creates FOEventHandler instances based on the desired output.createRenderer
(FOUserAgent userAgent, String outputFormat) Creates a Renderer object based on render-type desiredgetFOEventHandlerMaker
(String mime) Returns a FOEventHandlerMaker which handles the given MIME type.getRendererMaker
(String mime) Returns a RendererMaker which handles the given MIME type.boolean
Indicates whether aRenderer
is preferred over aIFDocumentHandler
if both are available for the same MIME type.String[]
-
Constructor Details
-
RendererFactory
public RendererFactory(boolean rendererPreferred) Main constructor.- Parameters:
rendererPreferred
- Controls whether aRenderer
is preferred over aIFDocumentHandler
if both are available for the same MIME type. True to prefer theRenderer
, false to prefer theIFDocumentHandler
.
-
-
Method Details
-
isRendererPreferred
public boolean isRendererPreferred()Indicates whether aRenderer
is preferred over aIFDocumentHandler
if both are available for the same MIME type.- Returns:
- true if the
Renderer
is preferred, false if theIFDocumentHandler
is preferred.
-
addRendererMaker
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
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
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
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
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
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
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
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
-
createRenderer
Creates a Renderer object based on render-type desired- Parameters:
userAgent
- the user agent for access to configurationoutputFormat
- 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, String outputFormat, OutputStream out) throws FOPException Creates FOEventHandler instances based on the desired output.- Parameters:
userAgent
- the user agent for access to configurationoutputFormat
- 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, String outputFormat) throws FOPException Creates aIFDocumentHandler
object based on the desired output format.- Parameters:
userAgent
- the user agent for access to configurationoutputFormat
- 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
- Returns:
- an array of all supported MIME types
-