OutputJavaScriptDirective (Surf 6.2 API)

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

All Implemented Interfaces:

freemarker.template.TemplateDirectiveModel, freemarker.template.TemplateModel, org.springframework.extensions.surf.extensibility.ExtensibilityDirective
```
public class OutputJavaScriptDirective
extends AbstractDependencyExtensibilityDirective
```
Directive for outputting JavaScript into the FreeMarker template. This directive acts as a placeholder in the extensibility model for other directives (such as JavaScriptDependencyDirective to use to request resources to be included earlier in the template. This directive should typically be placed in the <head> element of the page and the RelocateJavaScriptOutputDirective can then be used to move all JavaScript to the end of the HTML page if required.

Author:

David Draper

Nested Class Summary
- Nested classes/interfaces inherited from class org.springframework.extensions.directives.AbstractDependencyExtensibilityDirective
  AbstractDependencyExtensibilityDirective.ProcessedDependency

Field Summary

Fields
Modifier and Type Field and Description

static String OUTPUT_DEPENDENCY_DIRECTIVE_ID

static String OUTPUT_JS_DEPENDENCIES_DIRECTIVE_NAME
- 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

Fields
Modifier and Type	Field and Description
`static String`	`OUTPUT_DEPENDENCY_DIRECTIVE_ID`
`static String`	`OUTPUT_JS_DEPENDENCIES_DIRECTIVE_NAME`

Constructor Summary

Constructors
Constructor and Description
`OutputJavaScriptDirective(String directiveName, org.springframework.extensions.surf.extensibility.ExtensibilityModel model)`

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)`

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, createExtensibilityDirectiveData, 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

Field Detail
- OUTPUT_DEPENDENCY_DIRECTIVE_ID
```
public static final String OUTPUT_DEPENDENCY_DIRECTIVE_ID
```
  See Also:
  Constant Field Values
- OUTPUT_JS_DEPENDENCIES_DIRECTIVE_NAME
```
public static final String OUTPUT_JS_DEPENDENCIES_DIRECTIVE_NAME
```
  See Also:
  Constant Field Values

Constructor Detail

OutputJavaScriptDirective

public OutputJavaScriptDirective(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

Class OutputJavaScriptDirective

Nested Class Summary

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

Field Summary

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

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

Fields inherited from interface freemarker.template.TemplateModel

Constructor Summary

Method Summary

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

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

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

Methods inherited from class java.lang.Object

Field Detail

OUTPUT_DEPENDENCY_DIRECTIVE_ID

OUTPUT_JS_DEPENDENCIES_DIRECTIVE_NAME

Constructor Detail

OutputJavaScriptDirective

Method Detail

execute