org.alfresco.web.forms
Interface RenderingEngine

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
FreeMarkerRenderingEngine, XSLFORenderingEngine, XSLTRenderingEngine

public interface RenderingEngine
extends java.io.Serializable

Serializes the xml instance data collected by a form to a writer.


Nested Class Summary
static class RenderingEngine.RenderingException
           
static class RenderingEngine.TemplateNotFoundException
           
static interface RenderingEngine.TemplateProcessorMethod
           
static interface RenderingEngine.TemplateResourceResolver
           
 
Field Summary
static org.alfresco.service.namespace.QName ROOT_NAMESPACE
           
 
Method Summary
 java.lang.String getDefaultTemplateFileExtension()
          Returns the default file extension for rendering engine templates for this rendering engine.
 java.lang.String getName()
          Returns the rendering engines name.
 void render(java.util.Map model, RenderingEngineTemplate ret, java.io.OutputStream out)
          Renders the xml data in to a presentation format.
 

Field Detail

ROOT_NAMESPACE

static final org.alfresco.service.namespace.QName ROOT_NAMESPACE
Method Detail

getName

java.lang.String getName()
Returns the rendering engines name.

Returns:
the name of the rendering engine.

getDefaultTemplateFileExtension

java.lang.String getDefaultTemplateFileExtension()
Returns the default file extension for rendering engine templates for this rendering engine.

Returns:
the default file extension for rendering engine templates for this rendering engine.

render

void render(java.util.Map model,
            RenderingEngineTemplate ret,
            java.io.OutputStream out)
            throws java.io.IOException,
                   RenderingEngine.RenderingException,
                   org.xml.sax.SAXException
Renders the xml data in to a presentation format.

Parameters:
model - The model
ret - the rendering engine template
out - The output stream to write to
Throws:
java.io.IOException
RenderingEngine.RenderingException
org.xml.sax.SAXException


Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.