org.springframework.extensions.directives

Class RenderServiceFreeMarkerDirective

java.lang.Object

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

org.springframework.extensions.directives.RenderServiceFreeMarkerDirective

All Implemented Interfaces:

freemarker.template.TemplateDirectiveModel, freemarker.template.TemplateModel

Direct Known Subclasses:

AnchorFreeMarkerDirective, ChromeIncludeFreeMarkerDirective, ComponentFreemarkerTagDirective, LinkFreeMarkerDirective, ResourceFreemarkerTagDirective, StyleSheetFreeMarkerDirective, SurfBugIncludeFreeMarkerDirective

public abstract class RenderServiceFreeMarkerDirective
extends org.springframework.extensions.surf.extensibility.impl.AbstractFreeMarkerDirective

Field Summary

Fields inherited from interface freemarker.template.TemplateModel

NOTHING

Constructor Summary

Constructors

Constructor and Description
RenderServiceFreeMarkerDirective(String directiveName, RequestContext context, ModelObject object, RenderService renderService) This constructor will need to invoked by subclasses and ensures that a directive name, RequestContext and RenderService are provided.

Method Summary

Methods

Modifier and Type	Method and Description
ModelObject	getObject()
RenderService	getRenderService() Returns the RenderService supplied when instantiating the class.
RequestContext	getRequestContext() Returns the RequestContext supplied when instantiating the class

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

Methods inherited from interface freemarker.template.TemplateDirectiveModel

execute

Constructor Detail

RenderServiceFreeMarkerDirective

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

This constructor will need to invoked by subclasses and ensures that a directive name, RequestContext and RenderService are provided. The RenderService will be used to generate the output rendered when invoking the directive represented by the subclass. The RequestContext is typically required as an argument for RenderService methods and 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 methods.

renderService - A RenderService used to generate the output of the directive.

Method Detail

getRenderService

public RenderService getRenderService()

Returns the RenderService supplied when instantiating the class.

Returns:

A RenderService

getRequestContext

public RequestContext getRequestContext()

Returns the RequestContext supplied when instantiating the class

Returns:

A RequestContext

getObject

public ModelObject getObject()