/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2000-2009 Sun Microsystems, Inc. All rights reserved. 
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License ("CDDL") (collectively, the "License").  You may
 * not use this file except in compliance with the License.  You can obtain
 * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
 * or mq/legal/LICENSE.txt.  See the License for the specific language
 * governing permissions and limitations under the License.
 * 
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at mq/legal/LICENSE.txt.  Sun designates
 * this particular file as subject to the "Classpath" exception as provided by
 * Sun in the GPL Version 2 section of the License file that accompanied this
 * code.  If applicable, add the following below the License Header, with the
 * fields enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 * 
 * Contributor(s):
 * 
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or  to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright holder. 
 */

/*
 * @(#)TabledInspector.java	1.7 06/27/07
 */ 

package com.sun.messaging.jmq.admin.apps.console;

import java.awt.BorderLayout;
import java.util.Enumeration;
import javax.swing.JScrollPane;
import javax.swing.JTable;
import javax.swing.JPanel;
import javax.swing.ListSelectionModel;
import javax.swing.event.EventListenerList;
import javax.swing.event.ListSelectionListener;
import javax.swing.event.ListSelectionEvent;
import javax.swing.event.TableModelEvent;
import javax.swing.table.AbstractTableModel;

import com.sun.messaging.jmq.admin.apps.console.event.SelectionEvent;

/** 
 * Inspector panel containing a JTable used to display the children
 * of the inspected ConsoleObj object.
 *
 * <P>
 * This class can be used as the super class of any InspectorPanel
 * that requires the following:
 * <UL>
 * <LI>lists children in a JTable
 * <LI>dispatches a OBJ_SELECTED event when an entry in the JTable is selected.
 * <LI>collumn labels are customizable
 * <LI>cell content displayed is obtained from the ConsoleObj (or subclass of it)
 * class.
 * </UL>
 *
 * <P>
 * 2 abstract methods need to be implemented by subclasses:
 * <UL>
 * <LI>public abstract String[] getColumnHeaders()<BR>
 *     This method returns an array containing the strings used for the collumn
 *     headers/labels.
 * <LI>public abstract Object getValueAtCollumn(ConsoleObj conObj, int col)<BR>
 *     This method returns the Object at a particular cell collumn for a given
 *     ConsoleObj object. Each row in the JTable represents one ConsoleObj.
 *     This method returns the object/value for the ConsoleObj, for a particular 
 *     collumn.
 *
 * </UL>
 * 
 *
 * @see InspectorPanel
 * @see AInspector
 * @see ConsoleObj
 */
