org.apache.cocoon.taglib.core
Interface LoopTag

All Superinterfaces:

Component, Tag

All Known Implementing Classes:

ForEachSupport, ForEachTag, LoopTagSupport

public interface LoopTag
extends Tag

Allows developers to write custom iteration tags by implementing the LoopTag interface. (This is not to be confused with org.apache.cocoon.taglib.IterationTag) LoopTag establishes a mechanism for iteration tags to be recognized and for type-safe communication with custom subtags.

In most cases, it will not be necessary to implement this interface manually, for a base support class (LoopTagSupport) is provided to facilitate implementation.

Migration from JSTL1.0

Version:

CVS $Id: LoopTag.html 1304258 2012-03-23 10:09:27Z ilgrosso $

Author:

Volker Schmitt

See Also:

LoopTag

Field Summary

Fields inherited from interface org.apache.cocoon.taglib.Tag

EVAL_BODY, EVAL_PAGE, ROLE, SKIP_BODY

Method Summary

Object	getCurrent() Retrieves the current item in the iteration.
LoopTagStatus	getIteratorStatus() Retrieves a 'status' object to provide information about the current round of the iteration.

Methods inherited from interface org.apache.cocoon.taglib.Tag

doEndTag, doStartTag, getParent, setParent, setup

Method Detail

getCurrent

Object getCurrent()

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 not advance the iteration.)

Returns:

the current item as an object

getIteratorStatus

LoopTagStatus getIteratorStatus()

Retrieves a 'status' object to provide information about the current round of the iteration.

Returns:

the LoopTagStatus for the current LoopTag