Plugin Availability The Iterator Tool plugin is available in the blojsom add-on bundle. This is a separate download from the blojsom.war file.

Description

This is a wrapper for the Velocity Iterator Tool where an object is added to the context so that you can operate more efficiently with #foreach loops.

Installation and Setup

After downloading the blojsom add-on bundle, copy the blojsom-addon-plugins-{version}.jar and velocity-tools-1.1.jar file into your /WEB-INF/lib directory.

In your global /WEB-INF/plugin.properties file, add the following line:

iterator-tool=org.blojsom.plugin.tools.IteratorToolPlugin

You may then add "iterator-tool" to the end one of the flavor-based plugin chains. These plugin chains can be found in the individual user's plugin.properties file. For example:

html.blojsom-plugin-chain=...,iterator-tool

Usage and URL Parameters

There are no URL parameters to control the operation of the Iterator Tool plugin.

Context Attributes and Types

The following table describes the context attributes that are available and their associated type.

Context key	Input or Output	Type	Description
BLOJSOM_PLUGIN_ITERATOR_TOOL	Output	org.apache.velocity.tools.generic.IteratorTool object	View the documentation on the tool for information on its methods.