Package org.apache.wiki.tags
Class IteratorTag
- java.lang.Object
-
- javax.servlet.jsp.tagext.TagSupport
-
- javax.servlet.jsp.tagext.BodyTagSupport
-
- org.apache.wiki.tags.IteratorTag
-
- All Implemented Interfaces:
java.io.Serializable
,javax.servlet.jsp.tagext.BodyTag
,javax.servlet.jsp.tagext.IterationTag
,javax.servlet.jsp.tagext.JspTag
,javax.servlet.jsp.tagext.Tag
,javax.servlet.jsp.tagext.TryCatchFinally
- Direct Known Subclasses:
AdminBeanIteratorTag
,AttachmentsIteratorTag
,EditorIteratorTag
,HistoryIteratorTag
,SearchResultIteratorTag
public abstract class IteratorTag extends javax.servlet.jsp.tagext.BodyTagSupport implements javax.servlet.jsp.tagext.TryCatchFinally
Iterates through tags.Attributes
- list - a collection.
- Since:
- 2.0
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected java.util.Iterator<?>
m_iterator
protected java.lang.String
m_pageName
protected Context
m_wikiContext
-
Constructor Summary
Constructors Constructor Description IteratorTag()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
clearList()
Clears the iterator away.int
doAfterBody()
void
doCatch(java.lang.Throwable arg0)
In case your tag throws an exception at any point, you can override this method and implement a custom exception handler.int
doEndTag()
void
doFinally()
Executed after the tag has been finished.int
doStartTag()
void
resetIterator()
Override this method to reset your own iterator.void
setList(java.lang.Object[] arg)
Sets the collection list, but using an array.void
setList(java.util.Collection<?> arg)
Sets the collection that is used to form the iteration.-
Methods inherited from class javax.servlet.jsp.tagext.BodyTagSupport
doInitBody, getBodyContent, getPreviousOut, release, setBodyContent
-
Methods inherited from class javax.servlet.jsp.tagext.TagSupport
findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue
-
-
-
-
Field Detail
-
m_pageName
protected java.lang.String m_pageName
-
m_iterator
protected java.util.Iterator<?> m_iterator
-
m_wikiContext
protected Context m_wikiContext
-
-
Constructor Detail
-
IteratorTag
public IteratorTag()
-
-
Method Detail
-
setList
public void setList(java.util.Collection<?> arg)
Sets the collection that is used to form the iteration.- Parameters:
arg
- A Collection which will be iterated.
-
setList
public void setList(java.lang.Object[] arg)
Sets the collection list, but using an array.- Parameters:
arg
- An array of objects which will be iterated.
-
clearList
public void clearList()
Clears the iterator away. After calling this method doStartTag() will always return SKIP_BODY
-
resetIterator
public void resetIterator()
Override this method to reset your own iterator.
-
doStartTag
public int doStartTag()
- Specified by:
doStartTag
in interfacejavax.servlet.jsp.tagext.Tag
- Overrides:
doStartTag
in classjavax.servlet.jsp.tagext.BodyTagSupport
-
doEndTag
public int doEndTag()
- Specified by:
doEndTag
in interfacejavax.servlet.jsp.tagext.Tag
- Overrides:
doEndTag
in classjavax.servlet.jsp.tagext.BodyTagSupport
-
doAfterBody
public int doAfterBody()
- Specified by:
doAfterBody
in interfacejavax.servlet.jsp.tagext.IterationTag
- Overrides:
doAfterBody
in classjavax.servlet.jsp.tagext.BodyTagSupport
-
doCatch
public void doCatch(java.lang.Throwable arg0) throws java.lang.Throwable
In case your tag throws an exception at any point, you can override this method and implement a custom exception handler.By default, this handler does nothing.
- Specified by:
doCatch
in interfacejavax.servlet.jsp.tagext.TryCatchFinally
- Parameters:
arg0
- The Throwable that the tag threw- Throws:
java.lang.Throwable
- I have no idea why this would throw anything
-
doFinally
public void doFinally()
Executed after the tag has been finished. This is a great place to put any cleanup code. However you must call super.doFinally() if you override this method, or else some of the things may not work as expected.- Specified by:
doFinally
in interfacejavax.servlet.jsp.tagext.TryCatchFinally
-
-