Plugin Availability The List Tool and Extended List Tool plugins are available in the blojsom add-on bundle. This is a separate download from the blojsom.war file.

Availability

Available as of blojsom 2.27.

Description

This is a wrapper for the Velocity List Tool where an object is added to the context so that you can work with arrays. These plugins are a replacement for blojsom's Array Tool plugin.

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:

list-tool=org.blojsom.plugin.tools.ListToolPlugin
extended-list-tool=org.blojsom.plugin.tools.ExtendedListToolPlugin

You may then add "list-tool" or "extended-list-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=...,list-tool

Usage and URL Parameters

There are no URL parameters to control the operation of the List Tool or Extended List Tool plugins.

Context Attributes and Types

The following table describes the context attributes that are available from the List tool plugin and their associated type.

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

The following table describes the context attributes that are available from the Extended List tool plugin and their associated type.

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