org.sakaiproject.portal.portlet.velocity

Class VelocityPortletRenderEngine

java.lang.Object

org.sakaiproject.portal.portlet.velocity.VelocityPortletRenderEngine

All Implemented Interfaces:

PortletRenderEngine

public class VelocityPortletRenderEngine
extends Object
implements PortletRenderEngine

A velocity render engine adapter

Author:

ieb

Field Summary

Fields inherited from interface org.sakaiproject.portal.portlet.PortletRenderEngine

DEFAULT_RENDER_ENGINE

Constructor Summary

Constructors

Constructor and Description
VelocityPortletRenderEngine()

Method Summary

Methods

Modifier and Type	Method and Description
void	init() Initialise the render engine
boolean	isDebug()
PortletRenderContext	newRenderContext(javax.portlet.RenderRequest request) generate a non thread safe render context for the current request/thread/operation
void	render(String template, PortletRenderContext rcontext, Writer out) Render a PortalRenderContext against a template.
void	setDebug(boolean debug)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VelocityPortletRenderEngine

public VelocityPortletRenderEngine()

Method Detail

init

public void init()
          throws Exception

Description copied from interface: PortletRenderEngine

Initialise the render engine

Specified by:

init in interface PortletRenderEngine

Throws:

Exception

newRenderContext

public PortletRenderContext newRenderContext(javax.portlet.RenderRequest request)

Description copied from interface: PortletRenderEngine

generate a non thread safe render context for the current request/thread/operation

Specified by:

newRenderContext in interface PortletRenderEngine

Returns:

render

public void render(String template,
          PortletRenderContext rcontext,
          Writer out)
            throws Exception

Description copied from interface: PortletRenderEngine

Render a PortalRenderContext against a template. The real template may be based on a skining name, out output will be send to the Writer

Specified by:

render in interface PortletRenderEngine

Throws:

Exception

isDebug

public boolean isDebug()

setDebug

public void setDebug(boolean debug)