org.springframework.extensions.directives

Class RelocateJavaScriptOutputDirective

java.lang.Object

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

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

org.springframework.extensions.directives.AbstractDependencyExtensibilityDirective

org.springframework.extensions.directives.RelocateJavaScriptOutputDirective

All Implemented Interfaces:

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

public class RelocateJavaScriptOutputDirective
extends AbstractDependencyExtensibilityDirective

Allows the JavaScript content generated by the OutputJavaScriptDirective to be relocated within the context of a model. The reason this directive is required is that the OutputJavaScriptDirective needs to be initially placed in the model before any directives that use its DefaultContentModelElement approach (such as the AggregateJavaScriptDependencyDirective and the CreateWebScriptWidgetsDirective) can add content for it to render. However, the proper location for JavaScript is at the end of an HTML page so this directive can be used to move the generated JavaScript to another location on the page before the model is flushed.

Author:

David Draper

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.extensions.directives.AbstractDependencyExtensibilityDirective

AbstractDependencyExtensibilityDirective.ProcessedDependency

Field Summary

Fields inherited from class org.springframework.extensions.directives.AbstractDependencyExtensibilityDirective

dependencyAggregator, dependencyHandler

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
RelocateJavaScriptOutputDirective(String directiveName, org.springframework.extensions.surf.extensibility.ExtensibilityModel model)

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) Attempts to retrieve a OutputJavaScriptContentModelElement that has been added to the ExtensibilityModel by through the use of a OutputJavaScriptDirective directive.
void	execute(freemarker.core.Environment env, Map params, freemarker.template.TemplateModel[] loopVars, freemarker.template.TemplateDirectiveBody body)

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

getModelObject, getRequestContext, getResourceControllerMapping, getToInsert, getUpdatedSrc, getWebFrameworkConfig, processDependency, setDependencyAggregator, setDependencyHandler, setModelObject, setRequestContext, setWebFrameworkConfig

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

after, before, 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

RelocateJavaScriptOutputDirective

public RelocateJavaScriptOutputDirective(String directiveName,
                                 org.springframework.extensions.surf.extensibility.ExtensibilityModel model)

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

Specified by:

execute in interface freemarker.template.TemplateDirectiveModel

Overrides:

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

Throws:

freemarker.template.TemplateException

IOException

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)

Attempts to retrieve a OutputJavaScriptContentModelElement that has been added to the ExtensibilityModel by through the use of a OutputJavaScriptDirective directive. However, if this ContentModelElement cannot be found then it will be substituted by an DiscardUnboundContentModelElementImpl which whilst not generating any error in processing may cause unexpected behaviour in the HTML page because no JavaScript relocation will take place.

Overrides:

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