org.springframework.extensions.surf.render

Interface Renderable

All Known Implementing Classes:

AbstractRenderableModelObject, AdvancedComponentImpl, ChromeImpl, ComponentImpl, ComponentTypeImpl, SubComponent, SurfBugImpl, 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

Methods

Modifier and Type	Method and Description
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

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 - RenderMode

Returns:

the processor id

getProcessorProperty

String getProcessorProperty(String propertyName)

Gets a default 'view' processor property

Parameters:

propertyName - String

Returns:

the processor property value

getProcessorProperty

String getProcessorProperty(RenderMode renderMode,
                          String propertyName)

Gets a processor property

Parameters:

renderMode - RenderMode

propertyName - String

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