ColumnSelectionMenu.java

package com.limegroup.gnutella.gui.tables;

import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;

import javax.swing.JCheckBoxMenuItem;
import javax.swing.JMenu;
import javax.swing.JMenuItem;
import javax.swing.JPopupMenu;

import com.limegroup.gnutella.gui.GUIMediator;
import com.limegroup.gnutella.settings.BooleanSetting;
import com.limegroup.gnutella.settings.QuestionsHandler;

/**
 * Simple popup menu that shows the current columns,
 * and allows the user to display/hide them
 * @author Sam Berlin
 *  idea from the getColumnSelectionMenu in /search/TableColumnFilter
 */
public class ColumnSelectionMenu {

    /**
     * The string used to signify the columnId property
     */
    protected static final String COLUMN_ID = "columnId";
    
    /**
     * The string used to signify the Setting property
     */
    protected static final String SETTING = "setting";
    
    /**
     * The SettingListener to use for all menus.
     */
    protected static final ActionListener SETTING_LISTENER =
        new SettingListener(); 

    /**
     * Revert to default string
     */
    private static final String REVERT_DEFAULT =
        GUIMediator.getStringResource("GENERAL_REVERT_TO_DEFAULT");
        
    /**
     * More Options menu item.
     */
    public static final String MORE_OPTIONS =
        GUIMediator.getStringResource("GENERAL_MORE_OPTIONS");
        
    /**
     * Setting for row stripes.
     */
    public static final String ROWSTRIPE =
        GUIMediator.getStringResource("TABLES_USE_ROWSTRIPE");
        
    /**
     * Setting for real-time sorting.
     */
    public static final String SORTING =
        GUIMediator.getStringResource("TABLES_REAL_TIME_SORTING");
        
    /**
     * Setting for displaying tooltips. 
     */
    public static final String TOOLTIPS =
        GUIMediator.getStringResource("TABLES_DISPLAY_TOOLTIPS");

    /**
     * The actual popup menu.
     */
    protected final JPopupMenu _menu = new JPopupMenu();

    /**
     * The LimeJTable this menu is associated with
     */
    private final LimeJTable _table;

    /**
     * Constructs the popupmenu & actionlistener associated with the
     * table & model.
     */
    public ColumnSelectionMenu(LimeJTable table) {
        _table = table;
        DataLineModel model = (DataLineModel)_table.getModel();

        // add the 'revert to default' option.
        ActionListener reverter = new ReverterListener();
        JMenuItem revert = new JMenuItem(REVERT_DEFAULT);
        ColumnPreferenceHandler cph = _table.getColumnPreferenceHandler();
        TableSettings settings = _table.getTableSettings();        
        //if there is no preferences handler or the values are already default,
        //disable the option
        if( (cph == null || cph.isDefault()) &&
            (settings == null || settings.isDefault()) )
            revert.setEnabled(false);
        else
            revert.addActionListener(reverter);
        _menu.add(revert);
        
        // Add the options options menu.
        if( settings != null ) {
            JMenu options = createMoreOptions(settings);
            _menu.add(options);
        }
        
        _menu.addSeparator();
        
        addTableColumnChoices(new SelectionActionListener(), model, table);
    }
    
    /**
     * Adds the table choices.
     */
    protected void addTableColumnChoices(ActionListener listener,
                                         DataLineModel model,
                                         LimeJTable table) {
        for( int i = 0; i < model.getColumnCount(); i++) {
            JMenuItem item = createColumnMenuItem(listener, model, table, i);
            _menu.add( item );
        }
    }
    
    /**
     * Creates a single menu item for a column.
     */
    protected JMenuItem createColumnMenuItem(ActionListener listener,
                                             DataLineModel model,
                                             LimeJTable table,
                                             int i) {
        Object id = model.getColumnId(i);
        String name = model.getColumnName(i);
        JCheckBoxMenuItem item =
            new JCheckBoxMenuItem( name, table.isColumnVisible(id) );
        item.putClientProperty( COLUMN_ID, id );
        item.addActionListener( listener );
        return item;
    }
    
    /**
     * Returns a JMenu with the 'More Options' options tied to settings.
     */
    public static JMenu createMoreOptions(TableSettings settings) {
        JMenu options = new JMenu(MORE_OPTIONS);
        addSetting(options, ROWSTRIPE, settings.ROWSTRIPE);
        addSetting(options, SORTING, settings.REAL_TIME_SORT);
        addSetting(options, TOOLTIPS, settings.DISPLAY_TOOLTIPS);
        return options;
    }
    
    /**
     * Creates & adds a checkbox-setting with a listener.
     */
    public static JMenuItem addSetting(JMenu parent, 
                                       final String name,
                                       BooleanSetting setting) {
        JMenuItem item = new JCheckBoxMenuItem(name, setting.getValue());
        item.putClientProperty(SETTING, setting);
        item.addActionListener(SETTING_LISTENER);
        parent.add(item);
        return item;
    }

    /**
     * Returns the popup menu
     */
    public JPopupMenu getComponent() { return _menu; }


    /**
     * Simple ActionListener class that will display/hide a column
     * based on the columnId property of the source.
     */
    protected class SelectionActionListener implements ActionListener {

        public void actionPerformed(ActionEvent e) {
            JCheckBoxMenuItem item = (JCheckBoxMenuItem)e.getSource();
            try {
               _table.setColumnVisible( item.getClientProperty(COLUMN_ID), 
                   item.getState() );
               _table.getTableHeader().setDraggedColumn(null);
            } catch (LastColumnException ee) {
               GUIMediator.showError("ERROR_REMOVE_LAST_COL",
                   QuestionsHandler.REMOVE_LAST_COLUMN);
            }
        }
    }

    /**
     * Simple class that calls 'revertToDefault' on the ColumnPreferenceHandler
     * of the LimeJTable
     */
    protected class ReverterListener implements ActionListener {
        public void actionPerformed(ActionEvent e) {
            _table.getColumnPreferenceHandler().revertToDefault();
            _table.getTableSettings().revertToDefault();
        }
    }
    
    /**
     * Simple class that deals with setting/unsetting settings.
     */
    protected static class SettingListener implements ActionListener {
        public void actionPerformed(ActionEvent e) {
            JCheckBoxMenuItem item = (JCheckBoxMenuItem)e.getSource();
            BooleanSetting setting =
                (BooleanSetting)item.getClientProperty(SETTING);
            setting.setValue(item.getState());
        }
    }
}