net.sf.jett.event.TagLoopListener Maven / Gradle / Ivy

package net.sf.jett.event;

/**
 * A TagLoopListener is an object that has an opportunity to
 * manipulate a block of Cells as they're being transformed while
 * in a looping tag, with access to the block of Cells, the
 * current Map of beans, and the looping index.
 *
 * @author Randy Gettman
 * @since 0.3.0
 */
public interface TagLoopListener
{
   /**
    * Called immediately before a block of Cells is about to be
    * processed in a looping tag.  The given TagEvent contains the
    * following related data: a reference to the Block of
    * Cells that is about to be processed and the Map
    * of bean names to bean values that is about to be used.
    * @param event A TagLoopEvent.
    * @return A boolean that indicates whether the
    *    block of Cells should be processed.  true to
    *    process the block as normal, and false to skip the
    *    processing of the block.
    * @since 0.8.0
    */
   public boolean beforeTagLoopProcessed(TagLoopEvent event);


   /**
    * Called when a block of Cells has been processed in a looping
    * tag.  The given TagLoopEvent contains the following related
    * data: the Block of Cells that was processed, a
    * Map of bean names to bean values that was used, and the
    * zero-based looping index.
    *
    * @param event The TagLoopEvent.
    */
   public void onTagLoopProcessed(TagLoopEvent event);
}