|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface RenderingEngineTemplate
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 |
---|
java.lang.String getName()
java.lang.String getTitle()
java.lang.String getDescription()
java.lang.String getOutputPathPattern()
RenderingEngine getRenderingEngine()
java.io.InputStream getInputStream() throws java.io.IOException
java.io.IOException
java.lang.String getOutputPathForRendition(FormInstanceData formInstanceData, java.lang.String currentAVMPath, java.lang.String name)
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
java.lang.String getMimetypeForRendition()
Rendition render(FormInstanceData formInstanceData, java.lang.String renditionAVMPath) throws java.io.IOException, org.xml.sax.SAXException, RenderingEngine.RenderingException
formInstanceData
- the form instance data for which to produce
the rendition.renditionAVMPath
- the path to use for the rendition.
java.io.IOException
org.xml.sax.SAXException
RenderingEngine.RenderingException
void render(FormInstanceData formInstanceData, Rendition rendition) throws java.io.IOException, org.xml.sax.SAXException, RenderingEngine.RenderingException
formInstanceData
- the form instance data for which to produce
the rendition.rendition
- the rendition to rerender
java.io.IOException
org.xml.sax.SAXException
RenderingEngine.RenderingException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |