org.springframework.extensions.directives

Class AutoComponentRegionDirective

java.lang.Object

org.springframework.extensions.surf.extensibility.impl.AbstractFreeMarkerDirective

org.springframework.extensions.directives.AutoComponentRegionDirective

All Implemented Interfaces:

freemarker.template.TemplateDirectiveModel, freemarker.template.TemplateModel

public class AutoComponentRegionDirective
extends org.springframework.extensions.surf.extensibility.impl.AbstractFreeMarkerDirective

The purpose of this directive is to circumvent the requirement to create and persist Components as a means of executing Aikau pages defined by a single WebScript. Previously the solution had been to use the CreateComponentDirective directive prior to using the RegionDirectiveData. However, this resulted in calls to persist the Component and were ultimately unnecessary. This solution simply requires that a new Component is created on demand and not persisted.

Author:

Dave Draper

Field Summary

Fields

Modifier and Type	Field and Description
static String	DIRECTIVE_NAME The name to reference this directive by in FreeMarker templates.

Fields inherited from interface freemarker.template.TemplateModel

NOTHING

Constructor Summary

Constructors

Constructor and Description
AutoComponentRegionDirective(String directiveName)

Method Summary

Methods

Modifier and Type	Method and Description
void	execute(freemarker.core.Environment env, Map params, freemarker.template.TemplateModel[] loopVars, freemarker.template.TemplateDirectiveBody body) Creates a new Component and sets it to use the supplied WebScript URI and is then immediately rendered
void	setRenderService(RenderService renderService) Set the RenderService required to render the Component
void	setRequestContext(RequestContext context) Set the RequestContext required for rendering the Component.

Methods inherited from class org.springframework.extensions.surf.extensibility.impl.AbstractFreeMarkerDirective

getBooleanProperty, getDirectiveName, getStringProperty

Methods inherited from class java.lang.Object

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

Field Detail

DIRECTIVE_NAME

public static final String DIRECTIVE_NAME

The name to reference this directive by in FreeMarker templates.

See Also:

Constant Field Values

Constructor Detail

AutoComponentRegionDirective

public AutoComponentRegionDirective(String directiveName)

Method Detail

setRequestContext

public void setRequestContext(RequestContext context)

Set the RequestContext required for rendering the Component.

Parameters:

context - RequestContext

setRenderService

public void setRenderService(RenderService renderService)

Set the RenderService required to render the Component

Parameters:

renderService - RenderService

execute

public void execute(freemarker.core.Environment env,
           Map params,
           freemarker.template.TemplateModel[] loopVars,
           freemarker.template.TemplateDirectiveBody body)
             throws freemarker.template.TemplateException,
                    IOException

Creates a new Component and sets it to use the supplied WebScript URI and is then immediately rendered

Throws:

freemarker.template.TemplateException

IOException