com.tridion.tcdl

Interface IterationTagSupport

public interface IterationTagSupport

The IterationTagSupport Interface introduces a new role to Tag handler to provide additional support of handling IterationTags. It introduces a new method doAfterBody, which allows Tag handlers to control iteration of its body tags.

The doAfterBody() method is invoked after every body evaluation to control whether the body will be reevaluated or not. If doAfterBody() returns IterationTagSupport.EVAL_BODY_AGAIN, then the body will be reevaluated. If doAfterBody() returns Tag.SKIP_BODY, then the body will be skipped and doEndTag() will be evaluated instead.

Field Summary

Fields

Modifier and Type	Field and Description
static int	EVAL_BODY_AGAIN Request the reevaluation of some body.
static int	SKIP_BODY Skips body evaluation.

Method Summary

Modifier and Type	Method and Description
int	doAfterBody(Tag tag, StringBuffer tagBody, TransformContext context, OutputDocument target) Processes TCDL body for (re)evaluation.

Field Detail

EVAL_BODY_AGAIN

static final int EVAL_BODY_AGAIN

Request the reevaluation of some body. Returned from doAfterBody.

See Also:

Constant Field Values

SKIP_BODY

static final int SKIP_BODY

Skips body evaluation. Returned from doAfterBody.

See Also:

Constant Field Values

Method Detail

doAfterBody

int doAfterBody(Tag tag,
                StringBuffer tagBody,
                TransformContext context,
                OutputDocument target)
         throws TCDLTransformerException

Processes TCDL body for (re)evaluation. This method is invoked after every evaluation of the body.

If doAfterBody returns EVAL_BODY_AGAIN, a new evaluation of the body will happen (followed by another invocation of doAfterBody). If doAfterBody returns SKIP_BODY, no more body evaluations will occur, and the doEndTag method will be invoked.

Returns:

whether additional evaluations of the body are desired.

Throws:

TCDLTransformerException