org.rivalry.swingui.table.VisibleColumnsPopupMenu.java Source code

Introduction

Here is the source code for org.rivalry.swingui.table.VisibleColumnsPopupMenu.java

Source

//*****************************************************************************
// Rivalry (http://code.google.com/p/rivalry)
// Copyright (c) 2011 Rivalry.org
// Admin rivalry@jeffreythompson.net
//
// See the file "LICENSE.txt" for information on usage and redistribution of
// this file, and for a DISCLAIMER OF ALL WARRANTIES.
//*****************************************************************************
package org.rivalry.swingui.table;

import java.awt.Component;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.util.List;

import javax.swing.AbstractAction;
import javax.swing.Action;
import javax.swing.JCheckBoxMenuItem;
import javax.swing.JComponent;
import javax.swing.JMenu;
import javax.swing.JMenuItem;
import javax.swing.JPopupMenu;
import javax.swing.table.TableModel;

import org.apache.commons.lang.StringUtils;
import org.rivalry.core.model.Category;
import org.rivalry.core.model.Criterion;
import org.rivalry.core.model.RivalryData;

/**
 * Provides a popup menu for visible table columns.
 */
public class VisibleColumnsPopupMenu extends JPopupMenu {
    /**
     * Provides an action to set selection of all items in a menu.
     */
    private class SelectAllAction extends AbstractAction {
        /** Serial version UID. */
        private static final long serialVersionUID = 1L;

        /** Flag indicating whether the items should be selected. */
        private final boolean _isSelected;

        /** Menu. */
        private final JComponent _menu;

        /**
         * Construct this object with the given parameters.
         * 
         * @param text Action text.
         * @param menu Menu.
         * @param isSelected Flag indicating whether the items should be
         *            selected.
         */
        public SelectAllAction(final String text, final JComponent menu, final boolean isSelected) {
            super(text);

            _menu = menu;
            _isSelected = isSelected;
        }

        @Override
        public void actionPerformed(final ActionEvent event) {
            if (_menu instanceof JMenu) {
                clickAllCheckBoxes((JMenu) _menu);
            } else {
                clickAllCheckBoxes(_menu);
            }
        }

        /**
         * @param menu Menu.
         */
        private void clickAllCheckBoxes(final JComponent menu) {
            final int size = menu.getComponentCount();

            for (int i = 0; i < size; i++) {
                final Component component = menu.getComponent(i);

                if (component instanceof JMenu) {
                    clickAllCheckBoxes((JMenu) component);
                } else {
                    maybeDoClick(component);
                }
            }
        }

        /**
         * @param menu Menu.
         */
        private void clickAllCheckBoxes(final JMenu menu) {
            final int size = menu.getItemCount();

            for (int i = 0; i < size; i++) {
                final JMenuItem menuItem = menu.getItem(i);
                maybeDoClick(menuItem);
            }
        }

        /**
         * @param component Component.
         */
        private void maybeDoClick(final Component component) {
            if (component instanceof JCheckBoxMenuItem) {
                final JCheckBoxMenuItem checkBox = (JCheckBoxMenuItem) component;
                if (checkBox.isSelected() != _isSelected) {
                    final String columnName = checkBox.getText();
                    final boolean isVisible = _isSelected;
                    setColumnVisible(columnName, isVisible);
                    checkBox.setSelected(isVisible);
                }
            }
        }
    }

    /** Serial version UID. */
    private static final long serialVersionUID = 1L;

    /** Visible columns table model. */
    final VisibleColumnsTableModel _tableModel;

    /**
     * Construct this object with the given parameters.
     * 
     * @param rivalryData Rivalry data.
     * @param tableModel Table model.
     */
    public VisibleColumnsPopupMenu(final RivalryData rivalryData, final VisibleColumnsTableModel tableModel) {
        _tableModel = tableModel;

        if (rivalryData.getCategories().isEmpty()) {
            // Just add all the criteria.
            addMenuItems(this, rivalryData.getCriteria());
        } else {
            add(createSelectAllMenuItem(this));
            add(createSelectNoneMenuItem(this));
            addSeparator();

            // Add each category's criteria as a submenu.
            for (final Category category : rivalryData.getCategories()) {
                final JMenu menu = createMenu(category);
                add(menu);

                final List<Criterion> criteria = rivalryData.findCriteriaByCategory(category);
                addMenuItems(menu, criteria);
            }
        }
    }

    /**
     * @param columnName Column name.
     * 
     * @return the absolute column index.
     */
    int determineColumnIndex(final String columnName) {
        int answer = -1;

        if (StringUtils.isNotEmpty(columnName)) {
            final TableModel dataModel = _tableModel.getDataModel();
            final int size = dataModel.getColumnCount();

            for (int i = 0; answer < 0 && i < size; i++) {
                if (columnName.equals(dataModel.getColumnName(i))) {
                    answer = i;
                }
            }
        }

        return answer;
    }

    /**
     * @param columnName Column name.
     * @param isVisible Flag indicating if the column should be visible.
     */
    void setColumnVisible(final String columnName, final boolean isVisible) {
        final int absoluteColumnIndex = determineColumnIndex(columnName);
        _tableModel.setColumnVisible(absoluteColumnIndex, isVisible);
    }

    /**
     * @param menu Menu.
     * 
     * @param criteria Criteria.
     */
    private void addMenuItems(final JComponent menu, final List<Criterion> criteria) {
        menu.add(createSelectAllMenuItem(menu));
        menu.add(createSelectNoneMenuItem(menu));
        if (menu == this) {
            ((JPopupMenu) menu).addSeparator();
        } else if (menu instanceof JMenu) {
            ((JMenu) menu).addSeparator();
        }

        for (final Criterion criterion : criteria) {
            menu.add(createMenuItem(criterion));
        }
    }

    /**
     * @return a new action listener.
     */
    private ActionListener createActionListener() {
        return new ActionListener() {
            @Override
            public void actionPerformed(final ActionEvent event) {
                final JCheckBoxMenuItem source = (JCheckBoxMenuItem) event.getSource();

                // Change the column visibility in the table model.
                final String columnName = source.getText();
                final boolean isVisible = source.isSelected();
                setColumnVisible(columnName, isVisible);
            }
        };
    }

    /**
     * @param category Category.
     * 
     * @return a new menu.
     */
    private JMenu createMenu(final Category category) {
        final JMenu answer = new JMenu(category.getName());

        return answer;
    }

    /**
     * @param criterion Criterion.
     * 
     * @return a new menu item.
     */
    private JMenuItem createMenuItem(final Criterion criterion) {
        final String columnName = criterion.getName();
        final JCheckBoxMenuItem answer = new JCheckBoxMenuItem(columnName);

        final boolean isVisible = _tableModel.isColumnVisible(columnName);
        answer.setSelected(isVisible);
        answer.addActionListener(createActionListener());

        return answer;
    }

    /**
     * @param menu Menu.
     * 
     * @return a new menu item.
     */
    private JMenuItem createSelectAllMenuItem(final JComponent menu) {
        final Action actionSelected = new SelectAllAction("Select All", menu, true);

        final JMenuItem answer = new JMenuItem(actionSelected);

        return answer;
    }

    /**
     * @param menu Menu.
     * 
     * @return a new menu item.
     */
    private JMenuItem createSelectNoneMenuItem(final JComponent menu) {
        final Action actionUnselected = new SelectAllAction("Select None", menu, false);

        final JMenuItem answer = new JMenuItem(actionUnselected);

        return answer;
    }
}