| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_171) on Wed Jun 20 14:25:32 CEST 2018 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>VelocityView (VelocityTools 3.0-SNAPSHOT API)</title> |
| <meta name="date" content="2018-06-20"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="VelocityView (VelocityTools 3.0-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/VelocityView.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/velocity/tools/view/VelocityLayoutServlet.html" title="class in org.apache.velocity.tools.view"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/velocity/tools/view/VelocityViewFilter.html" title="class in org.apache.velocity.tools.view"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/velocity/tools/view/VelocityView.html" target="_top">Frames</a></li> |
| <li><a href="VelocityView.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.velocity.tools.view</div> |
| <h2 title="Class VelocityView" class="title">Class VelocityView</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../org/apache/velocity/tools/ToolManager.html" title="class in org.apache.velocity.tools">org.apache.velocity.tools.ToolManager</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../org/apache/velocity/tools/view/ViewToolManager.html" title="class in org.apache.velocity.tools.view">org.apache.velocity.tools.view.ViewToolManager</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.velocity.tools.view.VelocityView</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">VelocityView</span> |
| extends <a href="../../../../../org/apache/velocity/tools/view/ViewToolManager.html" title="class in org.apache.velocity.tools.view">ViewToolManager</a></pre> |
| <div class="block"><p>The class provides the following features:</p> |
| <ul> |
| <li>renders Velocity templates</li> |
| <li>provides support for an auto-loaded, configurable toolbox</li> |
| <li>provides transparent access to the servlet request attributes, |
| servlet session attributes and servlet context attributes by |
| auto-searching them</li> |
| <li>logs to the logging facility of the servlet API</li> |
| </ul> |
| |
| <p>VelocityView supports the following configuration parameters |
| in web.xml:</p> |
| <dl> |
| <dt>org.apache.velocity.tools</dt> |
| <dd>Path and name of the toolbox configuration file. The path must be |
| relative to the web application root directory. If this parameter is |
| not found, the servlet will check for a toolbox file at |
| '/WEB-INF/tools.xml'.</dd> |
| <dt>org.apache.velocity.properties</dt> |
| <dd>Path and name of the Velocity configuration file. The path must be |
| relative to the web application root directory. If this parameter |
| is not present, Velocity will check for a properties file at |
| '/WEB-INF/velocity.properties'. If no file is found there, then |
| Velocity is initialized with the settings in the classpath at |
| 'org.apache.velocity.tools.view.velocity.properties'.</dd> |
| </dl></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Version:</span></dt> |
| <dd>$Id: VelocityView.java 511959 2007-02-26 19:24:39Z nbubna $</dd> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd>Dave Bryson, <a href="mailto:jon@latchkey.com">Jon S. Stevens</a>, <a href="mailto:sidler@teamup.com">Gabe Sidler</a>, <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a>, <a href="mailto:kjohnson@transparent.com">Kent Johnson</a>, <a href="mailto:dlr@finemaltcoding.com">Daniel Rall</a>, Nathan Bubna</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/VelocityView.html#CLEAN_CONFIGURATION_KEY">CLEAN_CONFIGURATION_KEY</a></span></code> |
| <div class="block">Controls removal of tools or data with invalid configurations |
| before initialization is finished.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/VelocityView.html#CONTENT_TYPE_KEY">CONTENT_TYPE_KEY</a></span></code> |
| <div class="block">The HTTP content type context key.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/VelocityView.html#DEFAULT_CONTENT_TYPE">DEFAULT_CONTENT_TYPE</a></span></code> |
| <div class="block">The default content type for the response</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/VelocityView.html#DEFAULT_OUTPUT_ENCODING">DEFAULT_OUTPUT_ENCODING</a></span></code> |
| <div class="block">Default encoding for the output stream</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/VelocityView.html#DEFAULT_PROPERTIES_PATH">DEFAULT_PROPERTIES_PATH</a></span></code> |
| <div class="block">Default Runtime properties.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/VelocityView.html#LOAD_DEFAULTS_KEY">LOAD_DEFAULTS_KEY</a></span></code> |
| <div class="block">Controls loading of available default tool configurations |
| provided by VelocityTools.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/VelocityView.html#OUTPUT_ENCODING_KEY">OUTPUT_ENCODING_KEY</a></span></code> |
| <div class="block">The HTTP output encoding.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/VelocityView.html#PROPERTIES_KEY">PROPERTIES_KEY</a></span></code> |
| <div class="block">This is the string that is looked for when getInitParameter is |
| called ("org.apache.velocity.properties").</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/VelocityView.html#SERVLET_CONTEXT_KEY">SERVLET_CONTEXT_KEY</a></span></code> |
| <div class="block">Key used to access the ServletContext in |
| the Velocity application attributes.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/VelocityView.html#TOOLS_KEY">TOOLS_KEY</a></span></code> |
| <div class="block">Key used to access the toolbox configuration file path from the |
| Servlet or webapp init parameters ("org.apache.velocity.tools") |
| or to access a live <a href="../../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config"><code>FactoryConfiguration</code></a> previously |
| placed in the ServletContext attributes.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/VelocityView.html#USER_OVERWRITE_KEY">USER_OVERWRITE_KEY</a></span></code> |
| <div class="block">Controls whether or not templates can overwrite tool and servlet API |
| variables in the local context.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/VelocityView.html#USER_PROPERTIES_PATH">USER_PROPERTIES_PATH</a></span></code> |
| <div class="block">Default velocity properties file path.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/VelocityView.html#USER_TOOLS_PATH">USER_TOOLS_PATH</a></span></code> |
| <div class="block">Default toolbox configuration file path.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.velocity.tools.view.ViewToolManager"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.velocity.tools.view.<a href="../../../../../org/apache/velocity/tools/view/ViewToolManager.html" title="class in org.apache.velocity.tools.view">ViewToolManager</a></h3> |
| <code><a href="../../../../../org/apache/velocity/tools/view/ViewToolManager.html#CREATE_SESSION_PROPERTY">CREATE_SESSION_PROPERTY</a>, <a href="../../../../../org/apache/velocity/tools/view/ViewToolManager.html#DEFAULT_TOOLBOX_KEY">DEFAULT_TOOLBOX_KEY</a>, <a href="../../../../../org/apache/velocity/tools/view/ViewToolManager.html#PUBLISH_TOOLBOXES_PROPERTY">PUBLISH_TOOLBOXES_PROPERTY</a>, <a href="../../../../../org/apache/velocity/tools/view/ViewToolManager.html#servletContext">servletContext</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.velocity.tools.ToolManager"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.velocity.tools.<a href="../../../../../org/apache/velocity/tools/ToolManager.html" title="class in org.apache.velocity.tools">ToolManager</a></h3> |
| <code><a href="../../../../../org/apache/velocity/tools/ToolManager.html#factory">factory</a>, <a href="../../../../../org/apache/velocity/tools/ToolManager.html#log">log</a>, <a href="../../../../../org/apache/velocity/tools/ToolManager.html#velocity">velocity</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/VelocityView.html#VelocityView-javax.servlet.FilterConfig-">VelocityView</a></span>(javax.servlet.FilterConfig config)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/VelocityView.html#VelocityView-org.apache.velocity.tools.view.JeeConfig-">VelocityView</a></span>(<a href="../../../../../org/apache/velocity/tools/view/JeeConfig.html" title="interface in org.apache.velocity.tools.view">JeeConfig</a> config)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/VelocityView.html#VelocityView-javax.servlet.ServletConfig-">VelocityView</a></span>(javax.servlet.ServletConfig config)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/VelocityView.html#VelocityView-javax.servlet.ServletContext-">VelocityView</a></span>(javax.servlet.ServletContext context)</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/VelocityView.html#configure-org.apache.velocity.tools.view.JeeConfig-org.apache.velocity.tools.ToolboxFactory-">configure</a></span>(<a href="../../../../../org/apache/velocity/tools/view/JeeConfig.html" title="interface in org.apache.velocity.tools.view">JeeConfig</a> config, |
| <a href="../../../../../org/apache/velocity/tools/ToolboxFactory.html" title="class in org.apache.velocity.tools">ToolboxFactory</a> factory)</code> |
| <div class="block">Here's the configuration lookup/loading order: |
| |
| If loadDefaults is true, <a href="../../../../../org/apache/velocity/tools/config/ConfigurationUtils.html#getDefaultTools--"><code>ConfigurationUtils.getDefaultTools()</code></a> |
| Config file optionally specified by servletContext <code>org.apache.velocity.tools</code> init-param |
| Config file optionally at <code>/WEB-INF/tools.xml</code> (conventional location) |
| Config file optionally specified by servlet <code>org.apache.velocity.tools</code> init-param |
| |
| Remember that as these configurations are added on top of each other, |
| the newer values will always override the older ones.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/VelocityView.html#configure-org.apache.velocity.tools.view.JeeConfig-org.apache.velocity.app.VelocityEngine-">configure</a></span>(<a href="../../../../../org/apache/velocity/tools/view/JeeConfig.html" title="interface in org.apache.velocity.tools.view">JeeConfig</a> config, |
| org.apache.velocity.app.VelocityEngine velocity)</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/velocity/tools/view/ViewToolContext.html" title="class in org.apache.velocity.tools.view">ViewToolContext</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/VelocityView.html#createContext-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-">createContext</a></span>(javax.servlet.http.HttpServletRequest request, |
| javax.servlet.http.HttpServletResponse response)</code> |
| <div class="block">Creates and returns an initialized Velocity context.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config">FactoryConfiguration</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/VelocityView.html#getConfiguration-java.lang.String-">getConfiguration</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> path)</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config">FactoryConfiguration</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/VelocityView.html#getConfiguration-java.lang.String-boolean-">getConfiguration</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> path, |
| boolean required)</code> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/VelocityView.html#getDefaultContentType--">getDefaultContentType</a></span>()</code> |
| <div class="block">Returns the configured default Content-Type.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/VelocityView.html#getInputStream-java.lang.String-boolean-">getInputStream</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> path, |
| boolean required)</code> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/VelocityView.html#getProperties-java.lang.String-">getProperties</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> path)</code> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/VelocityView.html#getProperties-java.lang.String-boolean-">getProperties</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> path, |
| boolean required)</code> </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/VelocityView.html#getProperties-java.lang.String-boolean-boolean-boolean-">getProperties</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> path, |
| boolean required, |
| boolean searchClasspath, |
| boolean searchWebapp)</code> </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/VelocityView.html#getProperty-java.lang.String-java.lang.String-">getProperty</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, |
| <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> alternate)</code> |
| <div class="block">Simplifies process of getting a property from VelocityEngine, |
| because the VelocityEngine interface sucks compared to the singleton's.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>org.apache.velocity.Template</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/VelocityView.html#getTemplate-javax.servlet.http.HttpServletRequest-">getTemplate</a></span>(javax.servlet.http.HttpServletRequest request)</code> |
| <div class="block">Gets the requested template.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>org.apache.velocity.Template</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/VelocityView.html#getTemplate-java.lang.String-">getTemplate</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> |
| <div class="block">Retrieves the requested template.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>org.apache.velocity.Template</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/VelocityView.html#getTemplate-java.lang.String-java.lang.String-">getTemplate</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> encoding)</code> |
| <div class="block">Retrieves the requested template with the specified character encoding.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/VelocityView.html#init-org.apache.velocity.tools.view.JeeConfig-">init</a></span>(<a href="../../../../../org/apache/velocity/tools/view/JeeConfig.html" title="interface in org.apache.velocity.tools.view">JeeConfig</a> config)</code> |
| <div class="block">Initializes ToolboxFactory, VelocityEngine, and sets default |
| encoding for processing requests.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/VelocityView.html#init-org.apache.velocity.tools.view.JeeConfig-org.apache.velocity.app.VelocityEngine-">init</a></span>(<a href="../../../../../org/apache/velocity/tools/view/JeeConfig.html" title="interface in org.apache.velocity.tools.view">JeeConfig</a> config, |
| org.apache.velocity.app.VelocityEngine velocity)</code> |
| <div class="block">Initializes the Velocity runtime, first calling |
| loadConfiguration(JeeConfig) to get a |
| java.util.Properties |
| of configuration information |
| and then calling velocityEngine.init().</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/VelocityView.html#merge-org.apache.velocity.Template-org.apache.velocity.context.Context-java.io.Writer-">merge</a></span>(org.apache.velocity.Template template, |
| org.apache.velocity.context.Context context, |
| <a href="https://docs.oracle.com/javase/7/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a> writer)</code> |
| <div class="block">Merges the template with the context.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/VelocityView.html#performMerge-org.apache.velocity.Template-org.apache.velocity.context.Context-java.io.Writer-">performMerge</a></span>(org.apache.velocity.Template template, |
| org.apache.velocity.context.Context context, |
| <a href="https://docs.oracle.com/javase/7/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a> writer)</code> |
| <div class="block">This is here so developers may override it and gain access to the |
| Writer which the template will be merged into.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>org.apache.velocity.context.Context</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/VelocityView.html#render-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-">render</a></span>(javax.servlet.http.HttpServletRequest request, |
| javax.servlet.http.HttpServletResponse response)</code> </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>org.apache.velocity.context.Context</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/VelocityView.html#render-javax.servlet.http.HttpServletRequest-java.io.Writer-">render</a></span>(javax.servlet.http.HttpServletRequest request, |
| <a href="https://docs.oracle.com/javase/7/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a> out)</code> </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/VelocityView.html#setDefaultContentType-java.lang.String-">setDefaultContentType</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> type)</code> |
| <div class="block">Sets the configured default Content-Type.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/VelocityView.html#setEncoding-org.apache.velocity.tools.view.JeeConfig-">setEncoding</a></span>(<a href="../../../../../org/apache/velocity/tools/view/JeeConfig.html" title="interface in org.apache.velocity.tools.view">JeeConfig</a> config)</code> </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/VelocityView.html#setVelocityEngine-org.apache.velocity.app.VelocityEngine-">setVelocityEngine</a></span>(org.apache.velocity.app.VelocityEngine engine)</code> |
| <div class="block">Overrides super class to ensure engine is not set to null.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.velocity.tools.view.ViewToolManager"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.velocity.tools.view.<a href="../../../../../org/apache/velocity/tools/view/ViewToolManager.html" title="class in org.apache.velocity.tools.view">ViewToolManager</a></h3> |
| <code><a href="../../../../../org/apache/velocity/tools/view/ViewToolManager.html#addToolboxes-org.apache.velocity.tools.ToolContext-">addToolboxes</a>, <a href="../../../../../org/apache/velocity/tools/view/ViewToolManager.html#autoConfigure-boolean-">autoConfigure</a>, <a href="../../../../../org/apache/velocity/tools/view/ViewToolManager.html#configure-org.apache.velocity.tools.config.FactoryConfiguration-">configure</a>, <a href="../../../../../org/apache/velocity/tools/view/ViewToolManager.html#createContext-java.util.Map-">createContext</a>, <a href="../../../../../org/apache/velocity/tools/view/ViewToolManager.html#findConfig-java.lang.String-">findConfig</a>, <a href="../../../../../org/apache/velocity/tools/view/ViewToolManager.html#getCreateSession--">getCreateSession</a>, <a href="../../../../../org/apache/velocity/tools/view/ViewToolManager.html#getPublishToolboxes--">getPublishToolboxes</a>, <a href="../../../../../org/apache/velocity/tools/view/ViewToolManager.html#getSessionToolbox--">getSessionToolbox</a>, <a href="../../../../../org/apache/velocity/tools/view/ViewToolManager.html#getToolboxKey--">getToolboxKey</a>, <a href="../../../../../org/apache/velocity/tools/view/ViewToolManager.html#hasSessionTools--">hasSessionTools</a>, <a href="../../../../../org/apache/velocity/tools/view/ViewToolManager.html#prepareContext-org.apache.velocity.tools.view.ViewToolContext-javax.servlet.http.HttpServletRequest-">prepareContext</a>, <a href="../../../../../org/apache/velocity/tools/view/ViewToolManager.html#publishApplicationTools--">publishApplicationTools</a>, <a href="../../../../../org/apache/velocity/tools/view/ViewToolManager.html#publishToolboxes-javax.servlet.http.HttpServletRequest-">publishToolboxes</a>, <a href="../../../../../org/apache/velocity/tools/view/ViewToolManager.html#publishToolboxes-javax.servlet.ServletRequest-">publishToolboxes</a>, <a href="../../../../../org/apache/velocity/tools/view/ViewToolManager.html#setCreateSession-boolean-">setCreateSession</a>, <a href="../../../../../org/apache/velocity/tools/view/ViewToolManager.html#setPublishToolboxes-boolean-">setPublishToolboxes</a>, <a href="../../../../../org/apache/velocity/tools/view/ViewToolManager.html#setToolboxKey-java.lang.String-">setToolboxKey</a>, <a href="../../../../../org/apache/velocity/tools/view/ViewToolManager.html#unpublishApplicationTools--">unpublishApplicationTools</a>, <a href="../../../../../org/apache/velocity/tools/view/ViewToolManager.html#updateGlobalProperties--">updateGlobalProperties</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.velocity.tools.ToolManager"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.velocity.tools.<a href="../../../../../org/apache/velocity/tools/ToolManager.html" title="class in org.apache.velocity.tools">ToolManager</a></h3> |
| <code><a href="../../../../../org/apache/velocity/tools/ToolManager.html#configure-java.lang.String-">configure</a>, <a href="../../../../../org/apache/velocity/tools/ToolManager.html#createContext--">createContext</a>, <a href="../../../../../org/apache/velocity/tools/ToolManager.html#createToolbox-java.lang.String-">createToolbox</a>, <a href="../../../../../org/apache/velocity/tools/ToolManager.html#getApplicationToolbox--">getApplicationToolbox</a>, <a href="../../../../../org/apache/velocity/tools/ToolManager.html#getLog--">getLog</a>, <a href="../../../../../org/apache/velocity/tools/ToolManager.html#getRequestToolbox--">getRequestToolbox</a>, <a href="../../../../../org/apache/velocity/tools/ToolManager.html#getToolboxFactory--">getToolboxFactory</a>, <a href="../../../../../org/apache/velocity/tools/ToolManager.html#getUserCanOverwriteTools--">getUserCanOverwriteTools</a>, <a href="../../../../../org/apache/velocity/tools/ToolManager.html#getVelocityEngine--">getVelocityEngine</a>, <a href="../../../../../org/apache/velocity/tools/ToolManager.html#hasApplicationTools--">hasApplicationTools</a>, <a href="../../../../../org/apache/velocity/tools/ToolManager.html#hasRequestTools--">hasRequestTools</a>, <a href="../../../../../org/apache/velocity/tools/ToolManager.html#hasTools-java.lang.String-">hasTools</a>, <a href="../../../../../org/apache/velocity/tools/ToolManager.html#initLog--">initLog</a>, <a href="../../../../../org/apache/velocity/tools/ToolManager.html#prepareContext-org.apache.velocity.tools.ToolContext-">prepareContext</a>, <a href="../../../../../org/apache/velocity/tools/ToolManager.html#setToolboxFactory-org.apache.velocity.tools.ToolboxFactory-">setToolboxFactory</a>, <a href="../../../../../org/apache/velocity/tools/ToolManager.html#setUserCanOverwriteTools-boolean-">setUserCanOverwriteTools</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="CONTENT_TYPE_KEY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CONTENT_TYPE_KEY</h4> |
| <pre>public static final <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> CONTENT_TYPE_KEY</pre> |
| <div class="block">The HTTP content type context key.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.velocity.tools.view.VelocityView.CONTENT_TYPE_KEY">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="OUTPUT_ENCODING_KEY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>OUTPUT_ENCODING_KEY</h4> |
| <pre>public static final <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> OUTPUT_ENCODING_KEY</pre> |
| <div class="block">The HTTP output encoding.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.velocity.tools.view.VelocityView.OUTPUT_ENCODING_KEY">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="SERVLET_CONTEXT_KEY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SERVLET_CONTEXT_KEY</h4> |
| <pre>public static final <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> SERVLET_CONTEXT_KEY</pre> |
| <div class="block">Key used to access the ServletContext in |
| the Velocity application attributes.</div> |
| </li> |
| </ul> |
| <a name="DEFAULT_CONTENT_TYPE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_CONTENT_TYPE</h4> |
| <pre>public static final <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> DEFAULT_CONTENT_TYPE</pre> |
| <div class="block">The default content type for the response</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.velocity.tools.view.VelocityView.DEFAULT_CONTENT_TYPE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DEFAULT_OUTPUT_ENCODING"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_OUTPUT_ENCODING</h4> |
| <pre>public static final <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> DEFAULT_OUTPUT_ENCODING</pre> |
| <div class="block">Default encoding for the output stream</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.velocity.tools.view.VelocityView.DEFAULT_OUTPUT_ENCODING">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="TOOLS_KEY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>TOOLS_KEY</h4> |
| <pre>public static final <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> TOOLS_KEY</pre> |
| <div class="block">Key used to access the toolbox configuration file path from the |
| Servlet or webapp init parameters ("org.apache.velocity.tools") |
| or to access a live <a href="../../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config"><code>FactoryConfiguration</code></a> previously |
| placed in the ServletContext attributes.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.velocity.tools.view.VelocityView.TOOLS_KEY">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="USER_TOOLS_PATH"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>USER_TOOLS_PATH</h4> |
| <pre>public static final <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> USER_TOOLS_PATH</pre> |
| <div class="block">Default toolbox configuration file path. If no alternate value for |
| this is specified, the servlet will look here.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.velocity.tools.view.VelocityView.USER_TOOLS_PATH">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DEFAULT_PROPERTIES_PATH"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_PROPERTIES_PATH</h4> |
| <pre>public static final <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> DEFAULT_PROPERTIES_PATH</pre> |
| <div class="block">Default Runtime properties.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.velocity.tools.view.VelocityView.DEFAULT_PROPERTIES_PATH">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="PROPERTIES_KEY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>PROPERTIES_KEY</h4> |
| <pre>public static final <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> PROPERTIES_KEY</pre> |
| <div class="block">This is the string that is looked for when getInitParameter is |
| called ("org.apache.velocity.properties").</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.velocity.tools.view.VelocityView.PROPERTIES_KEY">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="USER_PROPERTIES_PATH"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>USER_PROPERTIES_PATH</h4> |
| <pre>public static final <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> USER_PROPERTIES_PATH</pre> |
| <div class="block">Default velocity properties file path. If no alternate value for |
| this is specified, the servlet will look here.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.velocity.tools.view.VelocityView.USER_PROPERTIES_PATH">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="LOAD_DEFAULTS_KEY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>LOAD_DEFAULTS_KEY</h4> |
| <pre>public static final <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> LOAD_DEFAULTS_KEY</pre> |
| <div class="block">Controls loading of available default tool configurations |
| provided by VelocityTools. The default is false.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.velocity.tools.view.VelocityView.LOAD_DEFAULTS_KEY">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="CLEAN_CONFIGURATION_KEY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CLEAN_CONFIGURATION_KEY</h4> |
| <pre>public static final <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> CLEAN_CONFIGURATION_KEY</pre> |
| <div class="block">Controls removal of tools or data with invalid configurations |
| before initialization is finished. |
| The default is false; set to <code>true</code> to turn this feature on.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.velocity.tools.view.VelocityView.CLEAN_CONFIGURATION_KEY">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="USER_OVERWRITE_KEY"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>USER_OVERWRITE_KEY</h4> |
| <pre>public static final <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> USER_OVERWRITE_KEY</pre> |
| <div class="block">Controls whether or not templates can overwrite tool and servlet API |
| variables in the local context. The default is true; set to <code>false</code> |
| to prevent overwriting of any tool variables.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.velocity.tools.view.VelocityView.USER_OVERWRITE_KEY">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="VelocityView-javax.servlet.ServletConfig-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>VelocityView</h4> |
| <pre>public VelocityView(javax.servlet.ServletConfig config)</pre> |
| </li> |
| </ul> |
| <a name="VelocityView-javax.servlet.FilterConfig-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>VelocityView</h4> |
| <pre>public VelocityView(javax.servlet.FilterConfig config)</pre> |
| </li> |
| </ul> |
| <a name="VelocityView-javax.servlet.ServletContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>VelocityView</h4> |
| <pre>public VelocityView(javax.servlet.ServletContext context)</pre> |
| </li> |
| </ul> |
| <a name="VelocityView-org.apache.velocity.tools.view.JeeConfig-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>VelocityView</h4> |
| <pre>public VelocityView(<a href="../../../../../org/apache/velocity/tools/view/JeeConfig.html" title="interface in org.apache.velocity.tools.view">JeeConfig</a> config)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="setVelocityEngine-org.apache.velocity.app.VelocityEngine-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setVelocityEngine</h4> |
| <pre>public void setVelocityEngine(org.apache.velocity.app.VelocityEngine engine)</pre> |
| <div class="block">Overrides super class to ensure engine is not set to null.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/velocity/tools/ToolManager.html#setVelocityEngine-org.apache.velocity.app.VelocityEngine-">setVelocityEngine</a></code> in class <code><a href="../../../../../org/apache/velocity/tools/ToolManager.html" title="class in org.apache.velocity.tools">ToolManager</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDefaultContentType--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDefaultContentType</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getDefaultContentType()</pre> |
| <div class="block">Returns the configured default Content-Type.</div> |
| </li> |
| </ul> |
| <a name="setDefaultContentType-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDefaultContentType</h4> |
| <pre>public void setDefaultContentType(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> type)</pre> |
| <div class="block">Sets the configured default Content-Type.</div> |
| </li> |
| </ul> |
| <a name="getProperty-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProperty</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getProperty(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, |
| <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> alternate)</pre> |
| <div class="block">Simplifies process of getting a property from VelocityEngine, |
| because the VelocityEngine interface sucks compared to the singleton's. |
| Use of this method assumes that <a href="../../../../../org/apache/velocity/tools/view/VelocityView.html#init-org.apache.velocity.tools.view.JeeConfig-org.apache.velocity.app.VelocityEngine-"><code>init(JeeConfig,VelocityEngine)</code></a> |
| has already been called.</div> |
| </li> |
| </ul> |
| <a name="init-org.apache.velocity.tools.view.JeeConfig-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>init</h4> |
| <pre>protected void init(<a href="../../../../../org/apache/velocity/tools/view/JeeConfig.html" title="interface in org.apache.velocity.tools.view">JeeConfig</a> config)</pre> |
| <div class="block"><p>Initializes ToolboxFactory, VelocityEngine, and sets default |
| encoding for processing requests.</p> |
| |
| <p>NOTE: If no charset is specified in the default.contentType |
| property (in your velocity.properties) and you have specified |
| an output.encoding property, then that will be used as the |
| charset for the default content-type of pages served by this |
| servlet.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>config</code> - servlet configuation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="init-org.apache.velocity.tools.view.JeeConfig-org.apache.velocity.app.VelocityEngine-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>init</h4> |
| <pre>protected void init(<a href="../../../../../org/apache/velocity/tools/view/JeeConfig.html" title="interface in org.apache.velocity.tools.view">JeeConfig</a> config, |
| org.apache.velocity.app.VelocityEngine velocity)</pre> |
| <div class="block">Initializes the Velocity runtime, first calling |
| loadConfiguration(JeeConfig) to get a |
| java.util.Properties |
| of configuration information |
| and then calling velocityEngine.init(). Override this |
| to do anything to the environment before the |
| initialization of the singleton takes place, or to |
| initialize the singleton in other ways.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>config</code> - servlet configuration parameters</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="configure-org.apache.velocity.tools.view.JeeConfig-org.apache.velocity.app.VelocityEngine-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>configure</h4> |
| <pre>protected void configure(<a href="../../../../../org/apache/velocity/tools/view/JeeConfig.html" title="interface in org.apache.velocity.tools.view">JeeConfig</a> config, |
| org.apache.velocity.app.VelocityEngine velocity)</pre> |
| </li> |
| </ul> |
| <a name="configure-org.apache.velocity.tools.view.JeeConfig-org.apache.velocity.tools.ToolboxFactory-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>configure</h4> |
| <pre>protected void configure(<a href="../../../../../org/apache/velocity/tools/view/JeeConfig.html" title="interface in org.apache.velocity.tools.view">JeeConfig</a> config, |
| <a href="../../../../../org/apache/velocity/tools/ToolboxFactory.html" title="class in org.apache.velocity.tools">ToolboxFactory</a> factory)</pre> |
| <div class="block">Here's the configuration lookup/loading order: |
| <ol> |
| <li>If loadDefaults is true, <a href="../../../../../org/apache/velocity/tools/config/ConfigurationUtils.html#getDefaultTools--"><code>ConfigurationUtils.getDefaultTools()</code></a></li> |
| <li>Config file optionally specified by servletContext <code>org.apache.velocity.tools</code> init-param</li> |
| <li>Config file optionally at <code>/WEB-INF/tools.xml</code> (conventional location)</li> |
| <li>Config file optionally specified by servlet <code>org.apache.velocity.tools</code> init-param</li> |
| </ol> |
| Remember that as these configurations are added on top of each other, |
| the newer values will always override the older ones. Also, once they |
| are all loaded, this method can "clean" your configuration of all invalid |
| tool, toolbox or data configurations if you set the |
| <code>org.apache.velocity.tools.cleanConfiguration</code> init-param to true in |
| either your servlet or servletContext init-params.</div> |
| </li> |
| </ul> |
| <a name="getInputStream-java.lang.String-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInputStream</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> getInputStream(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> path, |
| boolean required)</pre> |
| </li> |
| </ul> |
| <a name="getProperties-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProperties</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> getProperties(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> path)</pre> |
| </li> |
| </ul> |
| <a name="getProperties-java.lang.String-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProperties</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> getProperties(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> path, |
| boolean required)</pre> |
| </li> |
| </ul> |
| <a name="getProperties-java.lang.String-boolean-boolean-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProperties</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> getProperties(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> path, |
| boolean required, |
| boolean searchClasspath, |
| boolean searchWebapp)</pre> |
| </li> |
| </ul> |
| <a name="getConfiguration-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConfiguration</h4> |
| <pre>protected <a href="../../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config">FactoryConfiguration</a> getConfiguration(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> path)</pre> |
| </li> |
| </ul> |
| <a name="getConfiguration-java.lang.String-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConfiguration</h4> |
| <pre>protected <a href="../../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config">FactoryConfiguration</a> getConfiguration(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> path, |
| boolean required)</pre> |
| </li> |
| </ul> |
| <a name="setEncoding-org.apache.velocity.tools.view.JeeConfig-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setEncoding</h4> |
| <pre>protected void setEncoding(<a href="../../../../../org/apache/velocity/tools/view/JeeConfig.html" title="interface in org.apache.velocity.tools.view">JeeConfig</a> config)</pre> |
| </li> |
| </ul> |
| <a name="render-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>render</h4> |
| <pre>public org.apache.velocity.context.Context render(javax.servlet.http.HttpServletRequest request, |
| javax.servlet.http.HttpServletResponse response) |
| throws <a href="https://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - HttpServletRequest object containing client request</dd> |
| <dd><code>response</code> - HttpServletResponse object for the response</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <code>Context</code> prepared and used to perform the rendering |
| to allow proper cleanup afterward</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="render-javax.servlet.http.HttpServletRequest-java.io.Writer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>render</h4> |
| <pre>public org.apache.velocity.context.Context render(javax.servlet.http.HttpServletRequest request, |
| <a href="https://docs.oracle.com/javase/7/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a> out) |
| throws <a href="https://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createContext-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createContext</h4> |
| <pre>public <a href="../../../../../org/apache/velocity/tools/view/ViewToolContext.html" title="class in org.apache.velocity.tools.view">ViewToolContext</a> createContext(javax.servlet.http.HttpServletRequest request, |
| javax.servlet.http.HttpServletResponse response)</pre> |
| <div class="block"><p>Creates and returns an initialized Velocity context.</p> |
| |
| A new context of class <a href="../../../../../org/apache/velocity/tools/view/ViewToolContext.html" title="class in org.apache.velocity.tools.view"><code>ViewToolContext</code></a> is created and |
| initialized.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/velocity/tools/view/ViewToolManager.html#createContext-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-">createContext</a></code> in class <code><a href="../../../../../org/apache/velocity/tools/view/ViewToolManager.html" title="class in org.apache.velocity.tools.view">ViewToolManager</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - servlet request from client</dd> |
| <dd><code>response</code> - servlet reponse to client</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTemplate-javax.servlet.http.HttpServletRequest-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTemplate</h4> |
| <pre>public org.apache.velocity.Template getTemplate(javax.servlet.http.HttpServletRequest request)</pre> |
| <div class="block"><p>Gets the requested template.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - client request</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Velocity Template object or null</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTemplate-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTemplate</h4> |
| <pre>public org.apache.velocity.Template getTemplate(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> |
| <div class="block">Retrieves the requested template.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - The file name of the template to retrieve relative to the |
| template root.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The requested template.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.apache.velocity.exception.ResourceNotFoundException</code> - if template not found |
| from any available source.</dd> |
| <dd><code>org.apache.velocity.exception.ParseErrorException</code> - if template cannot be parsed due |
| to syntax (or other) error.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTemplate-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTemplate</h4> |
| <pre>public org.apache.velocity.Template getTemplate(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> encoding)</pre> |
| <div class="block">Retrieves the requested template with the specified character encoding.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - The file name of the template to retrieve relative to the |
| template root.</dd> |
| <dd><code>encoding</code> - the character encoding of the template</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The requested template.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.apache.velocity.exception.ResourceNotFoundException</code> - if template not found |
| from any available source.</dd> |
| <dd><code>org.apache.velocity.exception.ParseErrorException</code> - if template cannot be parsed due |
| to syntax (or other) error.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="merge-org.apache.velocity.Template-org.apache.velocity.context.Context-java.io.Writer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>merge</h4> |
| <pre>public void merge(org.apache.velocity.Template template, |
| org.apache.velocity.context.Context context, |
| <a href="https://docs.oracle.com/javase/7/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a> writer) |
| throws <a href="https://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Merges the template with the context. Only override this if you really, really |
| really need to. (And don't call us with questions if it breaks :)</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>template</code> - template being rendered</dd> |
| <dd><code>context</code> - Context created by the <a href="../../../../../org/apache/velocity/tools/view/VelocityView.html#createContext-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-"><code>createContext(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)</code></a></dd> |
| <dd><code>writer</code> - into which the content is rendered</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="performMerge-org.apache.velocity.Template-org.apache.velocity.context.Context-java.io.Writer-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>performMerge</h4> |
| <pre>protected void performMerge(org.apache.velocity.Template template, |
| org.apache.velocity.context.Context context, |
| <a href="https://docs.oracle.com/javase/7/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a> writer) |
| throws <a href="https://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">This is here so developers may override it and gain access to the |
| Writer which the template will be merged into. See |
| <a href="http://issues.apache.org/jira/browse/VELTOOLS-7">VELTOOLS-7</a> |
| for discussion of this.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>template</code> - template object returned by the handleRequest() method</dd> |
| <dd><code>context</code> - Context created by the <a href="../../../../../org/apache/velocity/tools/view/VelocityView.html#createContext-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-"><code>createContext(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)</code></a></dd> |
| <dd><code>writer</code> - a VelocityWriter that the template is merged into</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/VelocityView.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/velocity/tools/view/VelocityLayoutServlet.html" title="class in org.apache.velocity.tools.view"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/velocity/tools/view/VelocityViewFilter.html" title="class in org.apache.velocity.tools.view"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/velocity/tools/view/VelocityView.html" target="_top">Frames</a></li> |
| <li><a href="VelocityView.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2002–2018 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |