|
The Spring Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.springframework.ui.freemarker.FreeMarkerConfigurationFactory org.springframework.web.servlet.view.freemarker.FreeMarkerConfigurer
public class FreeMarkerConfigurer
JavaBean to configure FreeMarker for web usage, via the "configLocation" and/or "freemarkerSettings" and/or "templateLoaderPath" properties. The simplest way to use this class is to specify just a "templateLoaderPath"; you do not need any further configuration then.
<bean id="freemarkerConfig" class="org.springframework.web.servlet.view.freemarker.FreeMarkerConfigurer"> <property name="templateLoaderPath"><value>/WEB-INF/freemarker/</value></property> </bean>This bean must be included in the application context of any application using Spring's FreeMarkerView for web MVC. It exists purely to configure FreeMarker. It is not meant to be referenced by application components but just internally by FreeMarkerView. Implements FreeMarkerConfig to be found by FreeMarkerView without depending on the bean name the configurer. Each DispatcherServlet can define its own FreeMarkerConfigurer if desired.
Note that you can also refer to a preconfigured FreeMarker Configuration instance, for example one set up by FreeMarkerConfigurationFactoryBean, via the "configuration" property. This allows to share a FreeMarker Configuration for web and email usage, for example.
This configurer registers a template loader for this package, allowing to reference the "spring.ftl" macro library (contained in this package and thus in spring.jar) like this:
<#import "spring.ftl" as spring/> <@spring.bind "person.age"/> age is ${spring.status.value}Note: Spring's FreeMarker support requires FreeMarker 2.3 or higher.
FreeMarkerConfigurationFactory.setConfigLocation(org.springframework.core.io.Resource)
,
FreeMarkerConfigurationFactory.setFreemarkerSettings(java.util.Properties)
,
FreeMarkerConfigurationFactory.setTemplateLoaderPath(java.lang.String)
,
setConfiguration(freemarker.template.Configuration)
,
FreeMarkerConfigurationFactoryBean
,
FreeMarkerView
Field Summary |
---|
Fields inherited from class org.springframework.ui.freemarker.FreeMarkerConfigurationFactory |
---|
logger |
Constructor Summary | |
---|---|
FreeMarkerConfigurer()
|
Method Summary | |
---|---|
void |
afterPropertiesSet()
Initialize FreeMarkerConfigurationFactory's Configuration if not overridden by a preconfigured FreeMarker Configuation. |
Configuration |
getConfiguration()
Return the Configuration object wrapped by this bean. |
TaglibFactory |
getTaglibFactory()
Return the TaglibFactory object wrapped by this bean. |
protected void |
postProcessTemplateLoaders(List templateLoaders)
This implementation registers an additional ClassTemplateLoader for the Spring-provided macros, added to the end of the list. |
void |
setConfiguration(Configuration configuration)
Set a preconfigured Configuration to use for the FreeMarker web config, e.g. a shared one for web and email usage, set up via FreeMarkerConfigurationFactoryBean. |
void |
setServletContext(ServletContext servletContext)
Initialize the TaglibFactory for the given ServletContext. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.springframework.context.ResourceLoaderAware |
---|
setResourceLoader |
Constructor Detail |
---|
public FreeMarkerConfigurer()
Method Detail |
---|
public void setConfiguration(Configuration configuration)
FreeMarkerConfigurationFactoryBean
public void setServletContext(ServletContext servletContext)
TaglibFactory
for the given ServletContext.
setServletContext
in interface ServletContextAware
servletContext
- ServletContext object to be used by this objectInitializingBean.afterPropertiesSet()
,
ApplicationContextAware.setApplicationContext(org.springframework.context.ApplicationContext)
public void afterPropertiesSet() throws IOException, TemplateException
Sets up a ClassTemplateLoader to use for loading Spring macros.
afterPropertiesSet
in interface InitializingBean
protected void postProcessTemplateLoaders(List templateLoaders)
postProcessTemplateLoaders
in class FreeMarkerConfigurationFactory
templateLoaders
- the current List of TemplateLoader instances,
to be modified by a subclassFreeMarkerConfigurationFactory.createConfiguration()
,
FreeMarkerConfigurationFactory.setPostTemplateLoaders(freemarker.cache.TemplateLoader[])
public Configuration getConfiguration()
getConfiguration
in interface FreeMarkerConfig
public TaglibFactory getTaglibFactory()
getTaglibFactory
in interface FreeMarkerConfig
|
The Spring Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |