Package com.aquima.interactions.framework.documents.ibex

Class IBexRendererBase

java.lang.Object

com.aquima.interactions.framework.documents.XmlFoRendererBase

com.aquima.interactions.framework.documents.ibex.IBexRendererBase

All Implemented Interfaces:

IDocumentRenderer

Direct Known Subclasses:

IBexRenderer

public abstract class IBexRendererBase
extends XmlFoRendererBase

IDocumentRenderer implementation using IBex renderer to render a document. For more info visit http://xmlpdf.com/ This renderer supports rendering to PDF (OutputFormat.Pdf).

Since:

6.0

Author:

Jon van Leuven

Field Summary

Fields

Modifier and Type	Field	Description
protected static Logger	LOG

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	IBexRendererBase(IResource xslStyleSheet, IXmlRenderer documentXmlRenderer, ILicenseProvider licenseProvider)	Constructs an instance of the IBex renderer.
protected	IBexRendererBase(IResource xslStyleSheet, IXmlRenderer documentXmlRenderer, IResourceManager resourceManager, ILicenseProvider licenseProvider)	Constructs an instance of the IBex renderer.

Method Summary

Modifier and Type	Method	Description
protected abstract void	generate(ICompositeElement document, OutputStream result, InputStream xslStream, InputStream documentStream, ibex4.FODocument foDocument)
protected IFODocumentHandler	getDocumentHandler()
protected Map<String,byte[]>	getDocumentImages(ICompositeElement element, IPortalContext portalContext)
protected void	getDocumentImages(Map<String,byte[]> images, IElement[] elements, IPortalContext portalContext)
protected void	getDocumentImages(Map<String,byte[]> images, IElement element, IPortalContext portalContext)
OutputFormat[]	getOutputFormats()	This method returns the output formats the renderer supports.
void	renderDocument(IResource documentXml, ICompositeElement document, IRenderTarget result, IPortalContext portalContext)
void	setDocumentHandler(IFODocumentHandler handler)	Set a document handler.

Methods inherited from class com.aquima.interactions.framework.documents.XmlFoRendererBase

getXslStyleSheet, renderDocument

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final Logger LOG

Constructor Detail

IBexRendererBase

protected IBexRendererBase(IResource xslStyleSheet,
                           IXmlRenderer documentXmlRenderer,
                           ILicenseProvider licenseProvider)

Constructs an instance of the IBex renderer.

Parameters:

xslStyleSheet - Xsl style sheet to be use for xml-fo creation (required).

documentXmlRenderer - Converter to create xml from a document (required).

IBexRendererBase

protected IBexRendererBase(IResource xslStyleSheet,
                           IXmlRenderer documentXmlRenderer,
                           IResourceManager resourceManager,
                           ILicenseProvider licenseProvider)

Constructs an instance of the IBex renderer.

Parameters:

xslStyleSheet - Xsl style sheet to be use for xml-fo creation (required).

documentXmlRenderer - Converter to create xml from a document (required).

resourceManager - The resource manager that should be used to locate style-sheet and configuration information.

Method Detail

getOutputFormats

public OutputFormat[] getOutputFormats()

Description copied from interface: IDocumentRenderer

This method returns the output formats the renderer supports.

Returns:

The output formats of the renderer, should never return null or an empty array.

getDocumentHandler

protected IFODocumentHandler getDocumentHandler()

renderDocument

public void renderDocument(IResource documentXml,
                           ICompositeElement document,
                           IRenderTarget result,
                           IPortalContext portalContext)

Specified by:

renderDocument in class XmlFoRendererBase

generate

protected abstract void generate(ICompositeElement document,
                                 OutputStream result,
                                 InputStream xslStream,
                                 InputStream documentStream,
                                 ibex4.FODocument foDocument)

getDocumentImages

protected Map<String,byte[]> getDocumentImages(ICompositeElement element,
                                                     IPortalContext portalContext)

getDocumentImages

protected void getDocumentImages(Map<String,byte[]> images,
                                 IElement[] elements,
                                 IPortalContext portalContext)

getDocumentImages

protected void getDocumentImages(Map<String,byte[]> images,
                                 IElement element,
                                 IPortalContext portalContext)

setDocumentHandler

public void setDocumentHandler(IFODocumentHandler handler)

Set a document handler. This handler is called before a document is render and provides a way to change the FODocument before rendering.

Parameters:

handler - Handler to handle the FODocument.