org.springframework.extensions.directives

Class AddInlineJavaScriptDirective

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.JavaScriptDependencyDirective

org.springframework.extensions.directives.AddInlineJavaScriptDirective

All Implemented Interfaces:

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

public class AddInlineJavaScriptDirective
extends JavaScriptDependencyDirective

This FreeMarker directive should be used to add raw JavaScript. As well as ensuring that the correct script blocks are output it also allows JavaScript to be relocated to other locations within the ExtensibilityModel via the RelocateJavaScriptOutputDirective which enables WebScripts to ensure that all JavaScript appears at the end of an HTML page as is recommended for optimum performance. It also ensures that raw JavaScript inserts are placed correctly within aggregated JavaScript resource files (generated by the DependencyAggregator service) via the group attribute.

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.JavaScriptDependencyDirective

FORCE_AGGREGATED_OUTPUT_PARAM

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

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addLegacyDependencyRequest(Map params) Overridden to prevent the "src" attribute not specified when running in legacy mode.
org.springframework.extensions.surf.extensibility.ExtensibilityDirectiveData	createExtensibilityDirectiveData(String id, String action, String target, Map params, freemarker.template.TemplateDirectiveBody body, freemarker.core.Environment env)

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

createDependencyDirectiveData, execute, getDependencySource, getTargetElement

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

AddInlineJavaScriptDirective

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

Method Detail

addLegacyDependencyRequest

protected void addLegacyDependencyRequest(Map params)
                                   throws freemarker.template.TemplateModelException

Overridden to prevent the "src" attribute not specified when running in legacy mode.

Overrides:

addLegacyDependencyRequest in class JavaScriptDependencyDirective

Parameters:

params - Map

Throws:

freemarker.template.TemplateModelException

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:

createExtensibilityDirectiveData in class JavaScriptDependencyDirective

Throws:

freemarker.template.TemplateException