DMDirc-Plugins/src/com/dmdirc/addons/ui_swing/components/PackingTable.java

/*
 * Copyright (c) 2006-2011 Chris Smith, Shane Mc Cormack, Gregory Holmes
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package com.dmdirc.addons.ui_swing.components;

import java.awt.Graphics;

import javax.swing.JScrollPane;
import javax.swing.JTable;
import javax.swing.table.DefaultTableModel;
import javax.swing.table.TableColumn;
import javax.swing.table.TableColumnModel;
import javax.swing.table.TableModel;

import net.miginfocom.layout.PlatformDefaults;

/**
 * Creates a new table that automatically sizes its columns to the size of its
 * data.
 */
public class PackingTable extends JTable {

    /**
     * A version number for this class. It should be changed whenever the class
     * structure is changed (or anything else that would prevent serialized
     * objects being unserialized with the new class).
     */
    private static final long serialVersionUID = 1;
    /** Scrollpane. */
    private final JScrollPane scrollPane;
    /** Should the last column fit text (true), or fit viewport (false). */
    private boolean lastColumnFit;
    /** Border padding. */
    private final int padding = (int) PlatformDefaults.getUnitValueX("related").
            getValue();

    /**
     * Creates a new packing table.
     *
     * @param rows Row data
     * @param cols Column data
     * @param editable Whether the table should be editable or not
     * @param scrollPane Scrollpane parent
     */
    public PackingTable(final Object[][] rows, final Object[] cols,
            final boolean editable, final JScrollPane scrollPane) {
        this(new DefaultTableModel(rows, cols), editable, scrollPane, true);
    }

    /**
     * Creates a new packing table.
     *
     * @param rows Row data
     * @param cols Column data
     * @param editable Whether the table should be editable or not
     * @param scrollPane Scrollpane parent
     * @param lastColumnFit Should the last column fit text (true),
     * or fit viewport (false).
     */
    public PackingTable(final Object[][] rows, final Object[] cols,
            final boolean editable, final JScrollPane scrollPane,
            final boolean lastColumnFit) {
        this(new DefaultTableModel(rows, cols), editable, scrollPane,
                lastColumnFit);
    }

    /**
     * Creates a new packing table.
     *
     * @param tableModel Table data model
     * @param editable Whether the table should be editable or not
     * @param scrollPane Scrollpane parent
     */
    public PackingTable(final TableModel tableModel, final boolean editable,
            final JScrollPane scrollPane) {
        this(tableModel, editable, scrollPane, true);
    }

    /**
     * Creates a new packing table.
     *
     * @param tableModel Table data model
     * @param editable Whether the table should be editable or not
     * @param scrollPane Scrollpane parent
     * @param lastColumnFit Should the last column fit text (true),
     * or fit viewport (false).
     */
    public PackingTable(final TableModel tableModel, final boolean editable,
            final JScrollPane scrollPane, final boolean lastColumnFit) {
        super(tableModel);

        this.scrollPane = scrollPane;
        this.lastColumnFit = lastColumnFit;

        super.setAutoResizeMode(JTable.AUTO_RESIZE_OFF);
        super.getTableHeader().setResizingAllowed(false);
        super.getTableHeader().setReorderingAllowed(false);
        super.setDragEnabled(false);
    }

    /** {@inheritDoc} */
    @Override
    public void setAutoResizeMode(final int mode) {
    //Ignore
    }

    /** {@inheritDoc} */
    @Override
    public final boolean getScrollableTracksViewportHeight() {
        return getPreferredSize().height < getParent().getHeight();
    }

    /** {@inheritDoc} */
    @Override
    public final void paint(final Graphics g) {
        packColumns();
        super.paint(g);
    }

    /** Packs the columns to their width. */
    public final void packColumns() {
        if (!isShowing()) {
            return;
        }

        if (getColumnCount() == 0) {
            return;
        }

        final TableColumnModel myColumnModel = getTableHeader()
                .getColumnModel();
        final int numCols = myColumnModel.getColumnCount();
        final int totalSize = (int) (scrollPane.getViewportBorderBounds()
                .width * 0.99);
        final int[] widths = new int[numCols];
        int widthsTotal = 0;

        int checkNumCols = numCols;
        if (!lastColumnFit) {
            checkNumCols--;
        }
        
        for (int i = 0; i < checkNumCols; i++) { //NOPMD I'm not copying
            widths[i] = getWidth(i);
            widthsTotal += widths[i];
        }

        final int extra = totalSize - widthsTotal;
        if (extra > 0) {
            widths[numCols - 1] += extra;
        }

        for (int i = 0; i < numCols; i++) {
            final TableColumn col = myColumnModel.getColumn(i);
            col.setPreferredWidth(widths[i]);
        }

    }

    /**
     * Returns the width of a column.
     *
     * @param col Column to retrieve width for
     *
     * @return Width of the specified column
     */
    private int getWidth(final int col) {
        if (getColumnCount() == 0) {
            return 0;
        }
        if (getColumnCount() <= col) {
            return 0;
        }

        final TableColumn column = getColumnModel().getColumn(col);
        int width = (int) getTableHeader().getDefaultRenderer().
                getTableCellRendererComponent(this, column.getIdentifier(),
                false, false, -1, col).getPreferredSize().getWidth();

        if (getRowCount() == 0) {
            return width + padding;
        }

        for (int row = 0; row < getRowCount(); row++) {
            if (getCellRenderer(row, col) != null) {
                width = Math.max(width, (int) getCellRenderer(row, col).
                        getTableCellRendererComponent(this, getValueAt(row,
                        col), false, false, row, col).getPreferredSize().
                        getWidth());
            }
        }

        return width + padding;
    }
}