| java.lang.Object
 org.apache.struts2.dispatcher.StrutsResultSupport
org.apache.struts2.dispatcher.VelocityResult
| VelocityResult | | public class VelocityResult extends StrutsResultSupport (Code) | |
Using the Servlet container's
JspFactory , this result mocks a JSP
execution environment and then displays a Velocity template that will be
streamed directly to the servlet output.
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.
This result follows the same rules from
StrutsResultSupport .
Example:
<result name="success" type="velocity">
<param name="location">foo.vm</param>
</result>
|
| Method Summary | |
| protected Context | createContext(VelocityManager velocityManager, ValueStack stack, HttpServletRequest request, HttpServletResponse response, String location)
Creates the VelocityContext that we'll use to render this page. | | public void | doExecute(String finalLocation, ActionInvocation invocation)
Creates a Velocity context from the action, loads a Velocity template and executes the
template. | | protected String | getContentType(String templateLocation)
Retrieve the content type for this template. | | protected String | getEncoding(String templateLocation)
Retrieve the encoding for this template. | | protected Template | getTemplate(ValueStack stack, VelocityEngine velocity, ActionInvocation invocation, String location, String encoding)
Given a value stack, a Velocity engine, and an action invocation, this method returns the appropriate
Velocity template to render. | | public void | setDefaultEncoding(String val)
| | public void | setVelocityManager(VelocityManager mgr)
|
| VelocityResult | | public VelocityResult()(Code) | | |
| createContext | | protected Context createContext(VelocityManager velocityManager, ValueStack stack, HttpServletRequest request, HttpServletResponse response, String location)(Code) | | Creates the VelocityContext that we'll use to render this page.
Parameters:
velocityManager - a reference to the velocityManager to use
Parameters:
stack - the value stack to resolve the location against (when parse equals true)
Parameters:
location - the name of the template that is being used the a minted Velocity context. |
| doExecute | | public void doExecute(String finalLocation, ActionInvocation invocation) throws Exception(Code) | | Creates a Velocity context from the action, loads a Velocity template and executes the
template. Output is written to the servlet output stream.
Parameters:
finalLocation - the location of the Velocity template
Parameters:
invocation - an encapsulation of the action execution state.
throws:
Exception - if an error occurs when creating the Velocity context, loading or executingthe template or writing output to the servlet response stream. |
| getContentType | | protected String getContentType(String templateLocation)(Code) | | Retrieve the content type for this template.
People can override this method if they want to provide specific content types for specific templates (eg text/xml).
The content type associated with this template (default "text/html") |
| getEncoding | | protected String getEncoding(String templateLocation)(Code) | | Retrieve the encoding for this template.
People can override this method if they want to provide specific encodings for specific templates.
The encoding associated with this template (defaults to the value of 'struts.i18n.encoding' property) |
| getTemplate | | protected Template getTemplate(ValueStack stack, VelocityEngine velocity, ActionInvocation invocation, String location, String encoding) throws Exception(Code) | | Given a value stack, a Velocity engine, and an action invocation, this method returns the appropriate
Velocity template to render.
Parameters:
stack - the value stack to resolve the location again (when parse equals true)
Parameters:
velocity - the velocity engine to process the request against
Parameters:
invocation - an encapsulation of the action execution state.
Parameters:
location - the location of the template
Parameters:
encoding - the charset encoding of the template the template to render
throws:
Exception - when the requested template could not be found |
| setDefaultEncoding | | public void setDefaultEncoding(String val)(Code) | | |
| Fields inherited from org.apache.struts2.dispatcher.StrutsResultSupport | final public static String DEFAULT_PARAM(Code)(Java Doc)
|
|
|