org.springframework.extensions.directives

Class ChromeIncludeFreeMarkerDirective

java.lang.Object

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

org.springframework.extensions.directives.RenderServiceFreeMarkerDirective

org.springframework.extensions.directives.ChromeIncludeFreeMarkerDirective

All Implemented Interfaces:

freemarker.template.TemplateDirectiveModel, freemarker.template.TemplateModel

public class ChromeIncludeFreeMarkerDirective
extends RenderServiceFreeMarkerDirective

A FreeMarker directive that uses a PresentationService to render regions or component included in chrome.

Author:

David Draper

Field Summary

Fields inherited from interface freemarker.template.TemplateModel

NOTHING

Constructor Summary

Constructors

Constructor and Description
ChromeIncludeFreeMarkerDirective(String directiveName, RequestContext context, ModelObject object, RenderService renderService) Instantiates a new ChromeIncludeFreeMarkerDirective.

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) This method is declared by the TemplateDirectiveModel interface that the abstract superclass AbstractFreeMarkerDirective implements.

Methods inherited from class org.springframework.extensions.directives.RenderServiceFreeMarkerDirective

getObject, getRenderService, getRequestContext

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

Constructor Detail

ChromeIncludeFreeMarkerDirective

public ChromeIncludeFreeMarkerDirective(String directiveName,
                                RequestContext context,
                                ModelObject object,
                                RenderService renderService)

Instantiates a new ChromeIncludeFreeMarkerDirective. The RenderService will be used by calling its renderChromeInclude method to generate the output. The directive name is only needed for generating useful exception messages to assist debugging problems but an effort should be made to set it correctly

Parameters:

directiveName - The name of the directive represented by the instance of this class.

context - A RequestContext required as an argument to the RenderService method.

renderService - A RenderService used to generate the output of the directive by calling its renderRegion method.

Method Detail

execute

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

This method is declared by the TemplateDirectiveModel interface that the abstract superclass AbstractFreeMarkerDirective implements. It retrieves any properties supplied when invoking the directive and passes them onto the PresentationService.renderChromeInclude method.

Throws:

freemarker.template.TemplateException

IOException