edu.umd.cs.findbugs.gui2.SorterDialog Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of findbugs Show documentation
Findbugs: Because it's easy!
The newest version!
/*
 * FindBugs - Find Bugs in Java programs
 * Copyright (C) 2006, University of Maryland
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston MA 02111-1307, USA
 */

package edu.umd.cs.findbugs.gui2;

import java.awt.BorderLayout;
import java.awt.Cursor;
import java.awt.Dimension;
import java.awt.GridBagConstraints;
import java.awt.GridBagLayout;
import java.awt.Insets;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.util.ArrayList;

import javax.swing.JButton;
import javax.swing.JCheckBox;
import javax.swing.JLabel;
import javax.swing.JPanel;
import javax.swing.JScrollPane;
import javax.swing.JTable;
import javax.swing.event.ChangeEvent;
import javax.swing.event.ChangeListener;
import javax.swing.table.DefaultTableModel;
import javax.swing.table.JTableHeader;

/**
 * This is the window that pops up when the user double clicks on the sorting
 * table Its also available from the menu if they remove all Sortables.
 *
 * The user can choose what Sortables he wants to sort by, sort them into the
 * order he wants to see and then click apply to move his choices onto the
 * sorting table
 *
 * @author Dan
 *
 */
public class SorterDialog extends FBDialog {

    private JTableHeader preview;

    private final ArrayList checkBoxSortList = new ArrayList();

    JButton sortApply;

    public static SorterDialog getInstance() {
        return new SorterDialog();
    }

    @Override
    public void setVisible(boolean visible) {
        super.setVisible(visible);

        if (visible) {
            ((SorterTableColumnModel) (preview.getColumnModel())).createFrom(MainFrame.getInstance().getSorter());
            setSorterCheckBoxes();
        }
    }

    private SorterDialog() {
        setTitle("Group Bugs By...");
        add(createSorterPane());
        pack();
        setLocationByPlatform(true);
        setResizable(false);
        preview.setColumnModel(new SorterTableColumnModel(MainFrame.getInstance().getSorter().getOrder()));
    }

    class SortableCheckBox extends JCheckBox {
        final Sortables sortable;

        SortableCheckBox(Sortables s) {
            super(s == Sortables.DIVIDER ? edu.umd.cs.findbugs.L10N.getLocalString("sort.divider", "[divider]") : s.toString());
            this.sortable = s;
            addChangeListener(new ChangeListener() {
                @Override
                public void stateChanged(ChangeEvent e) {
                    ((SorterTableColumnModel) preview.getColumnModel()).setVisible(sortable, isSelected());
                }
            });
        }

    }

    /**
     * Creates JPanel with checkboxes of different things to sort by. List is:
     * priority, class, package, category, bugcode, status, and type.
     */
    private JPanel createSorterPane() {
        JPanel insidePanel = new JPanel();
        insidePanel.setLayout(new GridBagLayout());
        preview = new JTableHeader();
        Sortables[] sortables = MainFrame.getInstance().getAvailableSortables();
        preview.setColumnModel(new SorterTableColumnModel(sortables));

        for (Sortables s : sortables) {
            if (s != Sortables.DIVIDER) {
                checkBoxSortList.add(new SortableCheckBox(s));
            }
        }

        setSorterCheckBoxes();

        GridBagConstraints gbc = new GridBagConstraints();
        gbc.fill = GridBagConstraints.BOTH;
        gbc.gridx = 1;
        gbc.insets = new Insets(2,5,2,5);
        insidePanel.add(new JLabel("1. Choose bug properties"), gbc);
        insidePanel.add(new CheckBoxList<>(checkBoxSortList.toArray(new JCheckBox[checkBoxSortList.size()])), gbc);

        JTable t = new JTable(new DefaultTableModel(0, sortables.length));
        t.setTableHeader(preview);
        preview.setCursor(Cursor.getPredefinedCursor(Cursor.W_RESIZE_CURSOR));
        insidePanel.add(new JLabel("2. Drag and drop to change grouping priority"), gbc);
        insidePanel.add(createAppropriatelySizedScrollPane(t), gbc);

        sortApply = new JButton(edu.umd.cs.findbugs.L10N.getLocalString("dlg.apply_btn", "Apply"));
        sortApply.addActionListener(new ActionListener() {
            @Override
            public void actionPerformed(ActionEvent e) {
                MainFrame.getInstance().getSorter().createFrom((SorterTableColumnModel) preview.getColumnModel());
                ((BugTreeModel) MainFrame.getInstance().getTree().getModel()).checkSorter();
                SorterDialog.this.dispose();
            }
        });
        gbc.fill = GridBagConstraints.NONE;
        insidePanel.add(sortApply, gbc);

        JPanel sorter = new JPanel();
        sorter.setLayout(new BorderLayout());
        sorter.add(new JScrollPane(insidePanel), BorderLayout.CENTER);

        return sorter;
    }

    private JScrollPane createAppropriatelySizedScrollPane(JTable t) {
        JScrollPane sp = new JScrollPane(t);
        // This sets the height of the scrollpane so it is dependent on the
        // fontsize.
        int num = (int) (Driver.getFontSize() * 1.2);
        sp.setPreferredSize(new Dimension(670, 10 + num));
        return sp;
    }

    /**
     * Sets the checkboxes in the sorter panel to what is shown in the
     * MainFrame. This assumes that sorterTableColumnModel will return the list
     * of which box is checked in the same order as the order that sorter panel
     * has.
     */
    private void setSorterCheckBoxes() {

        SorterTableColumnModel sorter = MainFrame.getInstance().getSorter();

        for (SortableCheckBox c : checkBoxSortList) {
            c.setSelected(sorter.isShown(c.sortable));
        }
    }

    void freeze() {
        sortApply.setEnabled(false);
    }

    void thaw() {
        sortApply.setEnabled(true);
    }
}