org.springframework.extensions.directives

Class RegionFreemarkerTagDirective

java.lang.Object

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

org.springframework.extensions.surf.extensibility.impl.AbstractExtensibilityDirective

org.springframework.extensions.directives.RenderServiceExtensibilityDirective

org.springframework.extensions.directives.RegionFreemarkerTagDirective

All Implemented Interfaces:

freemarker.template.TemplateDirectiveModel, freemarker.template.TemplateModel, org.springframework.extensions.surf.extensibility.ExtensibilityDirective

public class RegionFreemarkerTagDirective
extends RenderServiceExtensibilityDirective

A FreeMarker directive that uses a PresentationService to render the region specified through properties supplied when invoking it.

Author:

David Draper

Field Summary

Fields inherited from interface org.springframework.extensions.surf.extensibility.ExtensibilityDirective

ACTION, ACTION_AFTER, ACTION_BEFORE, ACTION_MERGE, ACTION_MODIFY, ACTION_REMOVE, ACTION_REPLACE, DIRECTIVE_ID, TARGET

Fields inherited from interface freemarker.template.TemplateModel

NOTHING

Constructor Summary

Constructors

Constructor and Description
RegionFreemarkerTagDirective(String directiveName, org.springframework.extensions.surf.extensibility.ExtensibilityModel model, RequestContext context, ModelObject object, RenderService renderService) Instantiates a new RegionFreemarkerTagDirective.

Method Summary

Methods

Modifier and Type	Method and Description
org.springframework.extensions.surf.extensibility.ExtensibilityDirectiveData	createExtensibilityDirectiveData(String id, String action, String target, Map params, freemarker.template.TemplateDirectiveBody body, freemarker.core.Environment env) Overrides the the default directive to create a RegionDirectiveData object for storing the extensibility directive data.

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

getObject, getRenderService, getRequestContext

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

after, before, execute, getId, getModel, merge, remove, replace

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

RegionFreemarkerTagDirective

public RegionFreemarkerTagDirective(String directiveName,
                            org.springframework.extensions.surf.extensibility.ExtensibilityModel model,
                            RequestContext context,
                            ModelObject object,
                            RenderService renderService)

Instantiates a new RegionFreemarkerTagDirective. The RenderService will be used by calling its renderRegion 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 RenderContext required as an argument to the RenderService.renderRegion method.

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

Method Detail

createExtensibilityDirectiveData

public org.springframework.extensions.surf.extensibility.ExtensibilityDirectiveData createExtensibilityDirectiveData(String id,
                                                                                                            String action,
                                                                                                            String target,
                                                                                                            Map params,
                                                                                                            freemarker.template.TemplateDirectiveBody body,
                                                                                                            freemarker.core.Environment env)
                                                                                                              throws freemarker.template.TemplateException

Overrides the the default directive to create a RegionDirectiveData object for storing the extensibility directive data. This differs from the default implementation in that it provides an alternative render method which allows us to delegate to the associated RenderService.

Overrides:

createExtensibilityDirectiveData in class org.springframework.extensions.surf.extensibility.impl.AbstractExtensibilityDirective

Throws:

freemarker.template.TemplateException