org.springframework.extensions.surf

Class DojoI18nDependencyRule

java.lang.Object

org.springframework.extensions.surf.DojoDependencyRule

org.springframework.extensions.surf.DojoI18nDependencyRule

public class DojoI18nDependencyRule
extends DojoDependencyRule

In order to prevent CSS resources being unnecessarily imported we can specify CSS files relevant to a widget in its JavaScript file. This DojoDependencyRule allows us to check for requested CSS dependencies so that we can dynamically include them when we build the page. The definition should be written as follows:

cssRequirements: [{cssFile:"./css/LeftAndRight.css",mediaType:"screen"}],

TODO: We could aim to support different aggregation groups as well.

Author:

David Draper

Constructor Summary

Constructors

Constructor and Description
DojoI18nDependencyRule()

Method Summary

Methods

Modifier and Type	Method and Description
WebFrameworkConfigElement	getWebFrameworkConfigElement()
String	getWidgetNamePatternString()
int	getWidgetNameTargetGroup()
protected void	processDependency(String dependency, String sourcePath, String sourceContents, Matcher matcher, DojoDependencies dependencies) Overrides the default implementation to retrieve both the CSS dependency path and the media type that the CSS path should be used against.
void	setWebFrameworkConfigElement(WebFrameworkConfigElement webFrameworkConfigElement)
void	setWidgetNamePatternString(String widgetNamePatternString)
void	setWidgetNameTargetGroup(int widgetNameTargetGroup)

Methods inherited from class org.springframework.extensions.surf.DojoDependencyRule

addJavaScriptDependency, addNonAmdJavaScriptDependency, getDeclarationRegex, getDeclarationRegexPattern, getDependencyHandler, getDependencyRegex, getDependencyRegexPattern, getDojoDependencyHandler, getTargetGroup, getTokens, processRegexRules, replaceTokens, setDeclarationRegex, setDependencyHandler, setDependencyRegex, setDojoDependencyHandler, setTargetGroup

Methods inherited from class java.lang.Object

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

Constructor Detail

DojoI18nDependencyRule

public DojoI18nDependencyRule()

Method Detail

processDependency

protected void processDependency(String dependency,
                     String sourcePath,
                     String sourceContents,
                     Matcher matcher,
                     DojoDependencies dependencies)

Overrides the default implementation to retrieve both the CSS dependency path and the media type that the CSS path should be used against.

Overrides:

processDependency in class DojoDependencyRule

Parameters:

dependency - The dependency as specified in the file being processed

sourcePath - The source where the file was being processed

sourceContents - TODO

dependencies - The current DojoDependencies object for source file being processed

getWidgetNamePatternString

public String getWidgetNamePatternString()

setWidgetNamePatternString

public void setWidgetNamePatternString(String widgetNamePatternString)

getWidgetNameTargetGroup

public int getWidgetNameTargetGroup()

setWidgetNameTargetGroup

public void setWidgetNameTargetGroup(int widgetNameTargetGroup)

getWebFrameworkConfigElement

public WebFrameworkConfigElement getWebFrameworkConfigElement()

setWebFrameworkConfigElement

public void setWebFrameworkConfigElement(WebFrameworkConfigElement webFrameworkConfigElement)