| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>LoopTagStatus</title> |
| <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="LoopTagStatus"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":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"; |
| </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="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/jstl/core/LoopTag.html" title="interface in javax.servlet.jsp.jstl.core"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../javax/servlet/jsp/jstl/core/LoopTagSupport.html" title="class in javax.servlet.jsp.jstl.core"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?javax/servlet/jsp/jstl/core/LoopTagStatus.html" target="_top">Frames</a></li> |
| <li><a href="LoopTagStatus.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </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 ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">javax.servlet.jsp.jstl.core</div> |
| <h2 title="Interface LoopTagStatus" class="title">Interface LoopTagStatus</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">LoopTagStatus</span></pre> |
| <div class="block"><p>Exposes the current status of |
| an iteration. JSTL provides a mechanism for LoopTags to |
| return information about the current index of the iteration and |
| convenience methods to determine whether or not the current round is |
| either the first or last in the iteration. It also lets authors |
| use the status object to obtain information about the iteration range, |
| step, and current object.</p> |
| |
| <p>Environments that require more status can extend this interface.</p></div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="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="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>java.lang.Integer</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../javax/servlet/jsp/jstl/core/LoopTagStatus.html#getBegin--">getBegin</a></span>()</code> |
| <div class="block">Returns the value of the 'begin' attribute for the associated tag, |
| or null if no 'begin' attribute was specified.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../javax/servlet/jsp/jstl/core/LoopTagStatus.html#getCount--">getCount</a></span>()</code> |
| <div class="block">Retrieves the "count" of the current round of the iteration.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>java.lang.Object</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../javax/servlet/jsp/jstl/core/LoopTagStatus.html#getCurrent--">getCurrent</a></span>()</code> |
| <div class="block">Retrieves the current item in the iteration.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>java.lang.Integer</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../javax/servlet/jsp/jstl/core/LoopTagStatus.html#getEnd--">getEnd</a></span>()</code> |
| <div class="block">Returns the value of the 'end' attribute for the associated tag, |
| or null if no 'end' attribute was specified.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../javax/servlet/jsp/jstl/core/LoopTagStatus.html#getIndex--">getIndex</a></span>()</code> |
| <div class="block">Retrieves the index of the current round of the iteration.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>java.lang.Integer</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../javax/servlet/jsp/jstl/core/LoopTagStatus.html#getStep--">getStep</a></span>()</code> |
| <div class="block">Returns the value of the 'step' attribute for the associated tag, |
| or null if no 'step' attribute was specified.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../javax/servlet/jsp/jstl/core/LoopTagStatus.html#isFirst--">isFirst</a></span>()</code> |
| <div class="block">Returns information about whether the current round of the |
| iteration is the first one.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../javax/servlet/jsp/jstl/core/LoopTagStatus.html#isLast--">isLast</a></span>()</code> |
| <div class="block">Returns information about whether the current round of the |
| iteration is the last one.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getCurrent--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCurrent</h4> |
| <pre>java.lang.Object getCurrent()</pre> |
| <div class="block">Retrieves the current item in the iteration. Behaves |
| idempotently; calling getCurrent() repeatedly should return the same |
| Object until the iteration is advanced. (Specifically, calling |
| getCurrent() does <b>not</b> advance the iteration.)</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current item as an object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getIndex--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIndex</h4> |
| <pre>int getIndex()</pre> |
| <div class="block">Retrieves the index of the current round of the iteration. If |
| iteration is being performed over a subset of an underlying |
| array, java.lang.Collection, or other type, the index returned |
| is absolute with respect to the underlying collection. Indices |
| are 0-based.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the 0-based index of the current round of the iteration</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCount--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCount</h4> |
| <pre>int getCount()</pre> |
| <div class="block"><p>Retrieves the "count" of the current round of the iteration. The |
| count is a relative, 1-based sequence number identifying the |
| current "round" of iteration (in context with all rounds the |
| current iteration will perform).</p> |
| |
| <p>As an example, an iteration with begin = 5, end = 15, and step = |
| 5 produces the counts 1, 2, and 3 in that order.</p></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the 1-based count of the current round of the iteration</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isFirst--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isFirst</h4> |
| <pre>boolean isFirst()</pre> |
| <div class="block">Returns information about whether the current round of the |
| iteration is the first one. This current round may be the 'first' |
| even when getIndex() != 0, for 'index' refers to the absolute |
| index of the current 'item' in the context of its underlying |
| collection. It is always that case that a true result from |
| isFirst() implies getCount() == 1.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><tt>true</tt> if the current round is the first in the |
| iteration, <tt>false</tt> otherwise.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isLast--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isLast</h4> |
| <pre>boolean isLast()</pre> |
| <div class="block">Returns information about whether the current round of the |
| iteration is the last one. As with isFirst(), subsetting is |
| taken into account. isLast() doesn't necessarily refer to the |
| status of the underlying Iterator; it refers to whether or not |
| the current round will be the final round of iteration for the |
| tag associated with this LoopTagStatus.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><tt>true</tt> if the current round is the last in the |
| iteration, <tt>false</tt> otherwise.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getBegin--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBegin</h4> |
| <pre>java.lang.Integer getBegin()</pre> |
| <div class="block">Returns the value of the 'begin' attribute for the associated tag, |
| or null if no 'begin' attribute was specified.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the 'begin' value for the associated tag, or null |
| if no 'begin' attribute was specified</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getEnd--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEnd</h4> |
| <pre>java.lang.Integer getEnd()</pre> |
| <div class="block">Returns the value of the 'end' attribute for the associated tag, |
| or null if no 'end' attribute was specified.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the 'end' value for the associated tag, or null |
| if no 'end' attribute was specified</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getStep--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getStep</h4> |
| <pre>java.lang.Integer getStep()</pre> |
| <div class="block">Returns the value of the 'step' attribute for the associated tag, |
| or null if no 'step' attribute was specified.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the 'step' value for the associated tag, or null |
| if no 'step' attribute was specified</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="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/jstl/core/LoopTag.html" title="interface in javax.servlet.jsp.jstl.core"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../javax/servlet/jsp/jstl/core/LoopTagSupport.html" title="class in javax.servlet.jsp.jstl.core"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?javax/servlet/jsp/jstl/core/LoopTagStatus.html" target="_top">Frames</a></li> |
| <li><a href="LoopTagStatus.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </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 ======= --> |
| </body> |
| </html> |
