org.alfresco.web.forms
Interface RenderingEngineTemplate

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
RenderingEngineTemplateImpl

public interface RenderingEngineTemplate
extends java.io.Serializable

Describes a template that is used for rendering form instance data.


Method Summary
 java.lang.String getDescription()
          the description of the rendering engine template
 java.io.InputStream getInputStream()
          Provides an input stream to the rendering engine template.
 java.lang.String getMimetypeForRendition()
          Returns the mimetype to use when generating content for this output method.
 java.lang.String getName()
          the name of the rendering engine template
 java.lang.String getOutputPathForRendition(FormInstanceData formInstanceData, java.lang.String currentAVMPath, java.lang.String name)
          Returns the output path for the rendition.
 java.lang.String getOutputPathPattern()
          the output path pattern for renditions
 RenderingEngine getRenderingEngine()
          Provides the rendering engine to use to process this template.
 java.lang.String getTitle()
          the title of the rendering engine template
 void render(FormInstanceData formInstanceData, Rendition rendition)
          Produces a rendition of the provided formInstanceData to an existing rendition.
 Rendition render(FormInstanceData formInstanceData, java.lang.String renditionAVMPath)
          Produces a rendition of the provided formInstanceData.
 

Method Detail

getName

java.lang.String getName()
the name of the rendering engine template


getTitle

java.lang.String getTitle()
the title of the rendering engine template


getDescription

java.lang.String getDescription()
the description of the rendering engine template


getOutputPathPattern

java.lang.String getOutputPathPattern()
the output path pattern for renditions


getRenderingEngine

RenderingEngine getRenderingEngine()
Provides the rendering engine to use to process this template.

Returns:
the rendering engine to use to process this template.

getInputStream

java.io.InputStream getInputStream()
                                   throws java.io.IOException
Provides an input stream to the rendering engine template.

Returns:
the input stream to the rendering engine template.
Throws:
java.io.IOException

getOutputPathForRendition

java.lang.String getOutputPathForRendition(FormInstanceData formInstanceData,
                                           java.lang.String currentAVMPath,
                                           java.lang.String name)
Returns the output path for the rendition.

Parameters:
formInstanceData - the form instance data to use for processing the pattern.
currentAVMPath - the current path where the form is being created.
name - the name which is used in a pattern
Returns:
the output path for the rendition.

getMimetypeForRendition

java.lang.String getMimetypeForRendition()
Returns the mimetype to use when generating content for this output method.

Returns:
the mimetype to use when generating content for this output method, such as text/html, text/xml, application/pdf.

render

Rendition render(FormInstanceData formInstanceData,
                 java.lang.String renditionAVMPath)
                 throws java.io.IOException,
                        org.xml.sax.SAXException,
                        RenderingEngine.RenderingException
Produces a rendition of the provided formInstanceData.

Parameters:
formInstanceData - the form instance data for which to produce the rendition.
renditionAVMPath - the path to use for the rendition.
Throws:
java.io.IOException
org.xml.sax.SAXException
RenderingEngine.RenderingException

render

void render(FormInstanceData formInstanceData,
            Rendition rendition)
            throws java.io.IOException,
                   org.xml.sax.SAXException,
                   RenderingEngine.RenderingException
Produces a rendition of the provided formInstanceData to an existing rendition.

Parameters:
formInstanceData - the form instance data for which to produce the rendition.
rendition - the rendition to rerender
Throws:
java.io.IOException
org.xml.sax.SAXException
RenderingEngine.RenderingException


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