blob: c655301bf1f2059c8c66db378d24f9cc6b0c3569 [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>org.apache.velocity.tools.view (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="org.apache.velocity.tools.view (VelocityTools 3.0 API)";
}
}
catch(err) {
}
//-->
</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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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/generic/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../org/apache/velocity/tools/view/jsp/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/velocity/tools/view/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.velocity.tools.view</h1>
<div class="docSummary">
<div class="block">Contains tools and supporting infrastructure for using
those tools in a servlet environment as well as general
use classes to support use of Velocity as (or in) the
view layer of web applications.</div>
</div>
<p>See:&nbsp;<a href="#package.description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/velocity/tools/view/JeeConfig.html" title="interface in org.apache.velocity.tools.view">JeeConfig</a></td>
<td class="colLast">
<div class="block">Because sometimes you don't care about the difference between a
servlet and a filter.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/velocity/tools/view/ViewContext.html" title="interface in org.apache.velocity.tools.view">ViewContext</a></td>
<td class="colLast">
<div class="block">This interface provides view tools in a servlet environment
access to relevant context information, like servlet request, servlet
context and the velocity context.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/velocity/tools/view/AbstractSearchTool.html" title="class in org.apache.velocity.tools.view">AbstractSearchTool</a></td>
<td class="colLast">
<div class="block">Abstract view tool for doing "searching" and robust
pagination of search results.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/velocity/tools/view/AbstractSearchTool.StoredResults.html" title="class in org.apache.velocity.tools.view">AbstractSearchTool.StoredResults</a></td>
<td class="colLast">
<div class="block">Simple utility class to hold a criterion and its result list.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/velocity/tools/view/BrowserTool.html" title="class in org.apache.velocity.tools.view">BrowserTool</a></td>
<td class="colLast">
<div class="block">Browser sniffing tool (session or request scope requested, session scope advised).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/velocity/tools/view/BrowserToolDeprecatedMethods.html" title="class in org.apache.velocity.tools.view">BrowserToolDeprecatedMethods</a></td>
<td class="colLast">Deprecated</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/velocity/tools/view/CookieTool.html" title="class in org.apache.velocity.tools.view">CookieTool</a></td>
<td class="colLast">
<div class="block">View tool for convenient cookie access and creation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/velocity/tools/view/CookieTool.SugarCookie.html" title="class in org.apache.velocity.tools.view">CookieTool.SugarCookie</a></td>
<td class="colLast">
<div class="block">Extends <code>Cookie</code> to add some fluid API sugar and
a toString() method that renders the Cookie's value
instead of the usual Object.toString() shenanigans.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/velocity/tools/view/ImportTool.html" title="class in org.apache.velocity.tools.view">ImportTool</a></td>
<td class="colLast">
<div class="block">General-purpose text-importing view tool for templates.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/velocity/tools/view/IncludeTool.html" title="class in org.apache.velocity.tools.view">IncludeTool</a></td>
<td class="colLast">
<div class="block">Allows for transparent content negotiation in a manner mimicking
Apache httpd's <a
href="http://httpd.apache.org/docs-2.0/content-negotiation.html">MultiViews</a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/velocity/tools/view/JeeContextConfig.html" title="class in org.apache.velocity.tools.view">JeeContextConfig</a></td>
<td class="colLast">
<div class="block">Implements <a href="../../../../../org/apache/velocity/tools/view/JeeConfig.html" title="interface in org.apache.velocity.tools.view"><code>JeeConfig</code></a> with only a <code>ServletContext</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/velocity/tools/view/JeeFilterConfig.html" title="class in org.apache.velocity.tools.view">JeeFilterConfig</a></td>
<td class="colLast">
<div class="block">Implements <a href="../../../../../org/apache/velocity/tools/view/JeeConfig.html" title="interface in org.apache.velocity.tools.view"><code>JeeConfig</code></a> with a <code>FilterConfig</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/velocity/tools/view/JeeServletConfig.html" title="class in org.apache.velocity.tools.view">JeeServletConfig</a></td>
<td class="colLast">
<div class="block">Implements <a href="../../../../../org/apache/velocity/tools/view/JeeConfig.html" title="interface in org.apache.velocity.tools.view"><code>JeeConfig</code></a> with a <code>ServletConfig</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/velocity/tools/view/JsonTool.html" title="class in org.apache.velocity.tools.view">JsonTool</a></td>
<td class="colLast">
<div class="block">View version of <a href="../../../../../org/apache/velocity/tools/generic/JsonTool.html" title="class in org.apache.velocity.tools.generic"><code>JsonTool</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/velocity/tools/view/LinkTool.html" title="class in org.apache.velocity.tools.view">LinkTool</a></td>
<td class="colLast">
<div class="block">The LinkTool provides many methods to work with URIs and can help you:
construct full URIs (absolute or relative)
encode session ID into a URI
retrieve server, port and path info for the current request
reconstruct or alter the current request URI
and more..
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/velocity/tools/view/PagerTool.html" title="class in org.apache.velocity.tools.view">PagerTool</a></td>
<td class="colLast">
<div class="block">View tool for doing request-based pagination of
items in an a list.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/velocity/tools/view/ParameterTool.html" title="class in org.apache.velocity.tools.view">ParameterTool</a></td>
<td class="colLast">
<div class="block">Utility class for easy parsing of <code>ServletRequest</code> parameters.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/velocity/tools/view/ServletUtils.html" title="class in org.apache.velocity.tools.view">ServletUtils</a></td>
<td class="colLast">
<div class="block">A set of utility methods for supporting and using
VelocityTools in the servlet environment.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/velocity/tools/view/UAParser.html" title="class in org.apache.velocity.tools.view">UAParser</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/velocity/tools/view/UAParser.UAEntity.html" title="class in org.apache.velocity.tools.view">UAParser.UAEntity</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/velocity/tools/view/UAParser.UserAgent.html" title="class in org.apache.velocity.tools.view">UAParser.UserAgent</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/velocity/tools/view/UiDependencyTool.html" title="class in org.apache.velocity.tools.view">UiDependencyTool</a></td>
<td class="colLast">
<div class="block"><b>NOTE: This tool is considered "beta" quality due to lack of public testing
and is not automatically provided via the default tools.xml file.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/velocity/tools/view/UiDependencyTool.FileRule.html" title="class in org.apache.velocity.tools.view">UiDependencyTool.FileRule</a></td>
<td class="colLast">
<div class="block">NOTE: This class may change or disappear w/o warning; don't depend
on it unless you're willing to update your code whenever this changes.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/velocity/tools/view/UiDependencyTool.GroupRule.html" title="class in org.apache.velocity.tools.view">UiDependencyTool.GroupRule</a></td>
<td class="colLast">
<div class="block">NOTE: This class may change or disappear w/o warning; don't depend
on it unless you're willing to update your code whenever this changes.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/velocity/tools/view/UiDependencyTool.NeedsRule.html" title="class in org.apache.velocity.tools.view">UiDependencyTool.NeedsRule</a></td>
<td class="colLast">
<div class="block">NOTE: This class may change or disappear w/o warning; don't depend
on it unless you're willing to update your code whenever this changes.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/velocity/tools/view/UiDependencyTool.TypeRule.html" title="class in org.apache.velocity.tools.view">UiDependencyTool.TypeRule</a></td>
<td class="colLast">
<div class="block">NOTE: This class may change or disappear w/o warning; don't depend
on it unless you're willing to update your code whenever this changes.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/velocity/tools/view/VelocityLayoutServlet.html" title="class in org.apache.velocity.tools.view">VelocityLayoutServlet</a></td>
<td class="colLast">
<div class="block">Extension of the VelocityViewServlet to perform "two-pass"
layout rendering and allow for a customized error screen.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/velocity/tools/view/VelocityView.html" title="class in org.apache.velocity.tools.view">VelocityView</a></td>
<td class="colLast">
<div class="block">The class provides the following features:</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/velocity/tools/view/VelocityViewFilter.html" title="class in org.apache.velocity.tools.view">VelocityViewFilter</a></td>
<td class="colLast">
<div class="block">A filter to ensure VelocityTools <a href="../../../../../org/apache/velocity/tools/Toolbox.html" title="class in org.apache.velocity.tools"><code>Toolbox</code></a>es are
available in the request/session/application scopes.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/velocity/tools/view/VelocityViewServlet.html" title="class in org.apache.velocity.tools.view">VelocityViewServlet</a></td>
<td class="colLast">
<div class="block">A servlet to process Velocity templates.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/velocity/tools/view/ViewContextTool.html" title="class in org.apache.velocity.tools.view">ViewContextTool</a></td>
<td class="colLast">
<div class="block">Extension of <a href="../../../../../org/apache/velocity/tools/generic/ContextTool.html" title="class in org.apache.velocity.tools.generic"><code>ContextTool</code></a> that includes keys and values
from the <code>HttpServletRequest</code>, <code>HttpSession</code> and
<code>ServletContext</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/velocity/tools/view/ViewImportSupport.html" title="class in org.apache.velocity.tools.view">ViewImportSupport</a></td>
<td class="colLast">
<div class="block">Provides methods to import arbitrary local or remote resources as strings.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/velocity/tools/view/ViewImportSupport.ImportResponseWrapper.html" title="class in org.apache.velocity.tools.view">ViewImportSupport.ImportResponseWrapper</a></td>
<td class="colLast">
<div class="block">Wraps responses to allow us to retrieve results as Strings.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/velocity/tools/view/ViewImportSupport.SafeClosingHttpURLConnectionReader.html" title="class in org.apache.velocity.tools.view">ViewImportSupport.SafeClosingHttpURLConnectionReader</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/velocity/tools/view/ViewToolContext.html" title="class in org.apache.velocity.tools.view">ViewToolContext</a></td>
<td class="colLast">
<div class="block"><a href="../../../../../org/apache/velocity/tools/ToolContext.html" title="class in org.apache.velocity.tools"><code>ToolContext</code></a> implementation specific to the servlet environment.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/velocity/tools/view/ViewToolManager.html" title="class in org.apache.velocity.tools.view">ViewToolManager</a></td>
<td class="colLast">
<div class="block">Manages tools for web applications.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/velocity/tools/view/WebappResourceLoader.html" title="class in org.apache.velocity.tools.view">WebappResourceLoader</a></td>
<td class="colLast">
<div class="block">Resource loader that uses the ServletContext of a webapp to
load Velocity templates.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/velocity/tools/view/WebappUberspector.html" title="class in org.apache.velocity.tools.view">WebappUberspector</a></td>
<td class="colLast">
<div class="block">This custom uberspector allows getAttribute() and setAttribute() as standard
getters and setters for the "request","session" and "application" keys.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/velocity/tools/view/XmlTool.html" title="class in org.apache.velocity.tools.view">XmlTool</a></td>
<td class="colLast">
<div class="block">View version of <a href="../../../../../org/apache/velocity/tools/generic/XmlTool.html" title="class in org.apache.velocity.tools.generic"><code>XmlTool</code></a>.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation">
<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/velocity/tools/view/UAParser.DeviceType.html" title="enum in org.apache.velocity.tools.view">UAParser.DeviceType</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.velocity.tools.view Description">Package org.apache.velocity.tools.view Description</h2>
<div class="block">Contains tools and supporting infrastructure for using
those tools in a servlet environment as well as general
use classes to support use of Velocity as (or in) the
view layer of web applications.
<!--
##### THIS IS THE TEMPLATE FOR THE PACKAGE DOC COMMENTS. #####
##### TYPE YOUR PACKAGE COMMENTS HERE. BEGIN WITH A #####
##### ONE-SENTENCE SUMMARY STARTING WITH A VERB LIKE: #####
Provides for....
-->
<h2>Package Specification</h2>
<!--
##### FILL IN ANY SPECS NEEDED BY JAVA COMPATIBILITY KIT #####
<ul>
<li><a href="">##### REFER TO ANY FRAMEMAKER SPECIFICATION HERE #####</a>
</ul>
-->
<h2>Related Documentation</h2>
<!--
For overviews, tutorials, examples, guides, and tool documentation, please see:
<ul>
<li><a href="">##### REFER TO NON-SPEC DOCUMENTATION HERE #####</a>
</ul>
-->
<!-- Put @see and @since tags down here. --></div>
</div>
<!-- ======= 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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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/generic/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../org/apache/velocity/tools/view/jsp/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/velocity/tools/view/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<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>