org.springframework.extensions.directives

Class DependencyDeferredContentTargetModelElement

java.lang.Object

org.springframework.extensions.surf.extensibility.impl.ModelElementImpl

org.springframework.extensions.surf.extensibility.impl.DefaultContentModelElement

org.springframework.extensions.directives.DependencyDeferredContentTargetModelElement

All Implemented Interfaces:

org.springframework.extensions.surf.extensibility.ContentModelElement, org.springframework.extensions.surf.extensibility.DeferredContentTargetModelElement, org.springframework.extensions.surf.extensibility.ExtensibilityModelElement, org.springframework.extensions.surf.extensibility.ValidatedContentModelElement

Direct Known Subclasses:

OutputCSSContentModelElement, OutputJavaScriptContentModelElement

public abstract class DependencyDeferredContentTargetModelElement
extends org.springframework.extensions.surf.extensibility.impl.DefaultContentModelElement
implements org.springframework.extensions.surf.extensibility.DeferredContentTargetModelElement

Field Summary

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

TYPE

Constructor Summary

Constructors

Constructor and Description
DependencyDeferredContentTargetModelElement(String id, String directiveName)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	dependencyAlreadyRequested(String dep) Checks whether or not the supplied dependency has already been requested.
void	enterEditMode(String mode, org.springframework.extensions.surf.extensibility.DeferredContentSourceModelElement sourceElement) Moves the DeferredContentTargetModelElement instance into "editMode".
void	exitEditMode() Resets the editMode index to -1 (to indicate that we're out of "edit" mode) and clears the previously populated List of DeferredContentSourceModelElement instances.
protected abstract String	getResourceControllerMapping() This method must be implemented to return the mapping to the resource controller, e.g.
List<org.springframework.extensions.surf.extensibility.DeferredContentSourceModelElement>	getSourceElements()
void	markDependencyAsRequested(String dep) This method can be used to indicate that the supplied dependency has been requested by other means.
protected String	normaliseDependency(String dependency) This method can be used to normalise supplied dependencies such that they are all referenced from the same location and that there are no duplicate forward slashes.
void	registerDeferredSourceElement(org.springframework.extensions.surf.extensibility.DeferredContentSourceModelElement sourceElement)

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

equals, flushContent, getNextContentBufferElement, getType, hashCode, parseContent, validateContent

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

getDirectiveName, getId, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.springframework.extensions.surf.extensibility.ContentModelElement

flushContent, getNextContentBufferElement

Methods inherited from interface org.springframework.extensions.surf.extensibility.ExtensibilityModelElement

getDirectiveName, getId, getType

Constructor Detail

DependencyDeferredContentTargetModelElement

public DependencyDeferredContentTargetModelElement(String id,
                                           String directiveName)

Method Detail

getSourceElements

public List<org.springframework.extensions.surf.extensibility.DeferredContentSourceModelElement> getSourceElements()

Returns:

The List of DeferredContentSourceModelElement instances registered with this DeferredContentTargetModelElement instance.

registerDeferredSourceElement

public void registerDeferredSourceElement(org.springframework.extensions.surf.extensibility.DeferredContentSourceModelElement sourceElement)

Specified by:

registerDeferredSourceElement in interface org.springframework.extensions.surf.extensibility.DeferredContentTargetModelElement

enterEditMode

public void enterEditMode(String mode,
                 org.springframework.extensions.surf.extensibility.DeferredContentSourceModelElement sourceElement)

Moves the DeferredContentTargetModelElement instance into "editMode". It checks that that the DeferredContentSourceModelElement argument has previously registered for inclusion in the output and then sets the editMode variable to be the correct index for inserting subsequent requests.

Specified by:

enterEditMode in interface org.springframework.extensions.surf.extensibility.DeferredContentTargetModelElement

exitEditMode

public void exitEditMode()

Resets the editMode index to -1 (to indicate that we're out of "edit" mode) and clears the previously populated List of DeferredContentSourceModelElement instances.

Specified by:

exitEditMode in interface org.springframework.extensions.surf.extensibility.DeferredContentTargetModelElement

dependencyAlreadyRequested

public boolean dependencyAlreadyRequested(String dep)

Checks whether or not the supplied dependency has already been requested.

Parameters:

dep - The path to the dependency to check.

Returns:

true if the dependency has already been requested and false otherwise.

markDependencyAsRequested

public void markDependencyAsRequested(String dep)

This method can be used to indicate that the supplied dependency has been requested by other means. This is provided to ensure that dependencies requested directly on the output stream (e.g. via the JavaScriptDependencyDirective, CssDependencyDirective, etc.)

Parameters:

dep - The path to the dependency to mark as requested.

getResourceControllerMapping

protected abstract String getResourceControllerMapping()

This method must be implemented to return the mapping to the resource controller, e.g. "/share/res/"

Returns:

String

normaliseDependency

protected String normaliseDependency(String dependency)

This method can be used to normalise supplied dependencies such that they are all referenced from the same location and that there are no duplicate forward slashes.

Parameters:

dependency - String

Returns:

String