001/* ========================================================================
002 * JCommon : a free general purpose class library for the Java(tm) platform
003 * ========================================================================
004 *
005 * (C) Copyright 2000-2005, by Object Refinery Limited and Contributors.
006 * 
007 * Project Info:  http://www.jfree.org/jcommon/index.html
008 *
009 * This library is free software; you can redistribute it and/or modify it 
010 * under the terms of the GNU Lesser General Public License as published by 
011 * the Free Software Foundation; either version 2.1 of the License, or 
012 * (at your option) any later version.
013 *
014 * This library is distributed in the hope that it will be useful, but 
015 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 
016 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public 
017 * License for more details.
018 *
019 * You should have received a copy of the GNU Lesser General Public
020 * License along with this library; if not, write to the Free Software
021 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, 
022 * USA.  
023 *
024 * [Java is a trademark or registered trademark of Sun Microsystems, Inc. 
025 * in the United States and other countries.]
026 * 
027 * ------------------
028 * SortableTable.java
029 * ------------------
030 * (C) Copyright 2000-2004, by Object Refinery Limited.
031 *
032 * Original Author:  David Gilbert (for Object Refinery Limited);
033 * Contributor(s):   -;
034 *
035 * $Id: SortableTable.java,v 1.5 2005/11/16 15:58:41 taqua Exp $
036 *
037 * Changes (from 26-Oct-2001)
038 * --------------------------
039 * 26-Oct-2001 : Changed package to com.jrefinery.ui.*;
040 * 14-Oct-2002 : Fixed errors reported by Checkstyle (DG);
041 *
042 */
043
044package org.jfree.ui;
045
046import javax.swing.JTable;
047import javax.swing.table.JTableHeader;
048import javax.swing.table.TableColumnModel;
049
050/**
051 * A simple extension of JTable that supports the use of a SortableTableModel.
052 *
053 * @author David Gilbert
054 */
055public class SortableTable extends JTable {
056
057    /** A listener for sorting. */
058    private SortableTableHeaderListener headerListener;
059
060    /**
061     * Standard constructor - builds a table for the specified model.
062     *
063     * @param model  the data.
064     */
065    public SortableTable(final SortableTableModel model) {
066
067        super(model);
068
069        final SortButtonRenderer renderer = new SortButtonRenderer();
070        final TableColumnModel cm = getColumnModel();
071        for (int i = 0; i < cm.getColumnCount(); i++) {
072            cm.getColumn(i).setHeaderRenderer(renderer);
073        }
074
075        final JTableHeader header = getTableHeader();
076        this.headerListener = new SortableTableHeaderListener(model, renderer);
077        header.addMouseListener(this.headerListener);
078        header.addMouseMotionListener(this.headerListener);
079
080        model.sortByColumn(0, true);
081
082    }
083
084    /**
085     * Changes the model for the table.  Takes care of updating the header listener at the
086     * same time.
087     *
088     * @param model  the table model.
089     *
090     */
091    public void setSortableModel(final SortableTableModel model) {
092
093        super.setModel(model);
094        this.headerListener.setTableModel(model);
095        final SortButtonRenderer renderer = new SortButtonRenderer();
096        final TableColumnModel cm = getColumnModel();
097        for (int i = 0; i < cm.getColumnCount(); i++) {
098            cm.getColumn(i).setHeaderRenderer(renderer);
099        }
100        model.sortByColumn(0, true);
101
102    }
103
104}