blob: 27201f986432c9134025e9f1b7543a6fe92064c4 [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>VelocityLayoutServlet (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="VelocityLayoutServlet (VelocityTools 3.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":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/VelocityLayoutServlet.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/UiDependencyTool.TypeRule.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/VelocityView.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/VelocityLayoutServlet.html" target="_top">Frames</a></li>
<li><a href="VelocityLayoutServlet.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 VelocityLayoutServlet" class="title">Class VelocityLayoutServlet</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>javax.servlet.GenericServlet</li>
<li>
<ul class="inheritance">
<li>javax.servlet.http.HttpServlet</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/velocity/tools/view/VelocityViewServlet.html" title="class in org.apache.velocity.tools.view">org.apache.velocity.tools.view.VelocityViewServlet</a></li>
<li>
<ul class="inheritance">
<li>org.apache.velocity.tools.view.VelocityLayoutServlet</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, javax.servlet.Servlet, javax.servlet.ServletConfig</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">VelocityLayoutServlet</span>
extends <a href="../../../../../org/apache/velocity/tools/view/VelocityViewServlet.html" title="class in org.apache.velocity.tools.view">VelocityViewServlet</a></pre>
<div class="block">Extension of the VelocityViewServlet to perform "two-pass"
layout rendering and allow for a customized error screen.</div>
<dl>
<dt><span class="simpleTagLabel">Version:</span></dt>
<dd>$Id: VelocityLayoutServlet.java 1842523 2018-10-01 17:27:15Z cbrisson $</dd>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Nathan Bubna</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../serialized-form.html#org.apache.velocity.tools.view.VelocityLayoutServlet">Serialized Form</a></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/VelocityLayoutServlet.html#DEFAULT_DEFAULT_LAYOUT">DEFAULT_DEFAULT_LAYOUT</a></span></code>
<div class="block">The default filename for the servlet's default layout</div>
</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/VelocityLayoutServlet.html#DEFAULT_ERROR_TEMPLATE">DEFAULT_ERROR_TEMPLATE</a></span></code>
<div class="block">The default error template's filename.</div>
</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/VelocityLayoutServlet.html#DEFAULT_LAYOUT_DIR">DEFAULT_LAYOUT_DIR</a></span></code>
<div class="block">The default layout directory</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <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/VelocityLayoutServlet.html#defaultLayout">defaultLayout</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <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/VelocityLayoutServlet.html#errorTemplate">errorTemplate</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/VelocityLayoutServlet.html#KEY_ERROR_CAUSE">KEY_ERROR_CAUSE</a></span></code>
<div class="block">The context key that holds the <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang"><code>Throwable</code></a> that
broke the rendering of the requested screen.</div>
</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/VelocityLayoutServlet.html#KEY_ERROR_INVOCATION_EXCEPTION">KEY_ERROR_INVOCATION_EXCEPTION</a></span></code>
<div class="block">The context key that holds the <code>MethodInvocationException</code>
that broke the rendering of the requested screen.</div>
</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/VelocityLayoutServlet.html#KEY_ERROR_STACKTRACE">KEY_ERROR_STACKTRACE</a></span></code>
<div class="block">The context key that holds the stack trace of the error that
broke the rendering of the requested screen.</div>
</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/VelocityLayoutServlet.html#KEY_LAYOUT">KEY_LAYOUT</a></span></code>
<div class="block">The context/parameter key used to specify an alternate
layout to be used for a request instead of the default layout.</div>
</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/VelocityLayoutServlet.html#KEY_SCREEN_CONTENT">KEY_SCREEN_CONTENT</a></span></code>
<div class="block">The context key that will hold the content of the screen.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <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/VelocityLayoutServlet.html#layoutDir">layoutDir</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/VelocityLayoutServlet.html#PROPERTY_DEFAULT_LAYOUT">PROPERTY_DEFAULT_LAYOUT</a></span></code>
<div class="block">The velocity.properties key for specifying the
servlet's default layout template's filename.</div>
</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/VelocityLayoutServlet.html#PROPERTY_DYNAMIC_LAYOUT">PROPERTY_DYNAMIC_LAYOUT</a></span></code>
<div class="block">The velocity.properties key for specifying
whether dynamic layout change is allowed</div>
</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/VelocityLayoutServlet.html#PROPERTY_ERROR_TEMPLATE">PROPERTY_ERROR_TEMPLATE</a></span></code>
<div class="block">The velocity.properties key for specifying the
servlet's error template.</div>
</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/VelocityLayoutServlet.html#PROPERTY_LAYOUT_DIR">PROPERTY_LAYOUT_DIR</a></span></code>
<div class="block">The velocity.properties key for specifying the
relative directory holding layout templates.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.velocity.tools.view.VelocityViewServlet">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.velocity.tools.view.<a href="../../../../../org/apache/velocity/tools/view/VelocityViewServlet.html" title="class in org.apache.velocity.tools.view">VelocityViewServlet</a></h3>
<code><a href="../../../../../org/apache/velocity/tools/view/VelocityViewServlet.html#BUFFER_OUTPUT_PARAM">BUFFER_OUTPUT_PARAM</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/VelocityLayoutServlet.html#VelocityLayoutServlet--">VelocityLayoutServlet</a></span>()</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/VelocityLayoutServlet.html#error-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-java.lang.Throwable-">error</a></span>(javax.servlet.http.HttpServletRequest&nbsp;request,
javax.servlet.http.HttpServletResponse&nbsp;response,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a>&nbsp;e)</code>
<div class="block">Overrides VelocityViewServlet to display user's custom error template</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/VelocityLayoutServlet.html#fillContext-org.apache.velocity.context.Context-javax.servlet.http.HttpServletRequest-">fillContext</a></span>(org.apache.velocity.context.Context&nbsp;ctx,
javax.servlet.http.HttpServletRequest&nbsp;request)</code>
<div class="block">Overrides VelocityViewServlet to check the request for
an alternate layout</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected <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/VelocityLayoutServlet.html#findLayout-javax.servlet.http.HttpServletRequest-">findLayout</a></span>(javax.servlet.http.HttpServletRequest&nbsp;request)</code>
<div class="block">Searches for a non-default layout to be used for this request.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/VelocityLayoutServlet.html#init-javax.servlet.ServletConfig-">init</a></span>(javax.servlet.ServletConfig&nbsp;config)</code>
<div class="block">Initializes Velocity, the view servlet and checks for changes to
the initial layout configuration.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/velocity/tools/view/VelocityLayoutServlet.html#mergeTemplate-org.apache.velocity.Template-org.apache.velocity.context.Context-javax.servlet.http.HttpServletResponse-">mergeTemplate</a></span>(org.apache.velocity.Template&nbsp;template,
org.apache.velocity.context.Context&nbsp;context,
javax.servlet.http.HttpServletResponse&nbsp;response)</code>
<div class="block">Overrides VelocityViewServlet.mergeTemplate to do a two-pass
render for handling layouts</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.velocity.tools.view.VelocityViewServlet">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.velocity.tools.view.<a href="../../../../../org/apache/velocity/tools/view/VelocityViewServlet.html" title="class in org.apache.velocity.tools.view">VelocityViewServlet</a></h3>
<code><a href="../../../../../org/apache/velocity/tools/view/VelocityViewServlet.html#createContext-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-">createContext</a>, <a href="../../../../../org/apache/velocity/tools/view/VelocityViewServlet.html#doGet-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-">doGet</a>, <a href="../../../../../org/apache/velocity/tools/view/VelocityViewServlet.html#doPost-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-">doPost</a>, <a href="../../../../../org/apache/velocity/tools/view/VelocityViewServlet.html#doRequest-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-">doRequest</a>, <a href="../../../../../org/apache/velocity/tools/view/VelocityViewServlet.html#findInitParameter-javax.servlet.ServletConfig-java.lang.String-">findInitParameter</a>, <a href="../../../../../org/apache/velocity/tools/view/VelocityViewServlet.html#getLog--">getLog</a>, <a href="../../../../../org/apache/velocity/tools/view/VelocityViewServlet.html#getTemplate-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-">getTemplate</a>, <a href="../../../../../org/apache/velocity/tools/view/VelocityViewServlet.html#getTemplate-java.lang.String-">getTemplate</a>, <a href="../../../../../org/apache/velocity/tools/view/VelocityViewServlet.html#getVelocityProperty-java.lang.String-java.lang.String-">getVelocityProperty</a>, <a href="../../../../../org/apache/velocity/tools/view/VelocityViewServlet.html#getVelocityView--">getVelocityView</a>, <a href="../../../../../org/apache/velocity/tools/view/VelocityViewServlet.html#handleRequest-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-org.apache.velocity.context.Context-">handleRequest</a>, <a href="../../../../../org/apache/velocity/tools/view/VelocityViewServlet.html#initRequest-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-">initRequest</a>, <a href="../../../../../org/apache/velocity/tools/view/VelocityViewServlet.html#manageResourceNotFound-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-org.apache.velocity.exception.ResourceNotFoundException-">manageResourceNotFound</a>, <a href="../../../../../org/apache/velocity/tools/view/VelocityViewServlet.html#requestCleanup-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-org.apache.velocity.context.Context-">requestCleanup</a>, <a href="../../../../../org/apache/velocity/tools/view/VelocityViewServlet.html#setContentType-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-">setContentType</a>, <a href="../../../../../org/apache/velocity/tools/view/VelocityViewServlet.html#setVelocityView-org.apache.velocity.tools.view.VelocityView-">setVelocityView</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.javax.servlet.http.HttpServlet">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;javax.servlet.http.HttpServlet</h3>
<code>doDelete, doHead, doOptions, doPut, doTrace, getLastModified, service, service</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.javax.servlet.GenericServlet">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;javax.servlet.GenericServlet</h3>
<code>destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log</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="PROPERTY_ERROR_TEMPLATE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PROPERTY_ERROR_TEMPLATE</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> PROPERTY_ERROR_TEMPLATE</pre>
<div class="block">The velocity.properties key for specifying the
servlet's error template.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.velocity.tools.view.VelocityLayoutServlet.PROPERTY_ERROR_TEMPLATE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="PROPERTY_LAYOUT_DIR">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PROPERTY_LAYOUT_DIR</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> PROPERTY_LAYOUT_DIR</pre>
<div class="block">The velocity.properties key for specifying the
relative directory holding layout templates.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.velocity.tools.view.VelocityLayoutServlet.PROPERTY_LAYOUT_DIR">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="PROPERTY_DEFAULT_LAYOUT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PROPERTY_DEFAULT_LAYOUT</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> PROPERTY_DEFAULT_LAYOUT</pre>
<div class="block">The velocity.properties key for specifying the
servlet's default layout template's filename.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.velocity.tools.view.VelocityLayoutServlet.PROPERTY_DEFAULT_LAYOUT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DEFAULT_ERROR_TEMPLATE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_ERROR_TEMPLATE</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_ERROR_TEMPLATE</pre>
<div class="block">The default error template's filename.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.velocity.tools.view.VelocityLayoutServlet.DEFAULT_ERROR_TEMPLATE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DEFAULT_LAYOUT_DIR">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_LAYOUT_DIR</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_LAYOUT_DIR</pre>
<div class="block">The default layout directory</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.velocity.tools.view.VelocityLayoutServlet.DEFAULT_LAYOUT_DIR">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DEFAULT_DEFAULT_LAYOUT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_DEFAULT_LAYOUT</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_DEFAULT_LAYOUT</pre>
<div class="block">The default filename for the servlet's default layout</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.velocity.tools.view.VelocityLayoutServlet.DEFAULT_DEFAULT_LAYOUT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="KEY_SCREEN_CONTENT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>KEY_SCREEN_CONTENT</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> KEY_SCREEN_CONTENT</pre>
<div class="block">The context key that will hold the content of the screen.
This key ($screen_content) must be present in the layout
template for the current screen to be rendered.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.velocity.tools.view.VelocityLayoutServlet.KEY_SCREEN_CONTENT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="KEY_LAYOUT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>KEY_LAYOUT</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> KEY_LAYOUT</pre>
<div class="block">The context/parameter key used to specify an alternate
layout to be used for a request instead of the default layout.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.velocity.tools.view.VelocityLayoutServlet.KEY_LAYOUT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="KEY_ERROR_CAUSE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>KEY_ERROR_CAUSE</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> KEY_ERROR_CAUSE</pre>
<div class="block">The context key that holds the <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang"><code>Throwable</code></a> that
broke the rendering of the requested screen.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.velocity.tools.view.VelocityLayoutServlet.KEY_ERROR_CAUSE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="KEY_ERROR_STACKTRACE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>KEY_ERROR_STACKTRACE</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> KEY_ERROR_STACKTRACE</pre>
<div class="block">The context key that holds the stack trace of the error that
broke the rendering of the requested screen.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.velocity.tools.view.VelocityLayoutServlet.KEY_ERROR_STACKTRACE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="KEY_ERROR_INVOCATION_EXCEPTION">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>KEY_ERROR_INVOCATION_EXCEPTION</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> KEY_ERROR_INVOCATION_EXCEPTION</pre>
<div class="block">The context key that holds the <code>MethodInvocationException</code>
that broke the rendering of the requested screen.
If this value is placed in the context, then $error_cause
will hold the error that this invocation exception is wrapping.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.velocity.tools.view.VelocityLayoutServlet.KEY_ERROR_INVOCATION_EXCEPTION">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="PROPERTY_DYNAMIC_LAYOUT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PROPERTY_DYNAMIC_LAYOUT</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> PROPERTY_DYNAMIC_LAYOUT</pre>
<div class="block">The velocity.properties key for specifying
whether dynamic layout change is allowed</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.velocity.tools.view.VelocityLayoutServlet.PROPERTY_DYNAMIC_LAYOUT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="errorTemplate">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>errorTemplate</h4>
<pre>protected&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> errorTemplate</pre>
</li>
</ul>
<a name="layoutDir">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>layoutDir</h4>
<pre>protected&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> layoutDir</pre>
</li>
</ul>
<a name="defaultLayout">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>defaultLayout</h4>
<pre>protected&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> defaultLayout</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="VelocityLayoutServlet--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>VelocityLayoutServlet</h4>
<pre>public&nbsp;VelocityLayoutServlet()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="init-javax.servlet.ServletConfig-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>init</h4>
<pre>public&nbsp;void&nbsp;init(javax.servlet.ServletConfig&nbsp;config)
throws javax.servlet.ServletException</pre>
<div class="block">Initializes Velocity, the view servlet and checks for changes to
the initial layout configuration.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>init</code>&nbsp;in interface&nbsp;<code>javax.servlet.Servlet</code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/velocity/tools/view/VelocityViewServlet.html#init-javax.servlet.ServletConfig-">init</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/velocity/tools/view/VelocityViewServlet.html" title="class in org.apache.velocity.tools.view">VelocityViewServlet</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>config</code> - servlet configuration parameters</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>javax.servlet.ServletException</code></dd>
</dl>
</li>
</ul>
<a name="fillContext-org.apache.velocity.context.Context-javax.servlet.http.HttpServletRequest-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fillContext</h4>
<pre>protected&nbsp;void&nbsp;fillContext(org.apache.velocity.context.Context&nbsp;ctx,
javax.servlet.http.HttpServletRequest&nbsp;request)</pre>
<div class="block">Overrides VelocityViewServlet to check the request for
an alternate layout</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/velocity/tools/view/VelocityViewServlet.html#fillContext-org.apache.velocity.context.Context-javax.servlet.http.HttpServletRequest-">fillContext</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/velocity/tools/view/VelocityViewServlet.html" title="class in org.apache.velocity.tools.view">VelocityViewServlet</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ctx</code> - context for this request</dd>
<dd><code>request</code> - client request</dd>
</dl>
</li>
</ul>
<a name="findLayout-javax.servlet.http.HttpServletRequest-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>findLayout</h4>
<pre>protected&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;findLayout(javax.servlet.http.HttpServletRequest&nbsp;request)</pre>
<div class="block">Searches for a non-default layout to be used for this request.
This implementation checks the request parameters and attributes.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>request</code> - servlet request</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>layout name or null</dd>
</dl>
</li>
</ul>
<a name="mergeTemplate-org.apache.velocity.Template-org.apache.velocity.context.Context-javax.servlet.http.HttpServletResponse-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>mergeTemplate</h4>
<pre>protected&nbsp;void&nbsp;mergeTemplate(org.apache.velocity.Template&nbsp;template,
org.apache.velocity.context.Context&nbsp;context,
javax.servlet.http.HttpServletResponse&nbsp;response)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Overrides VelocityViewServlet.mergeTemplate to do a two-pass
render for handling layouts</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/velocity/tools/view/VelocityViewServlet.html#mergeTemplate-org.apache.velocity.Template-org.apache.velocity.context.Context-javax.servlet.http.HttpServletResponse-">mergeTemplate</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/velocity/tools/view/VelocityViewServlet.html" title="class in org.apache.velocity.tools.view">VelocityViewServlet</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>template</code> - <code>Template</code> object</dd>
<dd><code>context</code> - Velocity context</dd>
<dd><code>response</code> - servlet response</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/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="error-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-java.lang.Throwable-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>error</h4>
<pre>protected&nbsp;void&nbsp;error(javax.servlet.http.HttpServletRequest&nbsp;request,
javax.servlet.http.HttpServletResponse&nbsp;response,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a>&nbsp;e)</pre>
<div class="block">Overrides VelocityViewServlet to display user's custom error template</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/velocity/tools/view/VelocityViewServlet.html#error-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-java.lang.Throwable-">error</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/velocity/tools/view/VelocityViewServlet.html" title="class in org.apache.velocity.tools.view">VelocityViewServlet</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>request</code> - servlet request</dd>
<dd><code>response</code> - servlet response</dd>
<dd><code>e</code> - thrown error</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/VelocityLayoutServlet.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/UiDependencyTool.TypeRule.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/VelocityView.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/VelocityLayoutServlet.html" target="_top">Frames</a></li>
<li><a href="VelocityLayoutServlet.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>