| Methods Summary |
|---|
| protected freemarker.template.TemplateModel | createModel()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
ServletContext servletContext = ServletActionContext.getServletContext();
HttpServletRequest request = ServletActionContext.getRequest();
HttpServletResponse response = ServletActionContext.getResponse();
ValueStack stack = ServletActionContext.getContext().getValueStack();
Object action = null;
if(invocation!= null ) action = invocation.getAction(); //Added for NullPointException
return freemarkerManager.buildTemplateModel(stack, action, servletContext, request, response, wrapper);
|
| protected java.util.Locale | deduceLocale()Returns the locale used for the {@link Configuration#getTemplate(String, Locale)} call. The base implementation
simply returns the locale setting of the action (assuming the action implements {@link LocaleProvider}) or, if
the action does not the configuration's locale is returned. Override this method to provide different behaviour,
if (invocation.getAction() instanceof LocaleProvider) {
return ((LocaleProvider) invocation.getAction()).getLocale();
} else {
return configuration.getLocale();
}
|
| public void | doExecute(java.lang.String location, com.opensymphony.xwork2.ActionInvocation invocation)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
this.location = location;
this.invocation = invocation;
this.configuration = getConfiguration();
this.wrapper = getObjectWrapper();
if (!location.startsWith("/")) {
ActionContext ctx = invocation.getInvocationContext();
HttpServletRequest req = (HttpServletRequest) ctx.get(ServletActionContext.HTTP_REQUEST);
String base = ResourceUtil.getResourceBase(req);
location = base + "/" + location;
}
Template template = configuration.getTemplate(location, deduceLocale());
TemplateModel model = createModel();
// Give subclasses a chance to hook into preprocessing
if (preTemplateProcess(template, model)) {
try {
// Process the template
template.process(model, getWriter());
} finally {
// Give subclasses a chance to hook into postprocessing
postTemplateProcess(template, model);
}
}
|
| protected freemarker.template.Configuration | getConfiguration()This method is called from {@link #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.
return freemarkerManager.getConfiguration(ServletActionContext.getServletContext());
|
| public java.lang.String | getContentType()allow parameterization of the contentType
the default being text/html
return pContentType;
|
| protected freemarker.template.ObjectWrapper | getObjectWrapper()This method is called from {@link #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 {@link Configuration#getObjectWrapper()}
return configuration.getObjectWrapper();
|
| protected java.io.Writer | getWriter()The default writer writes directly to the response writer.
if(writer != null) {
return writer;
}
return ServletActionContext.getResponse().getWriter();
|
| protected void | postTemplateProcess(freemarker.template.Template template, freemarker.template.TemplateModel data)the default implementation of postTemplateProcess applies the contentType parameter
|
| protected boolean | preTemplateProcess(freemarker.template.Template template, freemarker.template.TemplateModel model)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
Object attrContentType = template.getCustomAttribute("content_type");
if (attrContentType != null) {
ServletActionContext.getResponse().setContentType(attrContentType.toString());
} else {
String contentType = getContentType();
if (contentType == null) {
contentType = "text/html";
}
String encoding = template.getEncoding();
if (encoding != null) {
contentType = contentType + "; charset=" + encoding;
}
ServletActionContext.getResponse().setContentType(contentType);
}
return true;
|
| public void | setContentType(java.lang.String aContentType)
pContentType = aContentType;
|
| public void | setFreemarkerManager(FreemarkerManager mgr)
this.freemarkerManager = mgr;
|
| public void | setWriter(java.io.Writer writer)
this.writer = writer;
|
