| java.lang.Object
 org.apache.struts2.dispatcher.StrutsResultSupport
org.apache.struts2.views.freemarker.FreemarkerResult
| FreemarkerResult | | public class FreemarkerResult extends StrutsResultSupport (Code) | |
Renders a view using the Freemarker template engine.
The FreemarkarManager class configures the template loaders so that the
template location can be either
- relative to the web root folder. eg
/WEB-INF/views/home.ftl
- a classpath resuorce. eg
com/company/web/views/home.ftl
This result type takes the following parameters:
- location (default) - the location of the template to process.
- parse - true by default. If set to false, the location param will
not be parsed for Ognl expressions.
- contentType - defaults to "text/html" unless specified.
Example:
<result name="success" type="freemarker">foo.ftl</result>
|
| configuration | | protected Configuration configuration(Code) | | |
| invocation | | protected ActionInvocation invocation(Code) | | |
| wrapper | | protected ObjectWrapper wrapper(Code) | | |
| FreemarkerResult | | public FreemarkerResult()(Code) | | |
| FreemarkerResult | | public FreemarkerResult(String location)(Code) | | |
| createModel | | protected TemplateModel createModel() throws TemplateModelException(Code) | | Build the instance of the ScopesHashModel, including JspTagLib support
Objects added to the model are
- Application - servlet context attributes hash model
- JspTaglibs - jsp tag lib factory model
- Request - request attributes hash model
- Session - session attributes hash model
- request - the HttpServletRequst object for direct access
- response - the HttpServletResponse object for direct access
- stack - the OgnLValueStack instance for direct access
- ognl - the instance of the OgnlTool
- action - the action itself
- exception - optional : the JSP or Servlet exception as per the servlet spec (for JSP Exception pages)
- struts - instance of the StrutsUtil class
|
| deduceLocale | | protected Locale deduceLocale()(Code) | | Returns the locale used for the
Configuration.getTemplate(StringLocale) call. The base implementation
simply returns the locale setting of the action (assuming the action implements
LocaleProvider ) or, if
the action does not the configuration's locale is returned. Override this method to provide different behaviour,
|
| doExecute | | public void doExecute(String location, ActionInvocation invocation) throws IOException, TemplateException(Code) | | Execute this result, using the specified template location.
The template location has already been interoplated for any variable substitutions
this method obtains the freemarker configuration and the object wrapper from the provided hooks.
It them implements the template processing workflow by calling the hooks for
preTemplateProcess and postTemplateProcess
|
| getConfiguration | | protected Configuration getConfiguration() throws TemplateException(Code) | | This method is called from
FreemarkerResult.doExecute(String,ActionInvocation) to obtain the
FreeMarker configuration object that this result will use for template loading. This is a
hook that allows you to custom-configure the configuration object in a subclass, or to fetch
it from an IoC container.
The default implementation obtains the configuration from the ConfigurationManager instance.
|
| getContentType | | public String getContentType()(Code) | | allow parameterization of the contentType
the default being text/html
|
| getObjectWrapper | | protected ObjectWrapper getObjectWrapper()(Code) | | This method is called from
FreemarkerResult.doExecute(String,ActionInvocation) to obtain the
FreeMarker object wrapper object that this result will use for adapting objects into template
models. This is a hook that allows you to custom-configure the wrapper object in a subclass.
The default implementation returns
Configuration.getObjectWrapper
|
| getWriter | | protected Writer getWriter() throws IOException(Code) | | The default writer writes directly to the response writer.
|
| postTemplateProcess | | protected void postTemplateProcess(Template template, TemplateModel data) throws IOException(Code) | | the default implementation of postTemplateProcess applies the contentType parameter
|
| preTemplateProcess | | protected boolean preTemplateProcess(Template template, TemplateModel model) throws IOException(Code) | | Called before the execution is passed to template.process().
This is a generic hook you might use in subclasses to perform a specific
action before the template is processed. By default does nothing.
A typical action to perform here is to inject application-specific
objects into the model root
true to process the template, false to suppress template processing. |
| setContentType | | public void setContentType(String aContentType)(Code) | | |
| Fields inherited from org.apache.struts2.dispatcher.StrutsResultSupport | final public static String DEFAULT_PARAM(Code)(Java Doc)
|
|
|