AddToListColsTag.java

/*
 * RHQ Management Platform
 * Copyright (C) 2005-2008 Red Hat, Inc.
 * All rights reserved.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation version 2 of the License.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */
package org.rhq.enterprise.gui.legacy.taglib;

import java.util.ArrayList;
import java.util.HashMap;

import javax.servlet.jsp.JspException;

/**
 * Define the set of columns for the "from" and "to" tables in the Add
 * To List widget. Each column is specified by a nested
 * <code><spider:addToListCol></code> tag.
 *
 * After this tag and its nested body are evaluated, a scoped
 * attribute will contain a <code>List</code> of <code>Map</code>
 * objects (each representing a column) with the following properties:
 *
 * <ul>
 *   <li> <em>name</em> - a symbolic name for the column
 *   <li> <em>key</em> - the message key for the column's table header
 * </ul>
 */
public class AddToListColsTag extends VarSetterBaseTag {

    //----------------------------------------------------instance variables

    private ArrayList cols;

    //----------------------------------------------------constructors

    public AddToListColsTag() {
        super();
    }

    //----------------------------------------------------public methods

    /**
     *
     */
    public void addCol(String name, String key) {
        HashMap map = new HashMap(2);
        map.put("name", name);
        map.put("key", key);
        cols.add(map);
    }

    /**
     *
     */
    public int doStartTag() throws JspException {
        cols = new ArrayList();
        return EVAL_BODY_INCLUDE;
    }

    /**
     *
     */
    public int doEndTag() throws JspException {
        setScopedVariable(cols);
        return EVAL_PAGE;
    }

    /**
     * Release tag state.
     *
     */
    public void release() {
        cols = null;
        super.release();
    }
}