|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object javax.servlet.jsp.tagext.TagSupport javax.servlet.jsp.tagext.BodyTagSupport org.apache.struts.taglib.logic.IterateTag
public class IterateTag
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.
Field Summary | |
---|---|
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. |
Fields inherited from class javax.servlet.jsp.tagext.BodyTagSupport |
---|
bodyContent |
Fields inherited from class javax.servlet.jsp.tagext.TagSupport |
---|
pageContext |
Fields inherited from interface javax.servlet.jsp.tagext.BodyTag |
---|
EVAL_BODY_BUFFERED, EVAL_BODY_TAG |
Fields inherited from interface javax.servlet.jsp.tagext.IterationTag |
---|
EVAL_BODY_AGAIN |
Fields inherited from interface javax.servlet.jsp.tagext.Tag |
---|
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE |
Constructor Summary | |
---|---|
IterateTag()
|
Method Summary | |
---|---|
int |
doAfterBody()
Make the next collection element available and loop, or finish the iterations if there are no more elements. |
int |
doEndTag()
Clean up after processing this enumeration. |
int |
doStartTag()
Construct an iterator for the specified collection, and begin looping through the body once per element. |
Object |
getCollection()
|
String |
getId()
|
int |
getIndex()
Return the zero-relative index of the current iteration through the loop. |
String |
getIndexId()
|
String |
getLength()
|
String |
getName()
|
String |
getOffset()
|
String |
getProperty()
|
String |
getScope()
|
String |
getType()
|
void |
release()
Release all allocated resources. |
void |
setCollection(Object collection)
|
void |
setId(String id)
|
void |
setIndexId(String indexId)
|
void |
setLength(String length)
|
void |
setName(String name)
|
void |
setOffset(String offset)
|
void |
setProperty(String property)
|
void |
setScope(String scope)
|
void |
setType(String type)
|
Methods inherited from class javax.servlet.jsp.tagext.BodyTagSupport |
---|
doInitBody, getBodyContent, getPreviousOut, setBodyContent |
Methods inherited from class javax.servlet.jsp.tagext.TagSupport |
---|
findAncestorWithClass, getParent, getValue, getValues, removeValue, setPageContext, setParent, setValue |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface javax.servlet.jsp.tagext.Tag |
---|
getParent, setPageContext, setParent |
Field Detail |
---|
protected static MessageResources messages
protected Iterator iterator
protected int lengthCount
protected int lengthValue
protected int offsetValue
protected boolean started
protected Object collection
protected String id
protected String indexId
protected String length
protected String name
protected String offset
protected String property
protected String scope
protected String type
Constructor Detail |
---|
public IterateTag()
Method Detail |
---|
public Object getCollection()
public void setCollection(Object collection)
public String getId()
getId
in class TagSupport
public void setId(String id)
setId
in class TagSupport
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()
.
public String getIndexId()
public void setIndexId(String indexId)
public String getLength()
public void setLength(String length)
public String getName()
public void setName(String name)
public String getOffset()
public void setOffset(String offset)
public String getProperty()
public void setProperty(String property)
public String getScope()
public void setScope(String scope)
public String getType()
public void setType(String type)
public int doStartTag() throws JspException
doStartTag
in interface Tag
doStartTag
in class BodyTagSupport
JspException
- if a JSP exception has occurredpublic int doAfterBody() throws JspException
doAfterBody
in interface IterationTag
doAfterBody
in class BodyTagSupport
JspException
- if a JSP exception has occurredpublic int doEndTag() throws JspException
doEndTag
in interface Tag
doEndTag
in class BodyTagSupport
JspException
- if a JSP exception has occurredpublic void release()
release
in interface Tag
release
in class BodyTagSupport
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |