org.sakaiproject.portal.portlet.velocity

Class VelocityPortletRenderContext

java.lang.Object

org.sakaiproject.portal.portlet.velocity.VelocityPortletRenderContext

All Implemented Interfaces:

PortletRenderContext

public class VelocityPortletRenderContext
extends Object
implements PortletRenderContext

A render context based on the velocity context

Author:

ieb

Constructor Summary

Constructors

Constructor and Description
VelocityPortletRenderContext()

Method Summary

Methods

Modifier and Type	Method and Description
String	dump() Converr the render context to a string suitable for dumping to a log file or console.
Map	getOptions()
org.apache.velocity.context.Context	getVelocityContext()
boolean	isDebug()
void	put(String key, Object value) Set a value agaaisnt a Key, normally a value might be a String, Collection or a Map, but depending on the render engine technology other objects may be acceptable.
void	setDebug(boolean debug)
void	setOptions(Map options)
boolean	uses(String includeOption) Return true if the context needs this part of the portal

Methods inherited from class java.lang.Object

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

Constructor Detail

VelocityPortletRenderContext

public VelocityPortletRenderContext()

Method Detail

isDebug

public boolean isDebug()

setDebug

public void setDebug(boolean debug)

put

public void put(String key,
       Object value)

Description copied from interface: PortletRenderContext

Set a value agaaisnt a Key, normally a value might be a String, Collection or a Map, but depending on the render engine technology other objects may be acceptable.

Specified by:

put in interface PortletRenderContext

getVelocityContext

public org.apache.velocity.context.Context getVelocityContext()

dump

public String dump()

Description copied from interface: PortletRenderContext

Converr the render context to a string suitable for dumping to a log file or console.

Specified by:

dump in interface PortletRenderContext

Returns:

uses

public boolean uses(String includeOption)

Description copied from interface: PortletRenderContext

Return true if the context needs this part of the portal

Specified by:

uses in interface PortletRenderContext

Returns:

getOptions

public Map getOptions()

setOptions

public void setOptions(Map options)