org.alfresco.web.forms

Interface Rendition

All Superinterfaces:

java.io.Serializable

public interface Rendition
extends java.io.Serializable

Encapsulation of a rendition.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getDescription() the description of this rendition
java.lang.String	getDescriptionAttribute() the HTML description attribute for UI
java.lang.String	getFileTypeImage() the file type image for the rendition
java.lang.String	getLabelAttribute() the HTML label attribute for UI
java.lang.String	getName() the name of this rendition
java.io.OutputStream	getOutputStream() the output stream for the rendition
java.lang.String	getPath() the path to the contents of this rendition
FormInstanceData	getPrimaryFormInstanceData() the primary form instance data used to generate this rendition
FormInstanceData	getPrimaryFormInstanceData(boolean includeDeleted) the primary form instance data used to generate this rendition (include deleted AVM nodes)
RenderingEngineTemplate	getRenderingEngineTemplate() the rendering engine template that generated this rendition
java.lang.String	getSandboxRelativePath() the path relative to the sandbox
java.lang.String	getUrl() the url to the asset
java.lang.String	getWebappRelativePath() the path relative to the containing webapp
void	regenerate() regenerates the contents of this rendition using the primary form instance data
void	regenerate(FormInstanceData formInstanceData) regenerates the contents of this rendition using the provided form instance data

Method Detail

getName

java.lang.String getName()

the name of this rendition

getDescription

java.lang.String getDescription()

the description of this rendition

getWebappRelativePath

java.lang.String getWebappRelativePath()

the path relative to the containing webapp

getSandboxRelativePath

java.lang.String getSandboxRelativePath()

the path relative to the sandbox

getPrimaryFormInstanceData

FormInstanceData getPrimaryFormInstanceData()
                                            throws java.io.FileNotFoundException

the primary form instance data used to generate this rendition

Throws:

java.io.FileNotFoundException

getPrimaryFormInstanceData

FormInstanceData getPrimaryFormInstanceData(boolean includeDeleted)
                                            throws java.io.FileNotFoundException

the primary form instance data used to generate this rendition (include deleted AVM nodes)

Throws:

java.io.FileNotFoundException

getRenderingEngineTemplate

RenderingEngineTemplate getRenderingEngineTemplate()

the rendering engine template that generated this rendition

getPath

java.lang.String getPath()

the path to the contents of this rendition

getUrl

java.lang.String getUrl()

the url to the asset

getFileTypeImage

java.lang.String getFileTypeImage()

the file type image for the rendition

getOutputStream

java.io.OutputStream getOutputStream()

the output stream for the rendition

getLabelAttribute

java.lang.String getLabelAttribute()

the HTML label attribute for UI

getDescriptionAttribute

java.lang.String getDescriptionAttribute()

the HTML description attribute for UI

regenerate

void regenerate()
                throws java.io.IOException,
                       RenderingEngine.RenderingException,
                       org.xml.sax.SAXException

regenerates the contents of this rendition using the primary form instance data

Throws:

java.io.IOException

RenderingEngine.RenderingException

org.xml.sax.SAXException

regenerate

void regenerate(FormInstanceData formInstanceData)
                throws java.io.IOException,
                       RenderingEngine.RenderingException,
                       org.xml.sax.SAXException

regenerates the contents of this rendition using the provided form instance data

Throws:

java.io.IOException

RenderingEngine.RenderingException

org.xml.sax.SAXException