org.springframework.extensions.directives

Interface DirectiveFactory

All Known Implementing Classes:

DefaultDirectiveFactory

public interface DirectiveFactory

Method Summary

Methods

Modifier and Type	Method and Description
AddInlineJavaScriptDirective	createAddInlineJavaScriptDirective(String directiveName, ModelObject object, org.springframework.extensions.surf.extensibility.ExtensibilityModel extensibilityModel, RequestContext context) Creates a new AddInlineJavaScriptDirective directive.
AutoComponentRegionDirective	createAutoComponentRegionDirective(String directiveName, RequestContext context, RenderService renderService) Creates a new AutoComponentRegionDirective.
ChecksumResourceDirective	createChecksumResourceDirective(String directiveName, ModelObject object, org.springframework.extensions.surf.extensibility.ExtensibilityModel extensibilityModel, RequestContext context) Creates a new ChecksumResourceDirective directive.
ChromeDetectionDirective	createChromeDetectionDirective(String directiveName, org.springframework.extensions.surf.extensibility.ExtensibilityModel extensibilityModel, WebFrameworkConfigElement webFrameworkConfigElement, RequestContext context) Creates a new ChromeDetectionDirective.
CreateComponentDirective	createCreateComponentDirective(String directiveName) Creates a new CreateComponentDirective.
CreateWebScriptWidgetsDirective	createCreateWebScriptsDirective(String directiveName, ModelObject object, org.springframework.extensions.surf.extensibility.ExtensibilityModel extensibilityModel, RequestContext context) Creates a new CreateWebScriptWidgetsDirective directive.
CssDependencyDirective	createCssDependencyDirective(String directiveName, ModelObject object, org.springframework.extensions.surf.extensibility.ExtensibilityModel extensibilityModel, RequestContext context) Creates a new CssDependencyDirective directive.
JavaScriptDependencyDirective	createJavaScriptDependencyDirective(String directiveName, ModelObject object, org.springframework.extensions.surf.extensibility.ExtensibilityModel extensibilityModel, RequestContext context) Creates a new JavaScriptDependencyDirective directive.
MessagesDependencyDirective	createMessagesDependencyDirective(String directiveName, ModelObject object, org.springframework.extensions.surf.extensibility.ExtensibilityModel extensibilityModel, RequestContext context)
OutputCSSDirective	createOutputCssDirective(String directiveName, ModelObject object, org.springframework.extensions.surf.extensibility.ExtensibilityModel extensibilityModel, RequestContext context) Creates a new OutputCSSDirective directive.
OutputJavaScriptDirective	createOutputJavaScriptDirective(String directiveName, ModelObject object, org.springframework.extensions.surf.extensibility.ExtensibilityModel extensibilityModel, RequestContext context) Creates a new OutputJavaScriptDirective directive.
ProcessJsonModelDirective	createProcessJsonModelDirective(String directiveName, ModelObject object, org.springframework.extensions.surf.extensibility.ExtensibilityModel extensibilityModel, RequestContext context, WebFrameworkConfigElement webFrameworkConfig) Creates a new ProcessJsonModelDirective.
RelocateJavaScriptOutputDirective	createRelocateJavaScriptDirective(String directiveName, ModelObject object, org.springframework.extensions.surf.extensibility.ExtensibilityModel extensibilityModel, RequestContext context) Creates a new RelocateJavaScriptOutputDirective directive.
StandaloneWebScriptWrapper	createStandaloneWebScriptWrapperDirective(String directiveName, ModelObject object, org.springframework.extensions.surf.extensibility.ExtensibilityModel extensibilityModel, RequestContext context)
MessagesWebScript	getMessagesWebScript() The MessagesWebScript is required for setting up i18n messages so will be needed by the createMessagesDependencyDirective method.

Method Detail

getMessagesWebScript

MessagesWebScript getMessagesWebScript()

The MessagesWebScript is required for setting up i18n messages so will be needed by the createMessagesDependencyDirective method. It should be set through Spring bean configuration so that it can easily be reconfigured without changing the Surf source code.

Returns:

MessagesWebScript

createMessagesDependencyDirective

MessagesDependencyDirective createMessagesDependencyDirective(String directiveName,
                                                            ModelObject object,
                                                            org.springframework.extensions.surf.extensibility.ExtensibilityModel extensibilityModel,
                                                            RequestContext context)

createJavaScriptDependencyDirective

JavaScriptDependencyDirective createJavaScriptDependencyDirective(String directiveName,
                                                                ModelObject object,
                                                                org.springframework.extensions.surf.extensibility.ExtensibilityModel extensibilityModel,
                                                                RequestContext context)

Creates a new JavaScriptDependencyDirective directive.

Parameters:

directiveName - The name of the directive

object - The current ModelObject being processed.

extensibilityModel - The current ExtensibilityModel being worked on.

context - The current RequestContext

Returns:

JavaScriptDependencyDirective

createCssDependencyDirective

CssDependencyDirective createCssDependencyDirective(String directiveName,
                                                  ModelObject object,
                                                  org.springframework.extensions.surf.extensibility.ExtensibilityModel extensibilityModel,
                                                  RequestContext context)

Creates a new CssDependencyDirective directive.

Parameters:

directiveName - The name of the directive

object - The current ModelObject being processed.

extensibilityModel - The current ExtensibilityModel being worked on.

context - The current RequestContext

Returns:

CssDependencyDirective

