FreeMarkerViewResolver

Class Overview

Convenience subclass of UrlBasedViewResolver that supports FreeMarkerView (i.e. FreeMarker templates) and custom subclasses of it.

The view class for all views generated by this resolver can be specified via the "viewClass" property. See UrlBasedViewResolver's javadoc for details.

Note: When chaining ViewResolvers, a FreeMarkerViewResolver will check for the existence of the specified template resources and only return a non-null View object if the template was actually found.

Summary

[Expand] Inherited Constants
From class org.springframework.web.servlet.view.UrlBasedViewResolver String FORWARD_URL_PREFIX Prefix for special view names that specify a forward URL (usually to a controller after a form has been submitted and processed). String REDIRECT_URL_PREFIX Prefix for special view names that specify a redirect URL (usually to a controller after a form has been submitted and processed).
From interface org.springframework.core.Ordered int HIGHEST_PRECEDENCE Useful constant for the highest precedence value. int LOWEST_PRECEDENCE Useful constant for the lowest precedence value.

[Expand] Inherited Fields
From class org.springframework.context.support.ApplicationObjectSupport protected final Log logger Logger that is available to subclasses

[Expand] Inherited Methods
From class org.springframework.web.servlet.view.AbstractTemplateViewResolver AbstractUrlBasedView buildView(String viewName) Creates a new View instance of the specified view class and configures it. Class requiredViewClass() Return the required type of view for this resolver. void setAllowRequestOverride(boolean allowRequestOverride) Set whether HttpServletRequest attributes are allowed to override (hide) controller generated model attributes of the same name. void setAllowSessionOverride(boolean allowSessionOverride) Set whether HttpSession attributes are allowed to override (hide) controller generated model attributes of the same name. void setExposeRequestAttributes(boolean exposeRequestAttributes) Set whether all request attributes should be added to the model prior to merging with the template. void setExposeSessionAttributes(boolean exposeSessionAttributes) Set whether all HttpSession attributes should be added to the model prior to merging with the template. void setExposeSpringMacroHelpers(boolean exposeSpringMacroHelpers) Set whether to expose a RequestContext for use by Spring's macro library, under the name "springMacroRequestContext".
From class org.springframework.web.servlet.view.UrlBasedViewResolver AbstractUrlBasedView buildView(String viewName) Creates a new View instance of the specified view class and configures it. boolean canHandle(String viewName, Locale locale) Indicates whether or not this ViewResolver can handle the supplied view name. View createView(String viewName, Locale locale) Overridden to implement check for "redirect:" prefix. Map<String, Object> getAttributesMap() Allow Map access to the static attributes for views returned by this resolver, with the option to add or override specific entries. Object getCacheKey(String viewName, Locale locale) This implementation returns just the view name, as this ViewResolver doesn't support localized resolution. String getContentType() Return the content type for all views, if any. int getOrder() Return the order in which this ViewResolver is evaluated. String getPrefix() Return the prefix that gets prepended to view names when building a URL. String getRequestContextAttribute() Return the name of the RequestContext attribute for all views, if any. String getSuffix() Return the suffix that gets appended to view names when building a URL. Class getViewClass() Return the view class to be used to create views. String[] getViewNames() Return the view names (or name patterns) that can be handled by this ViewResolver. void initApplicationContext() Subclasses can override this for custom initialization behavior. boolean isRedirectContextRelative() Return whether to interpret a given redirect URL that starts with a slash ("/") as relative to the current ServletContext, i.e. boolean isRedirectHttp10Compatible() Return whether redirects should stay compatible with HTTP 1.0 clients. View loadView(String viewName, Locale locale) Delegates to buildView for creating a new instance of the specified view class, and applies the following Spring lifecycle methods (as supported by the generic Spring bean factory): ApplicationContextAware's setApplicationContext InitializingBean's afterPropertiesSet Class requiredViewClass() Return the required type of view for this resolver. void setAttributes(Properties props) Set static attributes from a java.util.Properties object, for all views returned by this resolver. void setAttributesMap(Map<String, ?> attributes) Set static attributes from a Map, for all views returned by this resolver. void setContentType(String contentType) Set the content type for all views. void setOrder(int order) Set the order in which this ViewResolver is evaluated. void setPrefix(String prefix) Set the prefix that gets prepended to view names when building a URL. void setRedirectContextRelative(boolean redirectContextRelative) Set whether to interpret a given redirect URL that starts with a slash ("/") as relative to the current ServletContext, i.e. void setRedirectHttp10Compatible(boolean redirectHttp10Compatible) Set whether redirects should stay compatible with HTTP 1.0 clients. void setRequestContextAttribute(String requestContextAttribute) Set the name of the RequestContext attribute for all views. void setSuffix(String suffix) Set the suffix that gets appended to view names when building a URL. void setViewClass(Class viewClass) Set the view class that should be used to create views. void setViewNames(String[] viewNames) Set the view names (or name patterns) that can be handled by this ViewResolver.
From class org.springframework.web.servlet.view.AbstractCachingViewResolver void clearCache() Clear the entire view cache, removing all cached view objects. View createView(String viewName, Locale locale) Create the actual View object. Object getCacheKey(String viewName, Locale locale) Return the cache key for the given view name and the given locale. boolean isCache() Return if caching is enabled. abstract View loadView(String viewName, Locale locale) Subclasses must implement this method, building a View object for the specified view. void removeFromCache(String viewName, Locale locale) Provides functionality to clear the cache for a certain view. View resolveViewName(String viewName, Locale locale) Resolve the given view by name. void setCache(boolean cache) Enable or disable caching.
From class org.springframework.web.context.support.WebApplicationObjectSupport final ServletContext getServletContext() Return the current ServletContext. final File getTempDir() Return the temporary directory for the current web application, as provided by the servlet container. final WebApplicationContext getWebApplicationContext() Return the current application context as WebApplicationContext. void initApplicationContext(ApplicationContext context) Calls initServletContext(javax.servlet.ServletContext) if the given ApplicationContext is a WebApplicationContext. void initServletContext(ServletContext servletContext) Subclasses may override this for custom initialization based on the ServletContext that this application object runs in. boolean isContextRequired() Overrides the base class behavior to enforce running in an ApplicationContext. final void setServletContext(ServletContext servletContext) Set the ServletContext that this object runs in.
From class org.springframework.context.support.ApplicationObjectSupport final ApplicationContext getApplicationContext() Return the ApplicationContext that this object is associated with. final MessageSourceAccessor getMessageSourceAccessor() Return a MessageSourceAccessor for the application context used by this object, for easy message access. void initApplicationContext() Subclasses can override this for custom initialization behavior. void initApplicationContext(ApplicationContext context) Subclasses can override this for custom initialization behavior. boolean isContextRequired() Determine whether this application object needs to run in an ApplicationContext. Class requiredContextClass() Determine the context class that any context passed to setApplicationContext must be an instance of. final void setApplicationContext(ApplicationContext context) Set the ApplicationContext that this object runs in.
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait() final void wait(long arg0, int arg1) final void wait(long arg0)
From interface org.springframework.context.ApplicationContextAware abstract void setApplicationContext(ApplicationContext applicationContext) Set the ApplicationContext that this object runs in.
From interface org.springframework.core.Ordered abstract int getOrder() Return the order value of this object, with a higher value meaning greater in terms of sorting.
From interface org.springframework.web.context.ServletContextAware abstract void setServletContext(ServletContext servletContext) Set the ServletContext that this object runs in.
From interface org.springframework.web.servlet.ViewResolver abstract View resolveViewName(String viewName, Locale locale) Resolve the given view by name.