public abstract class TabledInspector extends InspectorPanel 
			implements ListSelectionListener  {

    private CObjTableModel	model;
    private JTable		table;

    /**
     * Instantiate a TabledInspector object.
     */
    public TabledInspector()  {
	super();
    }

    /**
     * Creates/Returns the panel that contains the InspectorPanel GUI.
     * 
     * @return the panel that contains the InspectorPanel GUI.
     */
    public JPanel createWorkPanel()  {
	JPanel		listPanel = new JPanel();
	JScrollPane	scrollPane;

        model = new CObjTableModel();
	table = new JTable(model);

	table.setSelectionMode(ListSelectionModel.SINGLE_SELECTION);
	ListSelectionModel lsm = table.getSelectionModel();
	lsm.addListSelectionListener(this);
	scrollPane = new JScrollPane(table);

	listPanel.setLayout(new BorderLayout());
	listPanel.add(scrollPane, BorderLayout.CENTER);

	return (listPanel);
    }

    /**
     * Clears the selection in the InspectorPanel.
     */
    public void clearSelection()  {
	if (table != null)  {
	    table.clearSelection();
	}
    }

    /**
     * Initializes the InspectorPanel for the currently inspected
     * object.
     */
    public void inspectorInit()  {
	model.fireTableChanged(new TableModelEvent(model));
	clearSelection();
    }

    /**
     * This method is called when the selected object (row)
     * has been updated. The appropriate TableModelEvent is dispatched.
     */
    public void selectedObjectUpdated()  {
	if (table == null)  {
	    return;
	}

	int row = table.getSelectedRow();

	if (row < 0)  {
	    return;
	}

	model.fireTableChanged(new TableModelEvent(model, row));
    }


    /*
     * BEGIN INTERFACE ListSelectionListener
     */
    public void valueChanged(ListSelectionEvent e)  {
	ListSelectionModel lsm = (ListSelectionModel)e.getSource();
	boolean	isAdjusting = e.getValueIsAdjusting();
	int	firstIndex = e.getFirstIndex();
	int	lastIndex = e.getLastIndex();

	if (isAdjusting == false) {
	    /*
	     * Query model for selected index and get the object at the
	     * index.
	     */
	    if (lsm.isSelectionEmpty()) {
		/*
	        System.out.println("nothing selected");
		*/
	    } else {
	        int selectedRow = lsm.getMinSelectionIndex();
		/*
	        System.err.println("selected row : " + selectedRow);
		*/

		Object o = model.getValueAt(selectedRow, 0);

		/*
		System.err.println("Selected obj: " + o);
		System.err.println("\tobj type:" + o.getClass().getName());
		*/

		/*
		 * Dispatch a selection event.
		 */
	        SelectionEvent se = new SelectionEvent(this, SelectionEvent.OBJ_SELECTED);
	        se.setSelectedObj((ConsoleObj)o);

	        fireAdminEventDispatched(se);
	    }
	}
    }
    /*
     * END INTERFACE ListSelectionListener
     */

    /*
     * TableModel class for TabledInspector.
     * Note: This model assumes the objects at collumn = 0
     * are the ConsoleObj objects.
     */
    class CObjTableModel extends AbstractTableModel {
	/**
	 * Returns the number of collumns in table.
	 *
	 * @return The number of collumns in table.
	 */
        public int getColumnCount() {
            String[]	columnNames = getColumnHeaders();

	    if (columnNames == null)  {
		return (-1);
	    }

            return columnNames.length;
        }
        
	/**
	 * Returns the number of rows in table.
	 *
	 * @return The number of rows in table.
	 */
	public int getRowCount() {
            ConsoleObj conObj = getConsoleObj();
	    int rowcount = 0;

	    if (conObj != null) {
	        for (Enumeration e = conObj.children(); e.hasMoreElements(); 
					e.nextElement()) {
	 	    rowcount++;
	        }
	    }
	    return rowcount;
        }

	/**
	 * Returns the collumn name/label for a given collumn.
	 *
	 * @return the collumn name/label for a given collumn.
	 */
        public String getColumnName(int col) {
            String[]	columnNames = getColumnHeaders();

	    if (columnNames == null)  {
		return (null);
	    }

	    if (col >= columnNames.length)  {
		return (null);
	    }

            return columnNames[col];
        }

	/**
	 * Return value at a particular table cell location.
	 * Calls the TabledInspector.getValueAtCollumn()
	 * method.
	 */
        public Object getValueAt(int row, int col) {
            ConsoleObj conObj = getConsoleObj(), childNode;

	    if (conObj == null)  {
		return (null);
	    }

	    int rowcount = 0;
	    for (Enumeration e = conObj.children(); e.hasMoreElements();) {
                childNode = (ConsoleObj)e.nextElement();
		if (rowcount == row) {
		    if (col == 0)  {
			return (childNode);
		    }
		    return (getValueAtCollumn(childNode, col));
		}

	 	rowcount++;
	
	    }
	    return null;
        }

        /**
         * Don't need to implement this method unless your table's
         * editable.
         */
        public boolean isCellEditable(int row, int col) {
            return false;
        }

        /**
         * Don't need to implement this method unless your table's
         * data can change.
         */
        public void setValueAt(Object value, int row, int col) {
        }

    }

    /**
     * Return the array of Strings containing the collumn labels/headers.
     * @return the array of Strings containing the collumn labels/headers.
     */
    public abstract String[] getColumnHeaders();

    /**
     * Returns the Object at a particular cell collumn for a given
     * ConsoleObj object. Each row in the JTable represents one ConsoleObj.
     * This method returns the object/value for the ConsoleObj, for a particular 
     * collumn.
     *
     * @return the Object at a particular cell collumn for a given
     * ConsoleObj object.
     */
    public abstract Object getValueAtCollumn(ConsoleObj conObj, int col);
}
