org.springframework.extensions.directives

Class DependencyDirectiveData

java.lang.Object

org.springframework.extensions.surf.extensibility.impl.DefaultExtensibilityDirectiveData

org.springframework.extensions.directives.DependencyDirectiveData

All Implemented Interfaces:

org.springframework.extensions.surf.extensibility.ExtensibilityDirectiveData

Direct Known Subclasses:

CssDependencyDirectiveData

public class DependencyDirectiveData
extends org.springframework.extensions.surf.extensibility.impl.DefaultExtensibilityDirectiveData

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	aggregate Indicates whether or not to aggregate the dependency.
protected RequestContext	context This is required for backwards compatibility to support WebScripts that are still using *.head.ftl files to add dependencies.
protected String	dependency The dependency requested by the directive.
protected String	group The group that the dependency should be added to (as requested by the directive)
protected org.springframework.extensions.surf.extensibility.DeferredContentSourceModelElement	modelElement This is the DeferredContentSourceModelElement that will get created when the createContentModelElement method is called.
protected org.springframework.extensions.surf.extensibility.DeferredContentTargetModelElement	targetElement The DeferredContentTargetModelElement to associate any created DeferredContentSourceModelElement with.

Constructor Summary

Constructors

Constructor and Description
DependencyDirectiveData(String id, String action, String target, String directiveName, freemarker.template.TemplateDirectiveBody body, freemarker.core.Environment env, String dependency, String group, boolean aggregate, org.springframework.extensions.surf.extensibility.DeferredContentTargetModelElement targetElement)

Method Summary

Methods

Modifier and Type	Method and Description
org.springframework.extensions.surf.extensibility.ContentModelElement	createContentModelElement()
void	render(org.springframework.extensions.surf.extensibility.impl.ModelWriter writer)

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

createClose, createOpen, getAction, getBody, getDirectiveName, getEnv, getId, getTarget, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

dependency

protected String dependency

The dependency requested by the directive.

group

protected String group

The group that the dependency should be added to (as requested by the directive)

modelElement

protected org.springframework.extensions.surf.extensibility.DeferredContentSourceModelElement modelElement

This is the DeferredContentSourceModelElement that will get created when the createContentModelElement method is called. A reference to it is required so that when the render method is called it can be passed to its associated DeferredContentTargetModelElement instance.

context

protected RequestContext context

This is required for backwards compatibility to support WebScripts that are still using *.head.ftl files to add dependencies. When a "head" file is processed the main model (and therefore any target DeferredContentTargetModelElement) will not yet exist. In order to ensure that the dependency is not lost we need to add the dependency via this RequestContext.

aggregate

protected boolean aggregate

Indicates whether or not to aggregate the dependency.

targetElement

protected org.springframework.extensions.surf.extensibility.DeferredContentTargetModelElement targetElement

The DeferredContentTargetModelElement to associate any created DeferredContentSourceModelElement with.

Constructor Detail

DependencyDirectiveData

public DependencyDirectiveData(String id,
                       String action,
                       String target,
                       String directiveName,
                       freemarker.template.TemplateDirectiveBody body,
                       freemarker.core.Environment env,
                       String dependency,
                       String group,
                       boolean aggregate,
                       org.springframework.extensions.surf.extensibility.DeferredContentTargetModelElement targetElement)

Method Detail

createContentModelElement

public org.springframework.extensions.surf.extensibility.ContentModelElement createContentModelElement()

Specified by:

createContentModelElement in interface org.springframework.extensions.surf.extensibility.ExtensibilityDirectiveData

Overrides:

createContentModelElement in class org.springframework.extensions.surf.extensibility.impl.DefaultExtensibilityDirectiveData

render

public void render(org.springframework.extensions.surf.extensibility.impl.ModelWriter writer)
            throws freemarker.template.TemplateException,
                   IOException

Specified by:

render in interface org.springframework.extensions.surf.extensibility.ExtensibilityDirectiveData

Overrides:

render in class org.springframework.extensions.surf.extensibility.impl.DefaultExtensibilityDirectiveData

Throws:

freemarker.template.TemplateException

IOException