FreeMarkerConfigurationFactory (Spring Framework) - Spring Framework 1.2.9 API 文档英文版

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.springframework.ui.freemarker
Class FreeMarkerConfigurationFactory

java.lang.Object
  org.springframework.ui.freemarker.FreeMarkerConfigurationFactory

Direct Known Subclasses:: FreeMarkerConfigurationFactoryBean, FreeMarkerConfigurer

public class FreeMarkerConfigurationFactory
extends Object
extends Object

Factory that configures a FreeMarker Configuration. Can be used standalone, but typically you will either use FreeMarkerConfigurationFactoryBean for preparing a Configuration as bean reference, or FreeMarkerConfigurer for web views.

The optional "configLocation" property sets the location of a FreeMarker properties file, within the current application. FreeMarker properties can be overridden via "freemarkerSettings". All of these properties will be set by calling FreeMarker's Configuration.setSettings() method and are subject to constraints set by FreeMarker.

The "freemarkerVariables" property can be used to specify a Map of shared variables that will be applied to the Configuration via the setAllSharedVariables() method. Like setSettings(), these entries are subject to FreeMarker constraints.

The simplest way to use this class is to specify a "templateLoaderPath"; FreeMarker does not need any further configuration then.

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

Since:: 03.03.2004
Author:: Darren Davison, Juergen Hoeller
See Also:: setConfigLocation(org.springframework.core.io.Resource), setFreemarkerSettings(java.util.Properties), setFreemarkerVariables(java.util.Map), setTemplateLoaderPath(java.lang.String), createConfiguration(), FreeMarkerConfigurationFactoryBean, FreeMarkerConfigurer, Configuration

Field Summary

protected Log logger


Constructor Summary

FreeMarkerConfigurationFactory()


Method Summary

Configuration createConfiguration()
          Prepare the FreeMarker Configuration and return it.

protected TemplateLoader getAggregateTemplateLoader(List templateLoaders)
          Return a TemplateLoader based on the given TemplateLoader list.

protected ResourceLoader getResourceLoader()
          Return the Spring ResourceLoader to use for loading FreeMarker template files.

protected TemplateLoader getTemplateLoaderForPath(String templateLoaderPath)
          Determine a FreeMarker TemplateLoader for the given path.

protected boolean isPreferFileSystemAccess()
          Return whether to prefer file system access for template loading.

protected Configuration newConfiguration()
          Return a new Configuration object.

protected void postProcessConfiguration(Configuration config)
          To be overridden by subclasses that want to to perform custom post-processing of the Configuration object after this factory performed its default initialization.

protected void postProcessTemplateLoaders(List templateLoaders)
          To be overridden by subclasses that want to to register custom TemplateLoader instances after this factory created its default template loaders.

void setConfigLocation(Resource resource)
          Set the location of the FreeMarker config file.

void setDefaultEncoding(String defaultEncoding)
          Set the default encoding for the FreeMarker configuration.

void setFreemarkerSettings(Properties settings)
          Set properties that contain well-known FreeMarker keys which will be passed to FreeMarker's Configuration.setSettings method.

void setFreemarkerVariables(Map variables)
          Set a Map that contains well-known FreeMarker objects which will be passed to FreeMarker's Configuration.setAllSharedVariables() method.

void setPreferFileSystemAccess(boolean preferFileSystemAccess)
          Set whether to prefer file system access for template loading.

void setResourceLoader(ResourceLoader resourceLoader)
          Set the Spring ResourceLoader to use for loading FreeMarker template files.

void setTemplateLoaderPath(String templateLoaderPath)
          Set the Freemarker template loader path via a Spring resource location.

void setTemplateLoaderPaths(String[] templateLoaderPaths)
          Set multiple Freemarker template loader paths via Spring resource locations.

void setTemplateLoaders(TemplateLoader[] templateLoaders)
          Set a List of TemplateLoaders that will be used to search for templates.

Methods inherited from class java.lang.Object

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

Field Summary
`protected Log`	`logger`

Constructor Summary
`FreeMarkerConfigurationFactory()`

Method Summary
`Configuration`	`createConfiguration()` Prepare the FreeMarker Configuration and return it.
`protected TemplateLoader`	`getAggregateTemplateLoader(List templateLoaders)` Return a TemplateLoader based on the given TemplateLoader list.
`protected ResourceLoader`	`getResourceLoader()` Return the Spring ResourceLoader to use for loading FreeMarker template files.
`protected TemplateLoader`	`getTemplateLoaderForPath(String templateLoaderPath)` Determine a FreeMarker TemplateLoader for the given path.
`protected boolean`	`isPreferFileSystemAccess()` Return whether to prefer file system access for template loading.
`protected Configuration`	`newConfiguration()` Return a new Configuration object.
`protected void`	`postProcessConfiguration(Configuration config)` To be overridden by subclasses that want to to perform custom post-processing of the Configuration object after this factory performed its default initialization.
`protected void`	`postProcessTemplateLoaders(List templateLoaders)` To be overridden by subclasses that want to to register custom TemplateLoader instances after this factory created its default template loaders.
`void`	`setConfigLocation(Resource resource)` Set the location of the FreeMarker config file.
`void`	`setDefaultEncoding(String defaultEncoding)` Set the default encoding for the FreeMarker configuration.
`void`	`setFreemarkerSettings(Properties settings)` Set properties that contain well-known FreeMarker keys which will be passed to FreeMarker's `Configuration.setSettings` method.
`void`	`setFreemarkerVariables(Map variables)` Set a Map that contains well-known FreeMarker objects which will be passed to FreeMarker's `Configuration.setAllSharedVariables()` method.
`void`	`setPreferFileSystemAccess(boolean preferFileSystemAccess)` Set whether to prefer file system access for template loading.
`void`	`setResourceLoader(ResourceLoader resourceLoader)` Set the Spring ResourceLoader to use for loading FreeMarker template files.
`void`	`setTemplateLoaderPath(String templateLoaderPath)` Set the Freemarker template loader path via a Spring resource location.
`void`	`setTemplateLoaderPaths(String[] templateLoaderPaths)` Set multiple Freemarker template loader paths via Spring resource locations.
`void`	`setTemplateLoaders(TemplateLoader[] templateLoaders)` Set a List of `TemplateLoaders that will be used to search for templates.`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

logger

protected final Log logger

Constructor Detail