org.springframework.extensions.directives

Class CssDependencyDirective

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

All Implemented Interfaces:

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

public class CssDependencyDirective
extends JavaScriptDependencyDirective

This directive is used to address the problem of browsers caching stale CSS resources. It modifies the source file requested to include a checksum generated from the file contents to ensure that when a file is updated the browser will be forced to request the updated version (because the browser cached version will be stored against a different URL).

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

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addLegacyDependencyRequest(Map params) Overrides the default implementation to add a CSS dependency to the RequestContext.
protected DependencyDirectiveData	createDependencyDirectiveData(String id, String action, String target, Map params, freemarker.template.TemplateDirectiveBody body, freemarker.core.Environment env, String dependencyToAdd, String group) Overrides the default implementation to instantiate and returns a CssDependencyDirectiveData instance.
protected String	getDependencySource(Map params) Overrides the default to return the "href" parameter.
protected org.springframework.extensions.surf.extensibility.DeferredContentTargetModelElement	getTargetElement() Overrides the default to return the OutputCSSContentModelElement.

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

createExtensibilityDirectiveData, execute

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

CssDependencyDirective

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

Method Detail

addLegacyDependencyRequest

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

Overrides the default implementation to add a CSS dependency to the RequestContext.

Overrides:

addLegacyDependencyRequest in class JavaScriptDependencyDirective

Parameters:

params - Map

Throws:

freemarker.template.TemplateModelException

getDependencySource

protected String getDependencySource(Map params)
                              throws freemarker.template.TemplateModelException

Overrides the default to return the "href" parameter.

Overrides:

getDependencySource in class JavaScriptDependencyDirective

Parameters:

params - The map of parameters to search through.

Returns:

The parameter defining the dependency source file.

Throws:

freemarker.template.TemplateModelException - When the target parameter cannot be found.

getTargetElement

protected org.springframework.extensions.surf.extensibility.DeferredContentTargetModelElement getTargetElement()

Overrides the default to return the OutputCSSContentModelElement.

Overrides:

getTargetElement in class JavaScriptDependencyDirective

Returns:

DeferredContentTargetModelElement

createDependencyDirectiveData

protected DependencyDirectiveData createDependencyDirectiveData(String id,
                                                    String action,
                                                    String target,
                                                    Map params,
                                                    freemarker.template.TemplateDirectiveBody body,
                                                    freemarker.core.Environment env,
                                                    String dependencyToAdd,
                                                    String group)
                                                         throws freemarker.template.TemplateModelException

Overrides the default implementation to instantiate and returns a CssDependencyDirectiveData instance.

Overrides:

createDependencyDirectiveData in class JavaScriptDependencyDirective

Parameters:

id - String

action - String

target - String

params - Map

body - TemplateDirectiveBody

env - Environment

dependencyToAdd - String

group - String

Returns:

DependencyDirectiveData

Throws:

freemarker.template.TemplateModelException