|
The Spring Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.springframework.context.support.ApplicationObjectSupport org.springframework.web.context.support.WebApplicationObjectSupport org.springframework.web.servlet.view.AbstractView org.springframework.web.servlet.view.AbstractUrlBasedView org.springframework.web.servlet.view.AbstractTemplateView org.springframework.web.servlet.view.freemarker.FreeMarkerView
public class FreeMarkerView
View using the FreeMarker template engine.
Exposes the following JavaBean properties:
Depends on a single FreeMarkerConfig
object such as FreeMarkerConfigurer
being accessible in the current web application context, with any bean name.
Alternatively, you can set the FreeMarker Configuration
object as bean property.
See setConfiguration(freemarker.template.Configuration)
for more details on the impacts of this approach.
Note: Spring's FreeMarker support requires FreeMarker 2.3 or higher.
AbstractUrlBasedView.setUrl(java.lang.String)
,
AbstractTemplateView.setExposeSpringMacroHelpers(boolean)
,
setEncoding(java.lang.String)
,
setConfiguration(freemarker.template.Configuration)
,
FreeMarkerConfig
,
FreeMarkerConfigurer
Field Summary |
---|
Fields inherited from class org.springframework.web.servlet.view.AbstractTemplateView |
---|
SPRING_MACRO_REQUEST_CONTEXT_ATTRIBUTE |
Fields inherited from class org.springframework.web.servlet.view.AbstractView |
---|
DEFAULT_CONTENT_TYPE |
Fields inherited from class org.springframework.context.support.ApplicationObjectSupport |
---|
logger |
Constructor Summary | |
---|---|
FreeMarkerView()
|
Method Summary | |
---|---|
protected FreeMarkerConfig |
autodetectConfiguration()
Autodetect a FreeMarkerConfig object via the ApplicationContext. |
protected void |
checkTemplate()
Check that the FreeMarker template used for this view exists and is valid. |
protected void |
doRender(Map model,
HttpServletRequest request,
HttpServletResponse response)
Render the FreeMarker view to the given response, using the given model map which contains the complete template model to use. |
protected void |
exposeHelpers(Map model,
HttpServletRequest request)
Expose helpers unique to each rendering operation. |
protected Configuration |
getConfiguration()
Return the FreeMarker configuration used by this view. |
protected String |
getEncoding()
Return the encoding for the FreeMarker template. |
protected ObjectWrapper |
getObjectWrapper()
Return the configured FreeMarker ObjectWrapper , or the
default wrapper if none specified. |
protected Template |
getTemplate(Locale locale)
Retrieve the FreeMarker template for the given locale, to be rendering by this view. |
protected Template |
getTemplate(String name,
Locale locale)
Retrieve the FreeMarker template specified by the given name, using the encoding specified by the "encoding" bean property. |
protected void |
initApplicationContext()
Invoked on startup. |
protected void |
processTemplate(Template template,
Map model,
HttpServletResponse response)
Process the FreeMarker template to the servlet response. |
protected void |
renderMergedTemplateModel(Map model,
HttpServletRequest request,
HttpServletResponse response)
Process the model map by merging it with the FreeMarker template. |
void |
setConfiguration(Configuration configuration)
Set the FreeMarker Configuration to be used by this view. |
void |
setEncoding(String encoding)
Set the encoding of the FreeMarker template file. |
Methods inherited from class org.springframework.web.servlet.view.AbstractTemplateView |
---|
applyContentType, renderMergedOutputModel, setAllowRequestOverride, setAllowSessionOverride, setExposeRequestAttributes, setExposeSessionAttributes, setExposeSpringMacroHelpers |
Methods inherited from class org.springframework.web.servlet.view.AbstractUrlBasedView |
---|
afterPropertiesSet, getUrl, setUrl, toString |
Methods inherited from class org.springframework.web.servlet.view.AbstractView |
---|
addStaticAttribute, createRequestContext, exposeModelAsRequestAttributes, getAttributesMap, getBeanName, getContentType, getRequestContextAttribute, getStaticAttributes, render, setAttributes, setAttributesCSV, setAttributesMap, setBeanName, setContentType, setRequestContextAttribute |
Methods inherited from class org.springframework.web.context.support.WebApplicationObjectSupport |
---|
getServletContext, getTempDir, getWebApplicationContext, isContextRequired, setServletContext |
Methods inherited from class org.springframework.context.support.ApplicationObjectSupport |
---|
getApplicationContext, getMessageSourceAccessor, requiredContextClass, setApplicationContext |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public FreeMarkerView()
Method Detail |
---|
public void setEncoding(String encoding)
Specify the encoding in the FreeMarker Configuration rather than per template if all your templates share a common encoding.
protected String getEncoding()
public void setConfiguration(Configuration configuration)
FreeMarkerConfig
is expected in the current web application context, with any bean name.
Note: using this method will cause a new instance of TaglibFactory
to created for every single FreeMarkerView
instance. This can be quite expensive
in terms of memory and initial CPU usage. In production it is recommended that you use
a FreeMarkerConfig
which exposes a single shared TaglibFactory
.
protected Configuration getConfiguration()
protected void initApplicationContext() throws BeansException
Checks that the template for the default Locale can be found: FreeMarker will check non-Locale-specific templates if a locale-specific one is not found.
initApplicationContext
in class ApplicationObjectSupport
ApplicationContextException
- in case of initialization errors
BeansException
- if thrown by ApplicationContext methodsTemplateCache.getTemplate(java.lang.String, java.util.Locale, java.lang.String, boolean)
protected FreeMarkerConfig autodetectConfiguration() throws BeansException
FreeMarkerConfig
object via the ApplicationContext.
BeansException
- if no Configuration instance could be foundApplicationObjectSupport.getApplicationContext()
,
setConfiguration(freemarker.template.Configuration)
protected ObjectWrapper getObjectWrapper()
ObjectWrapper
, or the
default wrapper
if none specified.
Configurable.getObjectWrapper()
protected void checkTemplate() throws ApplicationContextException
Can be overridden to customize the behavior, for example in case of multiple templates to be rendered into a single view.
ApplicationContextException
- if the template cannot be found or is invalidprotected void renderMergedTemplateModel(Map model, HttpServletRequest request, HttpServletResponse response) throws Exception
This method can be overridden if custom behavior is needed.
renderMergedTemplateModel
in class AbstractTemplateView
model
- combined output Map, with request attributes and
session attributes merged into it if requiredrequest
- current HTTP requestresponse
- current HTTP response
Exception
- if rendering failedprotected void exposeHelpers(Map model, HttpServletRequest request) throws Exception
Called by renderMergedTemplateModel
. The default implementation
is empty. This method can be overridden to add custom helpers to the model.
model
- The model that will be passed to the template at merge timerequest
- current HTTP request
Exception
- if there's a fatal error while we're adding information to the contextrenderMergedTemplateModel(java.util.Map, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
protected void doRender(Map model, HttpServletRequest request, HttpServletResponse response) throws Exception
The default implementation renders the template specified by the "url"
bean property, retrieved via getTemplate
. It delegates to the
processTemplate
method to merge the template instance with
the given template model.
Adds the standard Freemarker hash models to the model: request parameters, request, session and application (ServletContext), as well as the JSP tag library hash model.
Can be overridden to customize the behavior, for example to render multiple templates into a single view.
model
- the template model to use for renderingrequest
- current HTTP requestresponse
- current servlet response
IOException
- if the template file could not be retrieved
Exception
- if rendering failedAbstractUrlBasedView.setUrl(java.lang.String)
,
RequestContextUtils.getLocale(javax.servlet.http.HttpServletRequest)
,
getTemplate(java.util.Locale)
,
processTemplate(freemarker.template.Template, java.util.Map, javax.servlet.http.HttpServletResponse)
,
FreemarkerServlet
protected Template getTemplate(Locale locale) throws IOException
By default, the template specified by the "url" bean property will be retrieved.
locale
- the current locale
IOException
- if the template file could not be retrievedAbstractUrlBasedView.setUrl(java.lang.String)
,
getTemplate(String, java.util.Locale)
protected Template getTemplate(String name, Locale locale) throws IOException
Can be called by subclasses to retrieve a specific template, for example to render multiple templates into a single view.
name
- the file name of the desired templatelocale
- the current locale
IOException
- if the template file could not be retrievedprotected void processTemplate(Template template, Map model, HttpServletResponse response) throws IOException, TemplateException
Can be overridden to customize the behavior.
template
- the template to processmodel
- the model for the templateresponse
- servlet response (use this to get the OutputStream or Writer)
IOException
- if the template file could not be retrieved
TemplateException
- if thrown by FreeMarkerTemplate.process(Object, java.io.Writer)
|
The Spring Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |