org.kuali.rice.krad.uif.freemarker
Class LifecycleRenderingContext

java.lang.Object
  org.kuali.rice.krad.uif.freemarker.LifecycleRenderingContext

public class LifecycleRenderingContext
extends Object

Encapsulates a FreeMarker environment for rendering within the view lifecycle.

Author:

Kuali Rice Team (rice.collab@kuali.org)

Constructor Summary

LifecycleRenderingContext(Object model, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse rawresponse)
Create FreeMarker environment for rendering within the view lifecycle.

Method Summary

void	clearRenderingBuffer() Clear the output buffer used during rendering, in preparation for rendering another component using the same environment.
freemarker.core.Environment	getEnvironment() Get the FreeMarker environment for processing the rendering phase, initializing the environment if needed.
String	getRenderedOutput() Get all output rendered in the FreeMarker environment.
void	importTemplate(String template) Import a FreeMarker template for rendering into the current environment.
boolean	isImported(String template)

Methods inherited from class java.lang.Object

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

Constructor Detail

LifecycleRenderingContext

public LifecycleRenderingContext(Object model,
                                 javax.servlet.http.HttpServletRequest request,
                                 javax.servlet.http.HttpServletResponse rawresponse)

Create FreeMarker environment for rendering within the view lifecycle.

Parameters:

request - The active servlet request.

rawresponse - The active servlet response.

Method Detail

getEnvironment

public freemarker.core.Environment getEnvironment()

Get the FreeMarker environment for processing the rendering phase, initializing the environment if needed.

Returns:

The FreeMarker environment for processing the rendering phase, initializing the environment if needed.

clearRenderingBuffer

public void clearRenderingBuffer()

Clear the output buffer used during rendering, in preparation for rendering another component using the same environment.

getRenderedOutput

public String getRenderedOutput()

Get all output rendered in the FreeMarker environment.

importTemplate

public void importTemplate(String template)

Import a FreeMarker template for rendering into the current environment.

Parameters:

template - The path to the FreeMarker template.

isImported

public boolean isImported(String template)