Package com.aquima.interactions.portal.documents

Interface IDocumentRenderer

public interface IDocumentRenderer

This interface should be implemented by classes that can render a runtime document model.

Since:

6.0

Author:

Jon van Leuven, O. Kerpershoek

Method Summary

Modifier and Type	Method	Description
OutputFormat[]	getOutputFormats()	This method returns the output formats the renderer supports.
void	renderDocument(ICompositeElement document, ILanguage language, ApplicationID applicationId, IRenderTarget result, IPortalContext portalContext)	This method should render the runtime document model to output streams for the specified output formats.

Method Details

getOutputFormats

OutputFormat[] getOutputFormats()

This method returns the output formats the renderer supports.

Returns:

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

renderDocument

void renderDocument(ICompositeElement document,
 ILanguage language,
 ApplicationID applicationId,
 IRenderTarget result,
 IPortalContext portalContext)

This method should render the runtime document model to output streams for the specified output formats.

Parameters:

document - The document that should be rendered.

language - The language to use for rendering.

applicationId - The current application id.

result - The object that should be used to write the result to.

portalContext - Current portal context.

Since:

9.9.5