createChecksumResourceDirective

ChecksumResourceDirective createChecksumResourceDirective(String directiveName,
                                                        ModelObject object,
                                                        org.springframework.extensions.surf.extensibility.ExtensibilityModel extensibilityModel,
                                                        RequestContext context)

Creates a new ChecksumResourceDirective directive.

Parameters:

directiveName - The name of the directive

object - The current ModelObject being processed.

extensibilityModel - The current ExtensibilityModel being worked on.

context - The current RequestContext

Returns:

ChecksumResourceDirective

createAddInlineJavaScriptDirective

AddInlineJavaScriptDirective createAddInlineJavaScriptDirective(String directiveName,
                                                              ModelObject object,
                                                              org.springframework.extensions.surf.extensibility.ExtensibilityModel extensibilityModel,
                                                              RequestContext context)

Creates a new AddInlineJavaScriptDirective directive.

Parameters:

directiveName - The name of the directive

object - The current ModelObject being processed.

extensibilityModel - The current ExtensibilityModel being worked on.

context - The current RequestContext

Returns:

AddInlineJavaScriptDirective

createCreateWebScriptsDirective

CreateWebScriptWidgetsDirective createCreateWebScriptsDirective(String directiveName,
                                                              ModelObject object,
                                                              org.springframework.extensions.surf.extensibility.ExtensibilityModel extensibilityModel,
                                                              RequestContext context)

Creates a new CreateWebScriptWidgetsDirective directive.

Parameters:

directiveName - The name of the directive

object - The current ModelObject being processed.

extensibilityModel - The current ExtensibilityModel being worked on.

context - The current RequestContext

Returns:

CreateWebScriptWidgetsDirective

createOutputCssDirective

OutputCSSDirective createOutputCssDirective(String directiveName,
                                          ModelObject object,
                                          org.springframework.extensions.surf.extensibility.ExtensibilityModel extensibilityModel,
                                          RequestContext context)

Creates a new OutputCSSDirective directive.

Parameters:

directiveName - The name of the directive

object - The current ModelObject being processed.

extensibilityModel - The current ExtensibilityModel being worked on.

context - The current RequestContext

Returns:

OutputCSSDirective

createOutputJavaScriptDirective

OutputJavaScriptDirective createOutputJavaScriptDirective(String directiveName,
                                                        ModelObject object,
                                                        org.springframework.extensions.surf.extensibility.ExtensibilityModel extensibilityModel,
                                                        RequestContext context)

Creates a new OutputJavaScriptDirective directive.

Parameters:

directiveName - The name of the directive

object - The current ModelObject being processed.

extensibilityModel - The current ExtensibilityModel being worked on.

context - The current RequestContext

Returns:

OutputJavaScriptDirective

createRelocateJavaScriptDirective

RelocateJavaScriptOutputDirective createRelocateJavaScriptDirective(String directiveName,
                                                                  ModelObject object,
                                                                  org.springframework.extensions.surf.extensibility.ExtensibilityModel extensibilityModel,
                                                                  RequestContext context)

Creates a new RelocateJavaScriptOutputDirective directive.

Parameters:

directiveName - The name of the directive

object - The current ModelObject being processed.

extensibilityModel - The current ExtensibilityModel being worked on.

context - The current RequestContext

Returns:

RelocateJavaScriptOutputDirective

createChromeDetectionDirective

ChromeDetectionDirective createChromeDetectionDirective(String directiveName,
                                                      org.springframework.extensions.surf.extensibility.ExtensibilityModel extensibilityModel,
                                                      WebFrameworkConfigElement webFrameworkConfigElement,
                                                      RequestContext context)

Creates a new ChromeDetectionDirective.

Parameters:

directiveName - The name of the directive

extensibilityModel - The current ExtensibilityModel being worked on.

webFrameworkConfigElement - The WebFrameworkConfigElement for the application.

context - The current RequestContext

Returns:

ChromeDetectionDirective

createStandaloneWebScriptWrapperDirective

StandaloneWebScriptWrapper createStandaloneWebScriptWrapperDirective(String directiveName,
                                                                   ModelObject object,
                                                                   org.springframework.extensions.surf.extensibility.ExtensibilityModel extensibilityModel,
                                                                   RequestContext context)

createCreateComponentDirective

CreateComponentDirective createCreateComponentDirective(String directiveName)

Creates a new CreateComponentDirective.

Parameters:

directiveName - The name of the directive

Returns:

CreateComponentDirective

createProcessJsonModelDirective

ProcessJsonModelDirective createProcessJsonModelDirective(String directiveName,
                                                        ModelObject object,
                                                        org.springframework.extensions.surf.extensibility.ExtensibilityModel extensibilityModel,
                                                        RequestContext context,
                                                        WebFrameworkConfigElement webFrameworkConfig)

Creates a new ProcessJsonModelDirective.

Parameters:

directiveName - The name of the directive

object - ModelObject

extensibilityModel - The current ExtensibilityModel being worked on.

context - The current RequestContext

webFrameworkConfig - TODO

Returns:

ProcessJsonModelDirective

createAutoComponentRegionDirective

AutoComponentRegionDirective createAutoComponentRegionDirective(String directiveName,
                                                              RequestContext context,
                                                              RenderService renderService)

Creates a new AutoComponentRegionDirective.

Parameters:

directiveName - The name of the directive

context - The current RequestContext

renderService - RenderService

Returns:

AutoComponentRegionDirective