Google Git
Sign in
apache / velocity-site / 89c3a15cf30ab2c0dbdf8253ed5c2eb24d9b1e21 / . / tools / 3.0 / apidocs / org / apache / velocity / tools / view / ViewToolManager.html
blob: 09987aea6bc3d9a548cc239de2afc2fd7f45d701 [file] [log] [blame]
<!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_181) on Wed Oct 10 00:41:13 CEST 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ViewToolManager (VelocityTools 3.0 API)</title>
<meta name="date" content="2018-10-10">
<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="ViewToolManager (VelocityTools 3.0 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};
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/ViewToolManager.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/ViewToolContext.html" title="class in org.apache.velocity.tools.view"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/velocity/tools/view/WebappResourceLoader.html" title="class in org.apache.velocity.tools.view"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/velocity/tools/view/ViewToolManager.html" target="_top">Frames</a></li>
<li><a href="ViewToolManager.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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 ViewToolManager" class="title">Class ViewToolManager</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/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>org.apache.velocity.tools.view.ViewToolManager</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../org/apache/velocity/tools/view/VelocityView.html" title="class in org.apache.velocity.tools.view">VelocityView</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">ViewToolManager</span>
extends <a href="../../../../../org/apache/velocity/tools/ToolManager.html" title="class in org.apache.velocity.tools">ToolManager</a></pre>
<div class="block">Manages tools for web applications. This simplifies the process
of getting a tool-populated Velocity context for merging with templates.
It allows for both direct configuration by passing in a <a href="../../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config"><code>FactoryConfiguration</code></a>
or having one in the ServletContext attributes under
<a href="../../../../../org/apache/velocity/tools/view/ServletUtils.html#CONFIGURATION_KEY"><code>ServletUtils.CONFIGURATION_KEY</code></a>, as well as configuration
via a tools.xml or tools.properties file in
either the classpath or the local file system.</div>
<dl>
<dt><span class="simpleTagLabel">Version:</span></dt>
<dd>$Id: ToolManager.java 511959 2007-02-26 19:24:39Z nbubna $</dd>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>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">&nbsp;</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/8/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/ViewToolManager.html#CREATE_SESSION_PROPERTY">CREATE_SESSION_PROPERTY</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/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/ViewToolManager.html#DEFAULT_TOOLBOX_KEY">DEFAULT_TOOLBOX_KEY</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/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/ViewToolManager.html#PUBLISH_TOOLBOXES_PROPERTY">PUBLISH_TOOLBOXES_PROPERTY</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected javax.servlet.ServletContext</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/ViewToolManager.html#servletContext">servletContext</a></span></code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.velocity.tools.ToolManager">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;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">&nbsp;</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/ViewToolManager.html#ViewToolManager-javax.servlet.ServletContext-">ViewToolManager</a></span>(javax.servlet.ServletContext&nbsp;app)</code>
<div class="block">Constructs an instance already configured to use
any configuration specified via a "org.apache.velocity.tools"
system property.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/ViewToolManager.html#ViewToolManager-javax.servlet.ServletContext-boolean-">ViewToolManager</a></span>(javax.servlet.ServletContext&nbsp;app,
boolean&nbsp;includeDefaults)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/ViewToolManager.html#ViewToolManager-javax.servlet.ServletContext-boolean-boolean-">ViewToolManager</a></span>(javax.servlet.ServletContext&nbsp;app,
boolean&nbsp;autoConfig,
boolean&nbsp;includeDefaults)</code>&nbsp;</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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/ViewToolManager.html#addToolboxes-org.apache.velocity.tools.ToolContext-">addToolboxes</a></span>(<a href="../../../../../org/apache/velocity/tools/ToolContext.html" title="class in org.apache.velocity.tools">ToolContext</a>&nbsp;context)</code>
<div class="block">Add toolboxes to contex</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/ViewToolManager.html#autoConfigure-boolean-">autoConfigure</a></span>(boolean&nbsp;includeDefaults)</code>
<div class="block">Autoconfiguration using the configuration file potentially found
in the <code>org.apache.velocity.tools</code> system property.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/ViewToolManager.html#configure-org.apache.velocity.tools.config.FactoryConfiguration-">configure</a></span>(<a href="../../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config">FactoryConfiguration</a>&nbsp;config)</code>
<div class="block">Configure the tool manager with this toolbox factory config</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<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/ViewToolManager.html#createContext-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-">createContext</a></span>(javax.servlet.http.HttpServletRequest&nbsp;request,
javax.servlet.http.HttpServletResponse&nbsp;response)</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/velocity/tools/ToolContext.html" title="class in org.apache.velocity.tools">ToolContext</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/ViewToolManager.html#createContext-java.util.Map-">createContext</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&nbsp;toolProps)</code>
<div class="block">create new context with configured toolboxes tools,
using the provided tools properties</div>
</td>
</tr>
<tr id="i5" 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/ViewToolManager.html#findConfig-java.lang.String-">findConfig</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;path)</code>
<div class="block">Find a configuration file</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/ViewToolManager.html#getCreateSession--">getCreateSession</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/ViewToolManager.html#getPublishToolboxes--">getPublishToolboxes</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>protected <a href="../../../../../org/apache/velocity/tools/Toolbox.html" title="class in org.apache.velocity.tools">Toolbox</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/ViewToolManager.html#getSessionToolbox--">getSessionToolbox</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/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/ViewToolManager.html#getToolboxKey--">getToolboxKey</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/ViewToolManager.html#hasSessionTools--">hasSessionTools</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/ViewToolManager.html#prepareContext-org.apache.velocity.tools.view.ViewToolContext-javax.servlet.http.HttpServletRequest-">prepareContext</a></span>(<a href="../../../../../org/apache/velocity/tools/view/ViewToolContext.html" title="class in org.apache.velocity.tools.view">ViewToolContext</a>&nbsp;context,
javax.servlet.http.HttpServletRequest&nbsp;request)</code>&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/ViewToolManager.html#publishApplicationTools--">publishApplicationTools</a></span>()</code>
<div class="block">Publish <a href="../../../../../org/apache/velocity/tools/Scope.html#APPLICATION"><code>Scope.APPLICATION</code></a> Toolbox.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/ViewToolManager.html#publishToolboxes-javax.servlet.http.HttpServletRequest-">publishToolboxes</a></span>(javax.servlet.http.HttpServletRequest&nbsp;request)</code>
<div class="block">Places the <a href="../../../../../org/apache/velocity/tools/Scope.html#REQUEST"><code>Scope.REQUEST</code></a> <a href="../../../../../org/apache/velocity/tools/Toolbox.html" title="class in org.apache.velocity.tools"><code>Toolbox</code></a> (if any)
into the <code>HttpServletRequest</code> attributes using
<a href="../../../../../org/apache/velocity/tools/Toolbox.html#KEY"><code>Toolbox.KEY</code></a> as the key, places the <a href="../../../../../org/apache/velocity/tools/Scope.html#SESSION"><code>Scope.SESSION</code></a>
Toolbox (if any) into the attributes of the <code>HttpSession</code> (if any)
then ensures that the <a href="../../../../../org/apache/velocity/tools/Scope.html#APPLICATION"><code>Scope.APPLICATION</code></a> Toolbox (if any)
has been placed in the <code>ServletContext</code> attributes.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/ViewToolManager.html#publishToolboxes-javax.servlet.ServletRequest-">publishToolboxes</a></span>(javax.servlet.ServletRequest&nbsp;request)</code>
<div class="block">Places the <a href="../../../../../org/apache/velocity/tools/Scope.html#REQUEST"><code>Scope.REQUEST</code></a> <a href="../../../../../org/apache/velocity/tools/Toolbox.html" title="class in org.apache.velocity.tools"><code>Toolbox</code></a> (if any)
into the <code>ServletRequest</code> attributes using
<a href="../../../../../org/apache/velocity/tools/Toolbox.html#KEY"><code>Toolbox.KEY</code></a> as the key.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/ViewToolManager.html#setCreateSession-boolean-">setCreateSession</a></span>(boolean&nbsp;create)</code>
<div class="block">Sets whether or not a new HttpSession should be created
when there are session scoped tools to be stored in the session,
but no session has been created yet.</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/ViewToolManager.html#setPublishToolboxes-boolean-">setPublishToolboxes</a></span>(boolean&nbsp;publish)</code>
<div class="block">Sets whether or not the creation of a new <a href="../../../../../org/apache/velocity/tools/view/ViewToolContext.html" title="class in org.apache.velocity.tools.view"><code>ViewToolContext</code></a>
should make the various scoped <a href="../../../../../org/apache/velocity/tools/Toolbox.html" title="class in org.apache.velocity.tools"><code>Toolbox</code></a> instances available
publically via the HttpServletRequest/HttpSession/ServletContext
attributes or simply add the Toolbox instances directly to the
context.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/ViewToolManager.html#setToolboxKey-java.lang.String-">setToolboxKey</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;key)</code>
<div class="block">Sets a new attribute key to be used for publishing each <a href="../../../../../org/apache/velocity/tools/Toolbox.html" title="class in org.apache.velocity.tools"><code>Toolbox</code></a>.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/ViewToolManager.html#unpublishApplicationTools--">unpublishApplicationTools</a></span>()</code>
<div class="block">Removes any published <a href="../../../../../org/apache/velocity/tools/Scope.html#APPLICATION"><code>Scope.APPLICATION</code></a> Toolbox.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/ViewToolManager.html#updateGlobalProperties--">updateGlobalProperties</a></span>()</code>
<div class="block">Checks the internal <a href="../../../../../org/apache/velocity/tools/ToolboxFactory.html" title="class in org.apache.velocity.tools"><code>ToolboxFactory</code></a> for any changes to
the createSession or publishToolboxes settings.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.velocity.tools.ToolManager">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;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>, <a href="../../../../../org/apache/velocity/tools/ToolManager.html#setVelocityEngine-org.apache.velocity.app.VelocityEngine-">setVelocityEngine</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&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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="CREATE_SESSION_PROPERTY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CREATE_SESSION_PROPERTY</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> CREATE_SESSION_PROPERTY</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.velocity.tools.view.ViewToolManager.CREATE_SESSION_PROPERTY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="PUBLISH_TOOLBOXES_PROPERTY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PUBLISH_TOOLBOXES_PROPERTY</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> PUBLISH_TOOLBOXES_PROPERTY</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.velocity.tools.view.ViewToolManager.PUBLISH_TOOLBOXES_PROPERTY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DEFAULT_TOOLBOX_KEY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_TOOLBOX_KEY</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> DEFAULT_TOOLBOX_KEY</pre>
</li>
</ul>
<a name="servletContext">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>servletContext</h4>
<pre>protected&nbsp;javax.servlet.ServletContext servletContext</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="ViewToolManager-javax.servlet.ServletContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ViewToolManager</h4>
<pre>public&nbsp;ViewToolManager(javax.servlet.ServletContext&nbsp;app)</pre>
<div class="block">Constructs an instance already configured to use
any configuration specified via a "org.apache.velocity.tools"
system property.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>app</code> - servlet context</dd>
</dl>
</li>
</ul>
<a name="ViewToolManager-javax.servlet.ServletContext-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ViewToolManager</h4>
<pre>public&nbsp;ViewToolManager(javax.servlet.ServletContext&nbsp;app,
boolean&nbsp;includeDefaults)</pre>
</li>
</ul>
<a name="ViewToolManager-javax.servlet.ServletContext-boolean-boolean-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ViewToolManager</h4>
<pre>public&nbsp;ViewToolManager(javax.servlet.ServletContext&nbsp;app,
boolean&nbsp;autoConfig,
boolean&nbsp;includeDefaults)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="autoConfigure-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>autoConfigure</h4>
<pre>public&nbsp;void&nbsp;autoConfigure(boolean&nbsp;includeDefaults)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/velocity/tools/ToolManager.html#autoConfigure-boolean-">ToolManager</a></code></span></div>
<div class="block">Autoconfiguration using the configuration file potentially found
in the <code>org.apache.velocity.tools</code> system property.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/velocity/tools/ToolManager.html#autoConfigure-boolean-">autoConfigure</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/velocity/tools/ToolManager.html" title="class in org.apache.velocity.tools">ToolManager</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>includeDefaults</code> - whether to include default tools</dd>
</dl>
</li>
</ul>
<a name="setPublishToolboxes-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPublishToolboxes</h4>
<pre>public&nbsp;void&nbsp;setPublishToolboxes(boolean&nbsp;publish)</pre>
<div class="block">Sets whether or not the creation of a new <a href="../../../../../org/apache/velocity/tools/view/ViewToolContext.html" title="class in org.apache.velocity.tools.view"><code>ViewToolContext</code></a>
should make the various scoped <a href="../../../../../org/apache/velocity/tools/Toolbox.html" title="class in org.apache.velocity.tools"><code>Toolbox</code></a> instances available
publically via the HttpServletRequest/HttpSession/ServletContext
attributes or simply add the Toolbox instances directly to the
context. <b>It is important to note that if this is set to false,
session-scoped tools will NOT be stored in the session, but instead
be recreated for each request.</b></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>publish</code> - whether to publish the available toolboxes</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/velocity/tools/view/ViewToolManager.html#publishToolboxes"><code>publishToolboxes</code></a>,
<a href="../../../../../org/apache/velocity/tools/view/ViewToolManager.html#setToolboxKey-java.lang.String-"><code>setToolboxKey(java.lang.String)</code></a></dd>
</dl>
</li>
</ul>
<a name="getPublishToolboxes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPublishToolboxes</h4>
<pre>public&nbsp;boolean&nbsp;getPublishToolboxes()</pre>
</li>
</ul>
<a name="setToolboxKey-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setToolboxKey</h4>
<pre>public&nbsp;void&nbsp;setToolboxKey(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;key)</pre>
<div class="block">Sets a new attribute key to be used for publishing each <a href="../../../../../org/apache/velocity/tools/Toolbox.html" title="class in org.apache.velocity.tools"><code>Toolbox</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - toolbox key</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/velocity/tools/view/ViewToolManager.html#setPublishToolboxes-boolean-"><code>setPublishToolboxes(boolean)</code></a>,
<a href="../../../../../org/apache/velocity/tools/view/ViewToolManager.html#publishToolboxes"><code>publishToolboxes</code></a></dd>
</dl>
</li>
</ul>
<a name="getToolboxKey--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getToolboxKey</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getToolboxKey()</pre>
</li>
</ul>
<a name="setCreateSession-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCreateSession</h4>
<pre>public&nbsp;void&nbsp;setCreateSession(boolean&nbsp;create)</pre>
<div class="block">Sets whether or not a new HttpSession should be created
when there are session scoped tools to be stored in the session,
but no session has been created yet.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>create</code> - whether to create a new session if needed</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/velocity/tools/view/ViewToolManager.html#publishToolboxes"><code>publishToolboxes</code></a></dd>
</dl>
</li>
</ul>
<a name="getCreateSession--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCreateSession</h4>
<pre>public&nbsp;boolean&nbsp;getCreateSession()</pre>
</li>
</ul>
<a name="updateGlobalProperties--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateGlobalProperties</h4>
<pre>protected&nbsp;void&nbsp;updateGlobalProperties()</pre>
<div class="block">Checks the internal <a href="../../../../../org/apache/velocity/tools/ToolboxFactory.html" title="class in org.apache.velocity.tools"><code>ToolboxFactory</code></a> for any changes to
the createSession or publishToolboxes settings.</div>
</li>
</ul>
<a name="publishApplicationTools--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>publishApplicationTools</h4>
<pre>protected&nbsp;void&nbsp;publishApplicationTools()</pre>
<div class="block">Publish <a href="../../../../../org/apache/velocity/tools/Scope.html#APPLICATION"><code>Scope.APPLICATION</code></a> Toolbox.</div>
</li>
</ul>
<a name="unpublishApplicationTools--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>unpublishApplicationTools</h4>
<pre>protected&nbsp;void&nbsp;unpublishApplicationTools()</pre>
<div class="block">Removes any published <a href="../../../../../org/apache/velocity/tools/Scope.html#APPLICATION"><code>Scope.APPLICATION</code></a> Toolbox.</div>
</li>
</ul>
<a name="configure-org.apache.velocity.tools.config.FactoryConfiguration-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>configure</h4>
<pre>public&nbsp;void&nbsp;configure(<a href="../../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config">FactoryConfiguration</a>&nbsp;config)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/velocity/tools/ToolManager.html#configure-org.apache.velocity.tools.config.FactoryConfiguration-">ToolManager</a></code></span></div>
<div class="block">Configure the tool manager with this toolbox factory config</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/velocity/tools/ToolManager.html#configure-org.apache.velocity.tools.config.FactoryConfiguration-">configure</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/velocity/tools/ToolManager.html" title="class in org.apache.velocity.tools">ToolManager</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>config</code> - toolbox factory config</dd>
</dl>
</li>
</ul>
<a name="findConfig-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>findConfig</h4>
<pre>protected&nbsp;<a href="../../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config">FactoryConfiguration</a>&nbsp;findConfig(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;path)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/velocity/tools/ToolManager.html#findConfig-java.lang.String-">ToolManager</a></code></span></div>
<div class="block">Find a configuration file</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/velocity/tools/ToolManager.html#findConfig-java.lang.String-">findConfig</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/velocity/tools/ToolManager.html" title="class in org.apache.velocity.tools">ToolManager</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>path</code> - path to a configuration file</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>toolbox factory configuration</dd>
</dl>
</li>
</ul>
<a name="addToolboxes-org.apache.velocity.tools.ToolContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addToolboxes</h4>
<pre>protected&nbsp;void&nbsp;addToolboxes(<a href="../../../../../org/apache/velocity/tools/ToolContext.html" title="class in org.apache.velocity.tools">ToolContext</a>&nbsp;context)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/velocity/tools/ToolManager.html#addToolboxes-org.apache.velocity.tools.ToolContext-">ToolManager</a></code></span></div>
<div class="block">Add toolboxes to contex</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/velocity/tools/ToolManager.html#addToolboxes-org.apache.velocity.tools.ToolContext-">addToolboxes</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/velocity/tools/ToolManager.html" title="class in org.apache.velocity.tools">ToolManager</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - context</dd>
</dl>
</li>
</ul>
<a name="createContext-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createContext</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/velocity/tools/ToolContext.html" title="class in org.apache.velocity.tools">ToolContext</a>&nbsp;createContext(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&nbsp;toolProps)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/velocity/tools/ToolManager.html#createContext-java.util.Map-">ToolManager</a></code></span></div>
<div class="block">create new context with configured toolboxes tools,
using the provided tools properties</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/velocity/tools/ToolManager.html#createContext-java.util.Map-">createContext</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/velocity/tools/ToolManager.html" title="class in org.apache.velocity.tools">ToolManager</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>toolProps</code> - tools properties</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>newly created context</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&nbsp;<a href="../../../../../org/apache/velocity/tools/view/ViewToolContext.html" title="class in org.apache.velocity.tools.view">ViewToolContext</a>&nbsp;createContext(javax.servlet.http.HttpServletRequest&nbsp;request,
javax.servlet.http.HttpServletResponse&nbsp;response)</pre>
</li>
</ul>
<a name="prepareContext-org.apache.velocity.tools.view.ViewToolContext-javax.servlet.http.HttpServletRequest-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>prepareContext</h4>
<pre>public&nbsp;void&nbsp;prepareContext(<a href="../../../../../org/apache/velocity/tools/view/ViewToolContext.html" title="class in org.apache.velocity.tools.view">ViewToolContext</a>&nbsp;context,
javax.servlet.http.HttpServletRequest&nbsp;request)</pre>
</li>
</ul>
<a name="hasSessionTools--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasSessionTools</h4>
<pre>protected&nbsp;boolean&nbsp;hasSessionTools()</pre>
</li>
</ul>
<a name="getSessionToolbox--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSessionToolbox</h4>
<pre>protected&nbsp;<a href="../../../../../org/apache/velocity/tools/Toolbox.html" title="class in org.apache.velocity.tools">Toolbox</a>&nbsp;getSessionToolbox()</pre>
</li>
</ul>
<a name="publishToolboxes-javax.servlet.ServletRequest-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>publishToolboxes</h4>
<pre>public&nbsp;void&nbsp;publishToolboxes(javax.servlet.ServletRequest&nbsp;request)</pre>
<div class="block">Places the <a href="../../../../../org/apache/velocity/tools/Scope.html#REQUEST"><code>Scope.REQUEST</code></a> <a href="../../../../../org/apache/velocity/tools/Toolbox.html" title="class in org.apache.velocity.tools"><code>Toolbox</code></a> (if any)
into the <code>ServletRequest</code> attributes using
<a href="../../../../../org/apache/velocity/tools/Toolbox.html#KEY"><code>Toolbox.KEY</code></a> as the key.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>request</code> - servlet request</dd>
</dl>
</li>
</ul>
<a name="publishToolboxes-javax.servlet.http.HttpServletRequest-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>publishToolboxes</h4>
<pre>public&nbsp;void&nbsp;publishToolboxes(javax.servlet.http.HttpServletRequest&nbsp;request)</pre>
<div class="block">Places the <a href="../../../../../org/apache/velocity/tools/Scope.html#REQUEST"><code>Scope.REQUEST</code></a> <a href="../../../../../org/apache/velocity/tools/Toolbox.html" title="class in org.apache.velocity.tools"><code>Toolbox</code></a> (if any)
into the <code>HttpServletRequest</code> attributes using
<a href="../../../../../org/apache/velocity/tools/Toolbox.html#KEY"><code>Toolbox.KEY</code></a> as the key, places the <a href="../../../../../org/apache/velocity/tools/Scope.html#SESSION"><code>Scope.SESSION</code></a>
Toolbox (if any) into the attributes of the <code>HttpSession</code> (if any)
then ensures that the <a href="../../../../../org/apache/velocity/tools/Scope.html#APPLICATION"><code>Scope.APPLICATION</code></a> Toolbox (if any)
has been placed in the <code>ServletContext</code> attributes.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>request</code> - servlet request</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/ViewToolManager.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/ViewToolContext.html" title="class in org.apache.velocity.tools.view"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/velocity/tools/view/WebappResourceLoader.html" title="class in org.apache.velocity.tools.view"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/velocity/tools/view/ViewToolManager.html" target="_top">Frames</a></li>
<li><a href="ViewToolManager.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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 &#169; 2002&#x2013;2018 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>