org.springframework.extensions.directives

Class ChromeDetectionDirective

java.lang.Object

org.springframework.extensions.surf.extensibility.impl.AbstractFreeMarkerDirective

org.springframework.extensions.surf.extensibility.impl.AbstractExtensibilityDirective

org.springframework.extensions.directives.ChromeDetectionDirective

All Implemented Interfaces:

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

public class ChromeDetectionDirective
extends org.springframework.extensions.surf.extensibility.impl.AbstractExtensibilityDirective

This directive is used to determine whether or not Surf Region Chrome is enabled and if not will output the <div> element containing the unique HTML ID generated for the Component. This has been created to allow the deprecation of Surf Region Chrome which can be disabled by setting the <region-chrome> configuration to have no value which will eventually become the default Surf setting.

Author:

David Draper

Field Summary

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
ChromeDetectionDirective(String directiveName, org.springframework.extensions.surf.extensibility.ExtensibilityModel model, WebFrameworkConfigElement webFrameworkConfig, RequestContext context)

Method Summary

Methods

Modifier and Type	Method and Description
org.springframework.extensions.surf.extensibility.ExtensibilityDirectiveData	createExtensibilityDirectiveData(String id, String action, String target, Map params, freemarker.template.TemplateDirectiveBody body, freemarker.core.Environment env) Creates a new ChromeDetectionDirectiveData instance which will in turn be used to create the ChromeDetectionContentModelElement that will output the <div> element containing the unique HTML ID if required.
WebFrameworkConfigElement	getConfig()
RequestContext	getContext()

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

after, before, execute, 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

ChromeDetectionDirective

public ChromeDetectionDirective(String directiveName,
                        org.springframework.extensions.surf.extensibility.ExtensibilityModel model,
                        WebFrameworkConfigElement webFrameworkConfig,
                        RequestContext context)

Method Detail

getConfig

public WebFrameworkConfigElement getConfig()

Returns:

The WebFrameworkConfigElement that this ChromeDetectionDirective was instantiated with.

getContext

public RequestContext getContext()

Returns:

The RequestContext that this ChromeDetectionDirective was instantiated with.

createExtensibilityDirectiveData

public org.springframework.extensions.surf.extensibility.ExtensibilityDirectiveData createExtensibilityDirectiveData(String id,
                                                                                                            String action,
                                                                                                            String target,
                                                                                                            Map params,
                                                                                                            freemarker.template.TemplateDirectiveBody body,
                                                                                                            freemarker.core.Environment env)
                                                                                                              throws freemarker.template.TemplateException

Creates a new ChromeDetectionDirectiveData instance which will in turn be used to create the ChromeDetectionContentModelElement that will output the <div> element containing the unique HTML ID if required.

Overrides:

createExtensibilityDirectiveData in class org.springframework.extensions.surf.extensibility.impl.AbstractExtensibilityDirective

Throws:

freemarker.template.TemplateException