Package org.springframework.web.servlet.view.freemarker

Class FreeMarkerConfigurer

java.lang.Object
org.springframework.ui.freemarker.FreeMarkerConfigurationFactory
org.springframework.web.servlet.view.freemarker.FreeMarkerConfigurer
All Implemented Interfaces:
Aware, InitializingBean, ResourceLoaderAware, FreeMarkerConfig
public class FreeMarkerConfigurer extends FreeMarkerConfigurationFactory implements FreeMarkerConfig, InitializingBean, ResourceLoaderAware
Bean to configure FreeMarker for web usage, via the "configLocation", "freemarkerSettings", 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 of the configurer. Each DispatcherServlet can define its own FreeMarkerConfigurer if desired.

Note that you can also refer to a pre-configured FreeMarker Configuration instance 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: 

 <#import "/spring.ftl" as spring/>
 <@spring.bind "person.age"/>
 age is ${spring.status.value}

Note: Spring's FreeMarker support requires FreeMarker 2.3.21 or higher.

Since:
03.03.2004
Author:
Darren Davison, Rob Harrop
See Also: