Package net.sf.jett.event

Class TagLoopEvent

java.lang.Object

net.sf.jett.event.TagEvent

net.sf.jett.event.TagLoopEvent

public class TagLoopEvent
extends TagEvent

A TagLoopEvent represents data associated with a "tag loop processed" event. It contains the same data as a TagEvent, plus the current 0-based looping index.

Since:

0.3.0

Author:

Randy Gettman

See Also:

TagEvent

Constructor Summary

Constructors

Constructor	Description
TagLoopEvent(org.apache.poi.ss.usermodel.Sheet sheet, Block block, java.util.Map<java.lang.String,java.lang.Object> beans, int index)	Constructs a TagLoopEvent built using the given TagContext and zero-based loop index.

Method Summary

Modifier and Type	Method	Description
int	getLoopIndex()	Returns the current loop index (zero-based).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from class net.sf.jett.event.TagEvent

getBeans, getBlock, getSheet

Constructor Detail

TagLoopEvent

public TagLoopEvent(org.apache.poi.ss.usermodel.Sheet sheet,
                    Block block,
                    java.util.Map<java.lang.String,java.lang.Object> beans,
                    int index)

Constructs a TagLoopEvent built using the given TagContext and zero-based loop index.

Parameters:

sheet - A Sheet.

block - A Block.

beans - A Map of bean names to values.

index - The loop index.

Method Detail

getLoopIndex

public int getLoopIndex()

Returns the current loop index (zero-based).

Returns:

The current loop index (zero-based).