/usr/share/doc/libservlet3.1-java/api/javax/servlet/jsp/tagext/Tag.html is in libservlet3.1-java-doc 8.5.30-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html>
<head>
<!-- Generated by javadoc -->
<title>Tag (Tomcat API Documentation)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../jquery/jquery-1.10.2.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Tag (Tomcat API Documentation)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../";loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="fixedNav">
<!-- ========= 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="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="../../../../javax/servlet/jsp/tagext/SimpleTagSupport.html" title="class in javax.servlet.jsp.tagext"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../javax/servlet/jsp/tagext/TagAdapter.html" title="class in javax.servlet.jsp.tagext"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?javax/servlet/jsp/tagext/Tag.html" target="_top">Frames</a></li>
<li><a href="Tag.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field.summary">Field</a> | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field.detail">Field</a> | </li>
<li>Constr | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding"> </div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span> <a href="../../../../javax/servlet/jsp/tagext/package-summary.html">javax.servlet.jsp.tagext</a></div>
<h2 title="Interface Tag" class="title">Interface Tag</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><code><a href="../../../../javax/servlet/jsp/tagext/JspTag.html" title="interface in javax.servlet.jsp.tagext">JspTag</a></code></dd>
</dl>
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><code><a href="../../../../javax/servlet/jsp/tagext/BodyTag.html" title="interface in javax.servlet.jsp.tagext">BodyTag</a></code>, <code><a href="../../../../javax/servlet/jsp/tagext/IterationTag.html" title="interface in javax.servlet.jsp.tagext">IterationTag</a></code></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="../../../../javax/servlet/jsp/tagext/BodyTagSupport.html" title="class in javax.servlet.jsp.tagext">BodyTagSupport</a></code>, <code><a href="../../../../javax/servlet/jsp/tagext/TagAdapter.html" title="class in javax.servlet.jsp.tagext">TagAdapter</a></code>, <code><a href="../../../../javax/servlet/jsp/tagext/TagSupport.html" title="class in javax.servlet.jsp.tagext">TagSupport</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">Tag</span>
extends <a href="../../../../javax/servlet/jsp/tagext/JspTag.html" title="interface in javax.servlet.jsp.tagext">JspTag</a></pre>
<div class="block">The interface of a classic tag handler that does not want to manipulate
its body. The Tag interface defines the basic protocol between a Tag
handler and JSP page implementation class. It defines the life cycle
and the methods to be invoked at start and end tag.
<p><B>Properties</B></p>
<p>The Tag interface specifies the setter and getter methods for the core
pageContext and parent properties.</p>
<p>The JSP page implementation object invokes setPageContext and
setParent, in that order, before invoking doStartTag() or doEndTag().</p>
<p><B>Methods</B></p>
<p>There are two main actions: doStartTag and doEndTag. Once all
appropriate properties have been initialized, the doStartTag and
doEndTag methods can be invoked on the tag handler. Between these
invocations, the tag handler is assumed to hold a state that must
be preserved. After the doEndTag invocation, the tag handler is
available for further invocations (and it is expected to have
retained its properties).</p>
<p><B>Lifecycle</B></p>
<p>Lifecycle details are described by the transition diagram below,
with the following comments:</p>
<ul>
<li> [1] This transition is intended to be for releasing long-term data.
no guarantees are assumed on whether any properties have been retained
or not.
<li> [2] This transition happens if and only if the tag ends normally
without raising an exception
<li> [3] Some setters may be called again before a tag handler is
reused. For instance, <code>setParent()</code> is called if it's
reused within the same page but at a different level,
<code>setPageContext()</code> is called if it's used in another page,
and attribute setters are called if the values differ or are expressed
as request-time attribute values.
<li> Check the TryCatchFinally interface for additional details related
to exception handling and resource management.
</ul>
<IMG src="doc-files/TagProtocol.gif" alt="Lifecycle Details Transition Diagram for Tag">
<p>Once all invocations on the tag handler
are completed, the release method is invoked on it. Once a release
method is invoked <em>all</em> properties, including parent and
pageContext, are assumed to have been reset to an unspecified value.
The page compiler guarantees that release() will be invoked on the Tag
handler before the handler is released to the GC.</p>
<p><B>Empty and Non-Empty Action</B></p>
<p>If the TagLibraryDescriptor file indicates that the action must
always have an empty action, by an <body-content> entry of "empty",
then the doStartTag() method must return SKIP_BODY.</p>
<p>Otherwise, the doStartTag() method may return SKIP_BODY or
EVAL_BODY_INCLUDE.</p>
<p>If SKIP_BODY is returned the body, if present, is not evaluated.</p>
<p>If EVAL_BODY_INCLUDE is returned, the body is evaluated and
"passed through" to the current out.</p></div>
</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" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../javax/servlet/jsp/tagext/Tag.html#EVAL_BODY_INCLUDE">EVAL_BODY_INCLUDE</a></span></code></th>
<td class="colLast">
<div class="block">Evaluate body into existing out stream.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../javax/servlet/jsp/tagext/Tag.html#EVAL_PAGE">EVAL_PAGE</a></span></code></th>
<td class="colLast">
<div class="block">Continue evaluating the page.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../javax/servlet/jsp/tagext/Tag.html#SKIP_BODY">SKIP_BODY</a></span></code></th>
<td class="colLast">
<div class="block">Skip body evaluation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../javax/servlet/jsp/tagext/Tag.html#SKIP_PAGE">SKIP_PAGE</a></span></code></th>
<td class="colLast">
<div class="block">Skip the rest of the page.</div>
</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" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../javax/servlet/jsp/tagext/Tag.html#doEndTag--">doEndTag</a></span>()</code></th>
<td class="colLast">
<div class="block">Process the end tag for this instance.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../javax/servlet/jsp/tagext/Tag.html#doStartTag--">doStartTag</a></span>()</code></th>
<td class="colLast">
<div class="block">Process the start tag for this instance.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../javax/servlet/jsp/tagext/Tag.html" title="interface in javax.servlet.jsp.tagext">Tag</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../javax/servlet/jsp/tagext/Tag.html#getParent--">getParent</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the parent (closest enclosing tag handler) for this tag handler.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../javax/servlet/jsp/tagext/Tag.html#release--">release</a></span>()</code></th>
<td class="colLast">
<div class="block">Called on a Tag handler to release state.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../javax/servlet/jsp/tagext/Tag.html#setPageContext-javax.servlet.jsp.PageContext-">setPageContext</a></span>​(<a href="../../../../javax/servlet/jsp/PageContext.html" title="class in javax.servlet.jsp">PageContext</a> pc)</code></th>
<td class="colLast">
<div class="block">Set the current page context.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../javax/servlet/jsp/tagext/Tag.html#setParent-javax.servlet.jsp.tagext.Tag-">setParent</a></span>​(<a href="../../../../javax/servlet/jsp/tagext/Tag.html" title="interface in javax.servlet.jsp.tagext">Tag</a> t)</code></th>
<td class="colLast">
<div class="block">Set the parent (closest enclosing tag handler) of this tag handler.</div>
</td>
</tr>
</table>
</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="SKIP_BODY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SKIP_BODY</h4>
<pre>static final int SKIP_BODY</pre>
<div class="block">Skip body evaluation.
Valid return value for doStartTag and doAfterBody.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#javax.servlet.jsp.tagext.Tag.SKIP_BODY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="EVAL_BODY_INCLUDE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>EVAL_BODY_INCLUDE</h4>
<pre>static final int EVAL_BODY_INCLUDE</pre>
<div class="block">Evaluate body into existing out stream.
Valid return value for doStartTag.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#javax.servlet.jsp.tagext.Tag.EVAL_BODY_INCLUDE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="SKIP_PAGE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SKIP_PAGE</h4>
<pre>static final int SKIP_PAGE</pre>
<div class="block">Skip the rest of the page.
Valid return value for doEndTag.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#javax.servlet.jsp.tagext.Tag.SKIP_PAGE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="EVAL_PAGE">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>EVAL_PAGE</h4>
<pre>static final int EVAL_PAGE</pre>
<div class="block">Continue evaluating the page.
Valid return value for doEndTag().</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#javax.servlet.jsp.tagext.Tag.EVAL_PAGE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setPageContext-javax.servlet.jsp.PageContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPageContext</h4>
<pre>void setPageContext​(<a href="../../../../javax/servlet/jsp/PageContext.html" title="class in javax.servlet.jsp">PageContext</a> pc)</pre>
<div class="block">Set the current page context.
This method is invoked by the JSP page implementation object
prior to doStartTag().
<p>
This value is *not* reset by doEndTag() and must be explicitly reset
by a page implementation if it changes between calls to doStartTag().</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pc</code> - The page context for this tag handler.</dd>
</dl>
</li>
</ul>
<a name="setParent-javax.servlet.jsp.tagext.Tag-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setParent</h4>
<pre>void setParent​(<a href="../../../../javax/servlet/jsp/tagext/Tag.html" title="interface in javax.servlet.jsp.tagext">Tag</a> t)</pre>
<div class="block">Set the parent (closest enclosing tag handler) of this tag handler.
Invoked by the JSP page implementation object prior to doStartTag().
<p>
This value is *not* reset by doEndTag() and must be explicitly reset
by a page implementation.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>t</code> - The parent tag, or null.</dd>
</dl>
</li>
</ul>
<a name="getParent--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParent</h4>
<pre><a href="../../../../javax/servlet/jsp/tagext/Tag.html" title="interface in javax.servlet.jsp.tagext">Tag</a> getParent()</pre>
<div class="block">Get the parent (closest enclosing tag handler) for this tag handler.
<p>
The getParent() method can be used to navigate the nested tag
handler structure at runtime for cooperation among custom actions;
for example, the findAncestorWithClass() method in TagSupport
provides a convenient way of doing this.
<p>
The current version of the specification only provides one formal
way of indicating the observable type of a tag handler: its
tag handler implementation class, described in the tag-class
sub-element of the tag element. This is extended in an
informal manner by allowing the tag library author to
indicate in the description sub-element an observable type.
The type should be a sub-type of the tag handler implementation
class or void.
This additional constraint can be exploited by a
specialized container that knows about that specific tag library,
as in the case of the JSP standard tag library.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the current parent, or null if none.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../javax/servlet/jsp/tagext/TagSupport.html#findAncestorWithClass-javax.servlet.jsp.tagext.Tag-java.lang.Class-"><code>TagSupport.findAncestorWithClass(javax.servlet.jsp.tagext.Tag, java.lang.Class)</code></a></dd>
</dl>
</li>
</ul>
<a name="doStartTag--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>doStartTag</h4>
<pre>int doStartTag()
throws <a href="../../../../javax/servlet/jsp/JspException.html" title="class in javax.servlet.jsp">JspException</a></pre>
<div class="block">Process the start tag for this instance.
This method is invoked by the JSP page implementation object.
<p>
The doStartTag method assumes that the properties pageContext and
parent have been set. It also assumes that any properties exposed as
attributes have been set too. When this method is invoked, the body
has not yet been evaluated.
<p>
This method returns Tag.EVAL_BODY_INCLUDE or
BodyTag.EVAL_BODY_BUFFERED to indicate
that the body of the action should be evaluated or SKIP_BODY to
indicate otherwise.
<p>
When a Tag returns EVAL_BODY_INCLUDE the result of evaluating
the body (if any) is included into the current "out" JspWriter as it
happens and then doEndTag() is invoked.
<p>
BodyTag.EVAL_BODY_BUFFERED is only valid if the tag handler
implements BodyTag.
<p>
The JSP container will resynchronize the values of any AT_BEGIN and
NESTED variables (defined by the associated TagExtraInfo or TLD)
after the invocation of doStartTag(), except for a tag handler
implementing BodyTag whose doStartTag() method returns
BodyTag.EVAL_BODY_BUFFERED.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>EVAL_BODY_INCLUDE if the tag wants to process body, SKIP_BODY
if it does not want to process it.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../javax/servlet/jsp/JspException.html" title="class in javax.servlet.jsp">JspException</a></code> - if an error occurred while processing this tag</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../javax/servlet/jsp/tagext/BodyTag.html" title="interface in javax.servlet.jsp.tagext"><code>BodyTag</code></a></dd>
</dl>
</li>
</ul>
<a name="doEndTag--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>doEndTag</h4>
<pre>int doEndTag()
throws <a href="../../../../javax/servlet/jsp/JspException.html" title="class in javax.servlet.jsp">JspException</a></pre>
<div class="block">Process the end tag for this instance.
This method is invoked by the JSP page implementation object
on all Tag handlers.
<p>
This method will be called after returning from doStartTag. The
body of the action may or may not have been evaluated, depending on
the return value of doStartTag.
<p>
If this method returns EVAL_PAGE, the rest of the page continues
to be evaluated. If this method returns SKIP_PAGE, the rest of
the page is not evaluated, the request is completed, and
the doEndTag() methods of enclosing tags are not invoked. If this
request was forwarded or included from another page (or Servlet),
only the current page evaluation is stopped.
<p>
The JSP container will resynchronize the values of any AT_BEGIN and
AT_END variables (defined by the associated TagExtraInfo or TLD)
after the invocation of doEndTag().</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>indication of whether to continue evaluating the JSP page.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../javax/servlet/jsp/JspException.html" title="class in javax.servlet.jsp">JspException</a></code> - if an error occurred while processing this tag</dd>
</dl>
</li>
</ul>
<a name="release--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>release</h4>
<pre>void release()</pre>
<div class="block">Called on a Tag handler to release state.
The page compiler guarantees that JSP page implementation
objects will invoke this method on all tag handlers,
but there may be multiple invocations on doStartTag and doEndTag in between.</div>
</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="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="../../../../javax/servlet/jsp/tagext/SimpleTagSupport.html" title="class in javax.servlet.jsp.tagext"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../javax/servlet/jsp/tagext/TagAdapter.html" title="class in javax.servlet.jsp.tagext"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?javax/servlet/jsp/tagext/Tag.html" target="_top">Frames</a></li>
<li><a href="Tag.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field.summary">Field</a> | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field.detail">Field</a> | </li>
<li>Constr | </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 © 2000-2016 The Apache Software Foundation. All Rights Reserved.</small></p>
</body>
</html>
|