org.apache.struts.taglib.logic
Class IterateTag
BodyTagSupport
org.apache.struts.taglib.logic.IterateTag
public class IterateTag
extends BodyTagSupport
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.
$Rev: 56513 $ $Date: 2004-11-03 19:20:47 +0000 (Wed, 03 Nov 2004) $protected Object | collection - The collection over which we will be iterating.
|
protected String | id - The name of the scripting variable to be exposed.
|
protected String | indexId - The name of the scripting variable to be exposed as the current index.
|
protected Iterator | iterator - Iterator of the elements of this collection, while we are actually
running.
|
protected String | length - The length value or attribute name (<=0 means no limit).
|
protected int | lengthCount - The number of elements we have already rendered.
|
protected int | lengthValue - The actual length value (calculated in the start tag).
|
protected static MessageResources | messages - The message resources for this package.
|
protected String | name - The name of the collection or owning bean.
|
protected String | offset - The starting offset (zero relative).
|
protected int | offsetValue - The actual offset value (calculated in the start tag).
|
protected String | property - The property name containing the collection.
|
protected String | scope - The scope of the bean specified by the name property, if any.
|
protected boolean | started - Has this tag instance been started?
|
protected String | type - The Java class of each exposed element of the collection.
|
collection
protected Object collection
The collection over which we will be iterating.
id
protected String id
The name of the scripting variable to be exposed.
indexId
protected String indexId
The name of the scripting variable to be exposed as the current index.
iterator
protected Iterator iterator
Iterator of the elements of this collection, while we are actually
running.
length
protected String length
The length value or attribute name (<=0 means no limit).
lengthCount
protected int lengthCount
The number of elements we have already rendered.
lengthValue
protected int lengthValue
The actual length value (calculated in the start tag).
messages
protected static MessageResources messages
The message resources for this package.
name
protected String name
The name of the collection or owning bean.
offset
protected String offset
The starting offset (zero relative).
offsetValue
protected int offsetValue
The actual offset value (calculated in the start tag).
property
protected String property
The property name containing the collection.
scope
protected String scope
The scope of the bean specified by the name property, if any.
started
protected boolean started
Has this tag instance been started?
type
protected String type
The Java class of each exposed element of the collection.
doAfterBody
public int doAfterBody()
throws JspException
Make the next collection element available and loop, or
finish the iterations if there are no more elements.
doEndTag
public int doEndTag()
throws JspException
Clean up after processing this enumeration.
doStartTag
public int doStartTag()
throws JspException
Construct an iterator for the specified collection, and begin
looping through the body once per element.
getCollection
public Object getCollection()
getId
public String getId()
getIndex
public int getIndex()
Return the zero-relative index of the current iteration through the
loop. If you specify an
offset
, the first iteration
through the loop will have that value; otherwise, the first iteration
will return zero.
This property is read-only, and gives nested custom tags access to
this information. Therefore, it is
only valid in
between calls to
doStartTag()
and
doEndTag()
.
getIndexId
public String getIndexId()
getLength
public String getLength()
getName
public String getName()
getOffset
public String getOffset()
getProperty
public String getProperty()
getScope
public String getScope()
getType
public String getType()
release
public void release()
Release all allocated resources.
setCollection
public void setCollection(Object collection)
setId
public void setId(String id)
setIndexId
public void setIndexId(String indexId)
setLength
public void setLength(String length)
setName
public void setName(String name)
setOffset
public void setOffset(String offset)
setProperty
public void setProperty(String property)
setScope
public void setScope(String scope)
setType
public void setType(String type)
Copyright B) 2000-2007 - The Apache Software Foundation