org.drugis.addis.gui.components.EnhancedTable.java Source code

Introduction

Here is the source code for org.drugis.addis.gui.components.EnhancedTable.java

Source

/*
 * This file is part of ADDIS (Aggregate Data Drug Information System).
 * ADDIS is distributed from http://drugis.org/.
 * Copyright (C) 2009 Gert van Valkenhoef, Tommi Tervonen.
 * Copyright (C) 2010 Gert van Valkenhoef, Tommi Tervonen, 
 * Tijs Zwinkels, Maarten Jacobs, Hanno Koeslag, Florin Schimbinschi, 
 * Ahmad Kamal, Daniel Reid.
 * Copyright (C) 2011 Gert van Valkenhoef, Ahmad Kamal, 
 * Daniel Reid, Florin Schimbinschi.
 * Copyright (C) 2012 Gert van Valkenhoef, Daniel Reid, 
 * Jol Kuiper, Wouter Reckman.
 *
 * 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, either version 3 of the License, or
 * (at your option) any later version.
 *
 * 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, see <http://www.gnu.org/licenses/>.
 */

package org.drugis.addis.gui.components;

import java.awt.Color;
import java.awt.Component;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;

import javax.swing.JTable;
import javax.swing.event.TableModelEvent;
import javax.swing.table.TableCellRenderer;
import javax.swing.table.TableModel;
import javax.swing.table.TableRowSorter;

import org.apache.commons.lang.StringUtils;
import org.drugis.addis.entities.Entity;
import org.drugis.addis.gui.util.TableCopyHandler;

@SuppressWarnings("serial")
public class EnhancedTable extends JTable {

    private static final class EntityRenderer implements TableCellRenderer {
        private final TableCellRenderer d_defaultRenderer;

        private EntityRenderer(TableCellRenderer defaultRenderer) {
            d_defaultRenderer = defaultRenderer;
        }

        @Override
        public Component getTableCellRendererComponent(JTable table, Object value, boolean isSelected,
                boolean hasFocus, int row, int column) {
            return d_defaultRenderer.getTableCellRendererComponent(table, getDescription(value, false), isSelected,
                    hasFocus, row, column);
        }

        private String getDescription(Object value, boolean nested) {
            if (value instanceof Entity) {
                return ((Entity) value).getLabel();
            }
            if (value instanceof Collection) {
                return getElementDescriptions((Collection<?>) value, nested);
            }
            return value == null ? "N/A" : value.toString();
        }

        private String getElementDescriptions(Collection<?> c, boolean nested) {
            List<String> desc = new ArrayList<String>();
            for (Object o : c) {
                desc.add(getDescription(o, true));
            }
            String str = StringUtils.join(desc, ", ");
            return nested ? ("[" + str + "]") : str;
        }
    }

    public static EnhancedTable createWithSorter(TableModel model) {
        EnhancedTable enhancedTable = createBare(model);
        TableRowSorter<TableModel> sorter = new TableRowSorter<TableModel>(model);
        enhancedTable.setRowSorter(sorter);
        return enhancedTable;
    }

    /**
     * Create a "bare" enhancedTable. You need to call autoSizeColumns() yourself.
     * @param model The table model.
     * @return A fully initialized EnhancedTable.
     */
    public static EnhancedTable createBare(TableModel model) {
        return new EnhancedTable(model);
    }

    private EnhancedTableHeader d_tableHeader;

    private EnhancedTable(TableModel model) {
        super(model);
        d_tableHeader = new TooltipTableHeader(model, getColumnModel(), this);
        setTableHeader(d_tableHeader);
        setBackground(Color.WHITE);
        setAutoResizeMode(JTable.AUTO_RESIZE_OFF);
        TableCopyHandler.registerCopyAction(this);
    }

    public void autoSizeColumns() {
        if (d_tableHeader != null) {
            d_tableHeader.autoSizeColumns();
        }
        setPreferredScrollableViewportSize(getPreferredSize());
    }

    public EnhancedTable(TableModel model, int maxColWidth) {
        this(model);
        d_tableHeader.setMaxColWidth(maxColWidth);
        autoSizeColumns();
    }

    @Override
    public void tableChanged(TableModelEvent e) {
        super.tableChanged(e);
        autoSizeColumns();
    }

    public static void insertEntityRenderer(JTable table) {
        final TableCellRenderer defaultRenderer = table.getDefaultRenderer(Object.class);
        EntityRenderer renderer = new EntityRenderer(defaultRenderer);
        table.setDefaultRenderer(Object.class, renderer);
        // Entity is an interface, and if something returns a sub-interface of Entity, that is not a sub-type of Object
        // Hence, we have to attach the renderer to Entity.class as well.
        table.setDefaultRenderer(Entity.class, renderer);
    }

    @Override
    public EnhancedTableHeader getTableHeader() {
        return d_tableHeader;
    }

}