Package org.craftercms.engine.view.freemarker

Class CrafterFreeMarkerViewResolver

java.lang.Object
org.springframework.context.support.ApplicationObjectSupport
org.springframework.web.context.support.WebApplicationObjectSupport
org.springframework.web.servlet.view.AbstractCachingViewResolver
org.springframework.web.servlet.view.UrlBasedViewResolver
org.springframework.web.servlet.view.AbstractTemplateViewResolver
org.springframework.web.servlet.view.freemarker.FreeMarkerViewResolver
org.craftercms.engine.view.freemarker.CrafterFreeMarkerViewResolver
All Implemented Interfaces:
org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.core.Ordered, org.springframework.web.context.ServletContextAware, org.springframework.web.servlet.ViewResolver
public class CrafterFreeMarkerViewResolver extends org.springframework.web.servlet.view.freemarker.FreeMarkerViewResolver
View resolver tha resolves to CrafterFreeMarkerViews.
Author:
Alfonso Vásquez

  • Nested Class Summary

    Nested classes/interfaces inherited from class org.springframework.web.servlet.view.AbstractCachingViewResolver

    org.springframework.web.servlet.view.AbstractCachingViewResolver.CacheFilter

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected String
    componentEmbeddedElementName
     
    protected String
    componentIncludeElementName
     
    protected SiteItemScriptResolver
    componentScriptResolver
     
    protected String
    componentTemplateXPathQuery
     
    protected boolean
    enableStatics
    Indicates if access for static methods should be allowed in Freemarker templates
    protected PluginService
    pluginService
     
    protected SiteItemService
    siteItemService
     

    Fields inherited from class org.springframework.web.servlet.view.UrlBasedViewResolver

    FORWARD_URL_PREFIX, REDIRECT_URL_PREFIX

    Fields inherited from class org.springframework.web.servlet.view.AbstractCachingViewResolver

    DEFAULT_CACHE_LIMIT

    Fields inherited from class org.springframework.context.support.ApplicationObjectSupport

    logger

    Fields inherited from interface org.springframework.core.Ordered

    HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

  • Constructor Summary

    Constructors
    Constructor
    Description
    CrafterFreeMarkerViewResolver()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected org.springframework.web.servlet.view.AbstractUrlBasedView
    buildView(String viewName)
     
    protected Class<?>
    requiredViewClass()
     
    void
    setComponentEmbeddedElementName(String componentEmbeddedElementName)
     
    void
    setComponentIncludeElementName(String componentIncludeElementName)
     
    void
    setComponentScriptResolver(SiteItemScriptResolver componentScriptResolver)
     
    void
    setComponentTemplateXPathQuery(String componentTemplateXPathQuery)
     
    void
    setEnableStatics(boolean enableStatics)
     
    void
    setPluginService(PluginService pluginService)
     
    void
    setSiteItemService(SiteItemService siteItemService)
     

    Methods inherited from class org.springframework.web.servlet.view.freemarker.FreeMarkerViewResolver

    instantiateView

    Methods inherited from class org.springframework.web.servlet.view.AbstractTemplateViewResolver

    setAllowRequestOverride, setAllowSessionOverride, setExposeRequestAttributes, setExposeSessionAttributes, setExposeSpringMacroHelpers

    Methods inherited from class org.springframework.web.servlet.view.UrlBasedViewResolver

    applyLifecycleMethods, canHandle, createView, getAttributesMap, getCacheKey, getContentType, getExposeContextBeansAsAttributes, getExposedContextBeanNames, getExposePathVariables, getOrder, getPrefix, getRedirectHosts, getRequestContextAttribute, getSuffix, getViewClass, getViewNames, initApplicationContext, isRedirectContextRelative, isRedirectHttp10Compatible, loadView, setAttributes, setAttributesMap, setContentType, setExposeContextBeansAsAttributes, setExposedContextBeanNames, setExposePathVariables, setOrder, setPrefix, setRedirectContextRelative, setRedirectHosts, setRedirectHttp10Compatible, setRequestContextAttribute, setSuffix, setViewClass, setViewNames

    Methods inherited from class org.springframework.web.servlet.view.AbstractCachingViewResolver

    clearCache, getCacheFilter, getCacheLimit, isCache, isCacheUnresolved, removeFromCache, resolveViewName, setCache, setCacheFilter, setCacheLimit, setCacheUnresolved

    Methods inherited from class org.springframework.web.context.support.WebApplicationObjectSupport

    getServletContext, getTempDir, getWebApplicationContext, initApplicationContext, initServletContext, isContextRequired, setServletContext

    Methods inherited from class org.springframework.context.support.ApplicationObjectSupport

    getApplicationContext, getMessageSourceAccessor, obtainApplicationContext, requiredContextClass, setApplicationContext

    Methods inherited from class java.lang.Object

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

  • Field Details

    • siteItemService

      protected SiteItemService siteItemService

    • componentTemplateXPathQuery

      protected String componentTemplateXPathQuery

    • componentIncludeElementName

      protected String componentIncludeElementName

    • componentEmbeddedElementName

      protected String componentEmbeddedElementName

    • componentScriptResolver

      protected SiteItemScriptResolver componentScriptResolver

    • pluginService

      protected PluginService pluginService

    • enableStatics

      protected boolean enableStatics
      Indicates if access for static methods should be allowed in Freemarker templates

  • Constructor Details

    • CrafterFreeMarkerViewResolver

      public CrafterFreeMarkerViewResolver()

  • Method Details

    • setSiteItemService

      public void setSiteItemService(SiteItemService siteItemService)

    • setComponentTemplateXPathQuery

      public void setComponentTemplateXPathQuery(String componentTemplateXPathQuery)

    • setComponentIncludeElementName

      public void setComponentIncludeElementName(String componentIncludeElementName)

    • setComponentEmbeddedElementName

      public void setComponentEmbeddedElementName(String componentEmbeddedElementName)

    • setComponentScriptResolver

      public void setComponentScriptResolver(SiteItemScriptResolver componentScriptResolver)

    • setEnableStatics

      public void setEnableStatics(boolean enableStatics)

    • setPluginService

      public void setPluginService(PluginService pluginService)

    • requiredViewClass

      @NonNull protected Class<?> requiredViewClass()
      Overrides:
      requiredViewClass in class org.springframework.web.servlet.view.freemarker.FreeMarkerViewResolver

    • buildView

      @NonNull protected org.springframework.web.servlet.view.AbstractUrlBasedView buildView(@NonNull String viewName) throws Exception
      Overrides:
      buildView in class org.springframework.web.servlet.view.AbstractTemplateViewResolver
      Throws:
      Exception