Package com.aquima.interactions.portal.documents

Interface IRendererFactory

All Known Implementing Classes:

LinkedRendererFactory, NoOpRendererFactory, RendererFactory

public interface IRendererFactory

This internal interface is used by the document engine to request a document renderer.

Since:

6.0

Author:

O. Kerpershoek, Jon van Leuven

Method Summary

Modifier and Type	Method	Description
OutputFormat[]	getOutputFormats()	This method returns the output formats that are supported by the renderer factory.
IDocumentRenderer	getRenderer(IResourceManager manager, String documentName, OutputFormat[] formats)	This method returns the document renderer for the specified format.

Method Details

getOutputFormats

OutputFormat[] getOutputFormats()

This method returns the output formats that are supported by the renderer factory.

Returns:

Array containing the output formats that are supported by the renderer factory.

getRenderer

IDocumentRenderer getRenderer(IResourceManager manager,
 String documentName,
 OutputFormat[] formats)
                       throws UnsupportedOutputFormatException

This method returns the document renderer for the specified format.

Parameters:

manager - A resource manager that can be used to initialize a renderer.

documentName - The name of the document for which a renderer is requested.

formats - The output format(s) for which a renderer is requested.

Returns:

The document renderer for the specified output format.

Throws:

UnsupportedOutputFormatException - This exception is thrown when no renderer is available for the requested output format.