org.springframework.extensions.surf.render
Interface Renderable

All Known Implementing Classes:

AbstractRenderableModelObject, ChromeImpl, ComponentTypeImpl, TemplateTypeImpl

public interface Renderable

Implemented by object types which wish to expose a set of renderer configurations. Each renderer configuration identifies a processor id and provides the processor with information about how to render. A renderable object is one that has renderer processors defined on it for one or more render modes.

Author:

muzquiano

Method Summary

String	getProcessorId() Gets the default 'view' processor id
String	getProcessorId(RenderMode renderMode) Gets the processor id
Map<String,String>	getProcessorProperties() Gets a map of default 'view' processor properties
Map<String,String>	getProcessorProperties(RenderMode renderMode) Gets a map of processor properties for the given mode
String	getProcessorProperty(RenderMode renderMode, String propertyName) Gets a processor property
String	getProcessorProperty(String propertyName) Gets a default 'view' processor property
RenderMode[]	getRenderModes() The list of defined render modes
void	removeProcessor() Removes the default processor
void	removeProcessor(RenderMode renderMode) Removes the processor for the given render mode
void	setProcessorProperty(RenderMode renderMode, String propertyName, String propertyValue) Sets a processor property for a given render mode
void	setProcessorProperty(String propertyName, String propertyValue) Sets a property on the default 'view' processor

Method Detail

getRenderModes

RenderMode[] getRenderModes()

The list of defined render modes

Returns:

an array of render modes

getProcessorId

String getProcessorId()

Gets the default 'view' processor id

Returns:

the processor id

getProcessorId

String getProcessorId(RenderMode renderMode)

Gets the processor id

Parameters:

renderMode -

Returns:

the processor id

getProcessorProperty

String getProcessorProperty(String propertyName)

Gets a default 'view' processor property

Parameters:

propertyName -

Returns:

the processor property value

getProcessorProperty

String getProcessorProperty(RenderMode renderMode,
                            String propertyName)

Gets a processor property

Parameters:

renderMode -

propertyName -

Returns:

the processor property value

getProcessorProperties

Map<String,String> getProcessorProperties()

Gets a map of default 'view' processor properties

Returns:

the map

getProcessorProperties

Map<String,String> getProcessorProperties(RenderMode renderMode)

Gets a map of processor properties for the given mode

Parameters:

renderMode - the render mode

Returns:

the map

setProcessorProperty

void setProcessorProperty(String propertyName,
                          String propertyValue)

Sets a property on the default 'view' processor

Parameters:

propertyName -

propertyValue -

setProcessorProperty

void setProcessorProperty(RenderMode renderMode,
                          String propertyName,
                          String propertyValue)

Sets a processor property for a given render mode

Parameters:

renderMode - the render mode

propertyName -

propertyValue -

removeProcessor

void removeProcessor()

Removes the default processor

removeProcessor

void removeProcessor(RenderMode renderMode)

Removes the processor for the given render mode

Parameters:

renderMode - the renderer mode