| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <!-- Generated by javadoc on Fri Jun 15 16:53:36 PDT 2001 --> |
| <TITLE> |
| Apache Struts API Documentation: Class IterateTag |
| </TITLE> |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> |
| </HEAD> |
| <BODY BGCOLOR="white"> |
| |
| <!-- ========== START OF NAVBAR ========== --> |
| <A NAME="navbar_top"><!-- --></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../org/apache/struts/taglib/logic/GreaterThanTag.html"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../org/apache/struts/taglib/logic/IterateTei.html"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../index.html" TARGET="_top"><B>FRAMES</B></A> |
| <A HREF="IterateTag.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: INNER | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <!-- =========== END OF NAVBAR =========== --> |
| |
| <HR> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <H2> |
| <FONT SIZE="-1"> |
| org.apache.struts.taglib.logic</FONT> |
| <BR> |
| Class IterateTag</H2> |
| <PRE> |
| java.lang.Object |
| | |
| +--javax.servlet.jsp.tagext.TagSupport |
| | |
| +--javax.servlet.jsp.tagext.BodyTagSupport |
| | |
| +--<B>org.apache.struts.taglib.logic.IterateTag</B> |
| </PRE> |
| <DL> |
| <DT><B>All Implemented Interfaces:</B> <DD>javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, java.io.Serializable, javax.servlet.jsp.tagext.Tag</DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT>public class <B>IterateTag</B><DT>extends javax.servlet.jsp.tagext.BodyTagSupport</DL> |
| |
| <P> |
| Custom tag that iterates the elements of a collection, which can be |
| either an attribute or the property of an attribute. The collection |
| can be any of the following: an array of objects, an Enumeration, |
| an Iterator, a Collection (which includes Lists, Sets and Vectors), |
| or a Map (which includes Hashtables) whose elements will be iterated over. |
| <P> |
| <DL> |
| <DT><B>Version: </B><DD>$Revision: 1.1 $ $Date$</DD> |
| <DT><B>Author: </B><DD>Craig R. McClanahan</DD> |
| <DT><B>See Also: </B><DD><A HREF="../../../../../serialized-form.html#org.apache.struts.taglib.logic.IterateTag">Serialized Form</A></DL> |
| <HR> |
| |
| <P> |
| <!-- ======== INNER CLASS SUMMARY ======== --> |
| |
| |
| <!-- =========== FIELD SUMMARY =========== --> |
| |
| <A NAME="field_summary"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=2><FONT SIZE="+2"> |
| <B>Field Summary</B></FONT></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.lang.Object</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/logic/IterateTag.html#collection">collection</A></B></CODE> |
| |
| <BR> |
| The collection over which we will be iterating.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/logic/IterateTag.html#id">id</A></B></CODE> |
| |
| <BR> |
| The name of the scripting variable to be exposed.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/logic/IterateTag.html#indexId">indexId</A></B></CODE> |
| |
| <BR> |
| The name of the scripting variable to be exposed as the current index.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.util.Iterator</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/logic/IterateTag.html#iterator">iterator</A></B></CODE> |
| |
| <BR> |
| Iterator of the elements of this collection, while we are actually |
| running.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/logic/IterateTag.html#length">length</A></B></CODE> |
| |
| <BR> |
| The length value or attribute name (<=0 means no limit).</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/logic/IterateTag.html#lengthCount">lengthCount</A></B></CODE> |
| |
| <BR> |
| The number of elements we have already rendered.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/logic/IterateTag.html#lengthValue">lengthValue</A></B></CODE> |
| |
| <BR> |
| The actual length value (calculated in the start tag).</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected static <A HREF="../../../../../org/apache/struts/util/MessageResources.html">MessageResources</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/logic/IterateTag.html#messages">messages</A></B></CODE> |
| |
| <BR> |
| The message resources for this package.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/logic/IterateTag.html#name">name</A></B></CODE> |
| |
| <BR> |
| The name of the collection or owning bean.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/logic/IterateTag.html#offset">offset</A></B></CODE> |
| |
| <BR> |
| The starting offset (zero relative).</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/logic/IterateTag.html#offsetValue">offsetValue</A></B></CODE> |
| |
| <BR> |
| The actual offset value (calculated in the start tag).</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/logic/IterateTag.html#property">property</A></B></CODE> |
| |
| <BR> |
| The property name containing the collection.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/logic/IterateTag.html#scope">scope</A></B></CODE> |
| |
| <BR> |
| The scope of the bean specified by the name property, if any.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/logic/IterateTag.html#started">started</A></B></CODE> |
| |
| <BR> |
| Has this tag instance been started?</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/logic/IterateTag.html#type">type</A></B></CODE> |
| |
| <BR> |
| The Java class of each exposed element of the collection.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="fields_inherited_from_class_javax.servlet.jsp.tagext.BodyTagSupport"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TD><B>Fields inherited from class javax.servlet.jsp.tagext.BodyTagSupport</B></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE>bodyContent</CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="fields_inherited_from_class_javax.servlet.jsp.tagext.TagSupport"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TD><B>Fields inherited from class javax.servlet.jsp.tagext.TagSupport</B></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE>pageContext, parent, values</CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="fields_inherited_from_class_javax.servlet.jsp.tagext.BodyTag"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TD><B>Fields inherited from interface javax.servlet.jsp.tagext.BodyTag</B></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE>EVAL_BODY_BUFFERED, EVAL_BODY_TAG</CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="fields_inherited_from_class_javax.servlet.jsp.tagext.IterationTag"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TD><B>Fields inherited from interface javax.servlet.jsp.tagext.IterationTag</B></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE>EVAL_BODY_AGAIN</CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="fields_inherited_from_class_javax.servlet.jsp.tagext.Tag"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TD><B>Fields inherited from interface javax.servlet.jsp.tagext.Tag</B></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE>EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE</CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| |
| <A NAME="constructor_summary"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=2><FONT SIZE="+2"> |
| <B>Constructor Summary</B></FONT></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/logic/IterateTag.html#IterateTag()">IterateTag</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ========== METHOD SUMMARY =========== --> |
| |
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=2><FONT SIZE="+2"> |
| <B>Method Summary</B></FONT></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/logic/IterateTag.html#doAfterBody()">doAfterBody</A></B>()</CODE> |
| |
| <BR> |
| Make the next collection element available and loop, or |
| finish the iterations if there are no more elements.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/logic/IterateTag.html#doEndTag()">doEndTag</A></B>()</CODE> |
| |
| <BR> |
| Clean up after processing this enumeration.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/logic/IterateTag.html#doStartTag()">doStartTag</A></B>()</CODE> |
| |
| <BR> |
| Construct an iterator for the specified collection, and begin |
| looping through the body once per element.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.Object</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/logic/IterateTag.html#getCollection()">getCollection</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/logic/IterateTag.html#getId()">getId</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/logic/IterateTag.html#getIndex()">getIndex</A></B>()</CODE> |
| |
| <BR> |
| Return the zero-relative index of the current iteration through the |
| loop.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/logic/IterateTag.html#getIndexId()">getIndexId</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/logic/IterateTag.html#getLength()">getLength</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/logic/IterateTag.html#getName()">getName</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/logic/IterateTag.html#getOffset()">getOffset</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/logic/IterateTag.html#getProperty()">getProperty</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/logic/IterateTag.html#getScope()">getScope</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/logic/IterateTag.html#getType()">getType</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/logic/IterateTag.html#release()">release</A></B>()</CODE> |
| |
| <BR> |
| Release all allocated resources.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/logic/IterateTag.html#setCollection(java.lang.Object)">setCollection</A></B>(java.lang.Object collection)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/logic/IterateTag.html#setId(java.lang.String)">setId</A></B>(java.lang.String id)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/logic/IterateTag.html#setIndexId(java.lang.String)">setIndexId</A></B>(java.lang.String indexId)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/logic/IterateTag.html#setLength(java.lang.String)">setLength</A></B>(java.lang.String length)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/logic/IterateTag.html#setName(java.lang.String)">setName</A></B>(java.lang.String name)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/logic/IterateTag.html#setOffset(java.lang.String)">setOffset</A></B>(java.lang.String offset)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/logic/IterateTag.html#setProperty(java.lang.String)">setProperty</A></B>(java.lang.String property)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/logic/IterateTag.html#setScope(java.lang.String)">setScope</A></B>(java.lang.String scope)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/logic/IterateTag.html#setType(java.lang.String)">setType</A></B>(java.lang.String type)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_javax.servlet.jsp.tagext.BodyTagSupport"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TD><B>Methods inherited from class javax.servlet.jsp.tagext.BodyTagSupport</B></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE>doInitBody, getBodyContent, getPreviousOut, setBodyContent</CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_javax.servlet.jsp.tagext.TagSupport"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TD><B>Methods inherited from class javax.servlet.jsp.tagext.TagSupport</B></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE>findAncestorWithClass, getParent, getValue, getValues, removeValue, setPageContext, setParent, setValue</CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TD><B>Methods inherited from class java.lang.Object</B></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><clinit>, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, toString, wait, wait, wait</CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_javax.servlet.jsp.tagext.Tag"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TD><B>Methods inherited from interface javax.servlet.jsp.tagext.Tag</B></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE>getParent, setPageContext, setParent</CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ FIELD DETAIL =========== --> |
| |
| <A NAME="field_detail"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=1><FONT SIZE="+2"> |
| <B>Field Detail</B></FONT></TD> |
| </TR> |
| </TABLE> |
| |
| <A NAME="iterator"><!-- --></A><H3> |
| iterator</H3> |
| <PRE> |
| protected java.util.Iterator <B>iterator</B></PRE> |
| <DL> |
| <DD>Iterator of the elements of this collection, while we are actually |
| running.</DL> |
| <HR> |
| |
| <A NAME="lengthCount"><!-- --></A><H3> |
| lengthCount</H3> |
| <PRE> |
| protected int <B>lengthCount</B></PRE> |
| <DL> |
| <DD>The number of elements we have already rendered.</DL> |
| <HR> |
| |
| <A NAME="lengthValue"><!-- --></A><H3> |
| lengthValue</H3> |
| <PRE> |
| protected int <B>lengthValue</B></PRE> |
| <DL> |
| <DD>The actual length value (calculated in the start tag).</DL> |
| <HR> |
| |
| <A NAME="messages"><!-- --></A><H3> |
| messages</H3> |
| <PRE> |
| protected static <A HREF="../../../../../org/apache/struts/util/MessageResources.html">MessageResources</A> <B>messages</B></PRE> |
| <DL> |
| <DD>The message resources for this package.</DL> |
| <HR> |
| |
| <A NAME="offsetValue"><!-- --></A><H3> |
| offsetValue</H3> |
| <PRE> |
| protected int <B>offsetValue</B></PRE> |
| <DL> |
| <DD>The actual offset value (calculated in the start tag).</DL> |
| <HR> |
| |
| <A NAME="started"><!-- --></A><H3> |
| started</H3> |
| <PRE> |
| protected boolean <B>started</B></PRE> |
| <DL> |
| <DD>Has this tag instance been started?</DL> |
| <HR> |
| |
| <A NAME="collection"><!-- --></A><H3> |
| collection</H3> |
| <PRE> |
| protected java.lang.Object <B>collection</B></PRE> |
| <DL> |
| <DD>The collection over which we will be iterating.</DL> |
| <HR> |
| |
| <A NAME="id"><!-- --></A><H3> |
| id</H3> |
| <PRE> |
| protected java.lang.String <B>id</B></PRE> |
| <DL> |
| <DD>The name of the scripting variable to be exposed.</DL> |
| <HR> |
| |
| <A NAME="indexId"><!-- --></A><H3> |
| indexId</H3> |
| <PRE> |
| protected java.lang.String <B>indexId</B></PRE> |
| <DL> |
| <DD>The name of the scripting variable to be exposed as the current index.</DL> |
| <HR> |
| |
| <A NAME="length"><!-- --></A><H3> |
| length</H3> |
| <PRE> |
| protected java.lang.String <B>length</B></PRE> |
| <DL> |
| <DD>The length value or attribute name (<=0 means no limit).</DL> |
| <HR> |
| |
| <A NAME="name"><!-- --></A><H3> |
| name</H3> |
| <PRE> |
| protected java.lang.String <B>name</B></PRE> |
| <DL> |
| <DD>The name of the collection or owning bean.</DL> |
| <HR> |
| |
| <A NAME="offset"><!-- --></A><H3> |
| offset</H3> |
| <PRE> |
| protected java.lang.String <B>offset</B></PRE> |
| <DL> |
| <DD>The starting offset (zero relative).</DL> |
| <HR> |
| |
| <A NAME="property"><!-- --></A><H3> |
| property</H3> |
| <PRE> |
| protected java.lang.String <B>property</B></PRE> |
| <DL> |
| <DD>The property name containing the collection.</DL> |
| <HR> |
| |
| <A NAME="scope"><!-- --></A><H3> |
| scope</H3> |
| <PRE> |
| protected java.lang.String <B>scope</B></PRE> |
| <DL> |
| <DD>The scope of the bean specified by the name property, if any.</DL> |
| <HR> |
| |
| <A NAME="type"><!-- --></A><H3> |
| type</H3> |
| <PRE> |
| protected java.lang.String <B>type</B></PRE> |
| <DL> |
| <DD>The Java class of each exposed element of the collection.</DL> |
| |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| |
| <A NAME="constructor_detail"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=1><FONT SIZE="+2"> |
| <B>Constructor Detail</B></FONT></TD> |
| </TR> |
| </TABLE> |
| |
| <A NAME="IterateTag()"><!-- --></A><H3> |
| IterateTag</H3> |
| <PRE> |
| public <B>IterateTag</B>()</PRE> |
| <DL> |
| </DL> |
| |
| <!-- ============ METHOD DETAIL ========== --> |
| |
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=1><FONT SIZE="+2"> |
| <B>Method Detail</B></FONT></TD> |
| </TR> |
| </TABLE> |
| |
| <A NAME="getCollection()"><!-- --></A><H3> |
| getCollection</H3> |
| <PRE> |
| public java.lang.Object <B>getCollection</B>()</PRE> |
| <DL> |
| </DL> |
| <HR> |
| |
| <A NAME="setCollection(java.lang.Object)"><!-- --></A><H3> |
| setCollection</H3> |
| <PRE> |
| public void <B>setCollection</B>(java.lang.Object collection)</PRE> |
| <DL> |
| </DL> |
| <HR> |
| |
| <A NAME="getId()"><!-- --></A><H3> |
| getId</H3> |
| <PRE> |
| public java.lang.String <B>getId</B>()</PRE> |
| <DL> |
| <DD><DL> |
| <DT><B>Overrides:</B><DD><CODE>getId</CODE> in class <CODE>javax.servlet.jsp.tagext.TagSupport</CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setId(java.lang.String)"><!-- --></A><H3> |
| setId</H3> |
| <PRE> |
| public void <B>setId</B>(java.lang.String id)</PRE> |
| <DL> |
| <DD><DL> |
| <DT><B>Overrides:</B><DD><CODE>setId</CODE> in class <CODE>javax.servlet.jsp.tagext.TagSupport</CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getIndex()"><!-- --></A><H3> |
| getIndex</H3> |
| <PRE> |
| public int <B>getIndex</B>()</PRE> |
| <DL> |
| <DD><p>Return the zero-relative index of the current iteration through the |
| loop. If you specify an <code>offset</code>, the first iteration |
| through the loop will have that value; otherwise, the first iteration |
| will return zero.</p> |
| |
| <p>This property is read-only, and gives nested custom tags access to |
| this information. Therefore, it is <strong>only</strong> valid in |
| between calls to <code>doStartTag()</code> and <code>doEndTag()</code>. |
| </p></DL> |
| <HR> |
| |
| <A NAME="getIndexId()"><!-- --></A><H3> |
| getIndexId</H3> |
| <PRE> |
| public java.lang.String <B>getIndexId</B>()</PRE> |
| <DL> |
| </DL> |
| <HR> |
| |
| <A NAME="setIndexId(java.lang.String)"><!-- --></A><H3> |
| setIndexId</H3> |
| <PRE> |
| public void <B>setIndexId</B>(java.lang.String indexId)</PRE> |
| <DL> |
| </DL> |
| <HR> |
| |
| <A NAME="getLength()"><!-- --></A><H3> |
| getLength</H3> |
| <PRE> |
| public java.lang.String <B>getLength</B>()</PRE> |
| <DL> |
| </DL> |
| <HR> |
| |
| <A NAME="setLength(java.lang.String)"><!-- --></A><H3> |
| setLength</H3> |
| <PRE> |
| public void <B>setLength</B>(java.lang.String length)</PRE> |
| <DL> |
| </DL> |
| <HR> |
| |
| <A NAME="getName()"><!-- --></A><H3> |
| getName</H3> |
| <PRE> |
| public java.lang.String <B>getName</B>()</PRE> |
| <DL> |
| </DL> |
| <HR> |
| |
| <A NAME="setName(java.lang.String)"><!-- --></A><H3> |
| setName</H3> |
| <PRE> |
| public void <B>setName</B>(java.lang.String name)</PRE> |
| <DL> |
| </DL> |
| <HR> |
| |
| <A NAME="getOffset()"><!-- --></A><H3> |
| getOffset</H3> |
| <PRE> |
| public java.lang.String <B>getOffset</B>()</PRE> |
| <DL> |
| </DL> |
| <HR> |
| |
| <A NAME="setOffset(java.lang.String)"><!-- --></A><H3> |
| setOffset</H3> |
| <PRE> |
| public void <B>setOffset</B>(java.lang.String offset)</PRE> |
| <DL> |
| </DL> |
| <HR> |
| |
| <A NAME="getProperty()"><!-- --></A><H3> |
| getProperty</H3> |
| <PRE> |
| public java.lang.String <B>getProperty</B>()</PRE> |
| <DL> |
| </DL> |
| <HR> |
| |
| <A NAME="setProperty(java.lang.String)"><!-- --></A><H3> |
| setProperty</H3> |
| <PRE> |
| public void <B>setProperty</B>(java.lang.String property)</PRE> |
| <DL> |
| </DL> |
| <HR> |
| |
| <A NAME="getScope()"><!-- --></A><H3> |
| getScope</H3> |
| <PRE> |
| public java.lang.String <B>getScope</B>()</PRE> |
| <DL> |
| </DL> |
| <HR> |
| |
| <A NAME="setScope(java.lang.String)"><!-- --></A><H3> |
| setScope</H3> |
| <PRE> |
| public void <B>setScope</B>(java.lang.String scope)</PRE> |
| <DL> |
| </DL> |
| <HR> |
| |
| <A NAME="getType()"><!-- --></A><H3> |
| getType</H3> |
| <PRE> |
| public java.lang.String <B>getType</B>()</PRE> |
| <DL> |
| </DL> |
| <HR> |
| |
| <A NAME="setType(java.lang.String)"><!-- --></A><H3> |
| setType</H3> |
| <PRE> |
| public void <B>setType</B>(java.lang.String type)</PRE> |
| <DL> |
| </DL> |
| <HR> |
| |
| <A NAME="doStartTag()"><!-- --></A><H3> |
| doStartTag</H3> |
| <PRE> |
| public int <B>doStartTag</B>() |
| throws javax.servlet.jsp.JspException</PRE> |
| <DL> |
| <DD>Construct an iterator for the specified collection, and begin |
| looping through the body once per element.<DD><DL> |
| <DT><B>Overrides:</B><DD><CODE>doStartTag</CODE> in class <CODE>javax.servlet.jsp.tagext.BodyTagSupport</CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Throws:</B><DD><CODE>javax.servlet.jsp.JspException</CODE> - if a JSP exception has occurred</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="doAfterBody()"><!-- --></A><H3> |
| doAfterBody</H3> |
| <PRE> |
| public int <B>doAfterBody</B>() |
| throws javax.servlet.jsp.JspException</PRE> |
| <DL> |
| <DD>Make the next collection element available and loop, or |
| finish the iterations if there are no more elements.<DD><DL> |
| <DT><B>Overrides:</B><DD><CODE>doAfterBody</CODE> in class <CODE>javax.servlet.jsp.tagext.BodyTagSupport</CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Throws:</B><DD><CODE>javax.servlet.jsp.JspException</CODE> - if a JSP exception has occurred</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="doEndTag()"><!-- --></A><H3> |
| doEndTag</H3> |
| <PRE> |
| public int <B>doEndTag</B>() |
| throws javax.servlet.jsp.JspException</PRE> |
| <DL> |
| <DD>Clean up after processing this enumeration.<DD><DL> |
| <DT><B>Overrides:</B><DD><CODE>doEndTag</CODE> in class <CODE>javax.servlet.jsp.tagext.BodyTagSupport</CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Throws:</B><DD><CODE>javax.servlet.jsp.JspException</CODE> - if a JSP exception has occurred</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="release()"><!-- --></A><H3> |
| release</H3> |
| <PRE> |
| public void <B>release</B>()</PRE> |
| <DL> |
| <DD>Release all allocated resources.<DD><DL> |
| <DT><B>Overrides:</B><DD><CODE>release</CODE> in class <CODE>javax.servlet.jsp.tagext.BodyTagSupport</CODE></DL> |
| </DD> |
| </DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <HR> |
| |
| <!-- ========== START OF NAVBAR ========== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../org/apache/struts/taglib/logic/GreaterThanTag.html"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../org/apache/struts/taglib/logic/IterateTei.html"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../index.html" TARGET="_top"><B>FRAMES</B></A> |
| <A HREF="IterateTag.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: INNER | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <!-- =========== END OF NAVBAR =========== --> |
| |
| <HR> |
| Copyright © 2000-2001 - Apache Software Foundation |
| </BODY> |
| </HTML> |
