org.springframework.extensions.directives

Class LinkFreeMarkerDirective

java.lang.Object

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

org.springframework.extensions.directives.RenderServiceFreeMarkerDirective

org.springframework.extensions.directives.LinkFreeMarkerDirective

All Implemented Interfaces:

freemarker.template.TemplateDirectiveModel, freemarker.template.TemplateModel

public class LinkFreeMarkerDirective
extends RenderServiceFreeMarkerDirective

This class uses a PresentationService to render a link to the object defined by the supplied parameters. It is the FreeMarker equivalent of the custom JSP ObjectLinkTag.

Author:

David Draper

Field Summary

Fields inherited from interface freemarker.template.TemplateModel

NOTHING

Constructor Summary

Constructors

Constructor and Description
LinkFreeMarkerDirective(String directiveName, RenderService renderService) Instantiates a new LinkFreeMarkerDirective.

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 implemented to satisfy the TemplateDirectiveModel interface that is implemented by the AbstractFreeMarkerDirective in the class hierarchy.

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

LinkFreeMarkerDirective

public LinkFreeMarkerDirective(String directiveName,
                       RenderService renderService)

Instantiates a new LinkFreeMarkerDirective. The RenderService will be used by calling its generateLink 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.

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

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 implemented to satisfy the TemplateDirectiveModel interface that is implemented by the AbstractFreeMarkerDirective in the class hierarchy. It retrieves the any parameters that have been supplied when invoking the directive and passes them onto the PresentationService to render the link text which is then output.

Throws:

freemarker.template.TemplateException

IOException