main page modules namespaces classes files
Gecode/J home

MenuBar.java

Go to the documentation of this file.

/* -*- indent-tabs-mode: nil -*- */
/*
 *  Main authors:
 *     Mikael Lagerkvist <lagerkvist@gecode.org>
 *     Guido Tack <tack@gecode.org>
 *
 *  Copyright:
 *     Mikael Lagerkvist, 2006
 *     Guido Tack, 2006
 *
 *  Last modified:
 *     $Date: 2007-08-09 16:00:10 +0200 (Thu, 09 Aug 2007) $ by $Author: tack $
 *     $Revision: 4792 $
 *
 *  This file is part of Gecode, the generic constraint
 *  development environment:
 *     http://www.gecode.org
 *
 *  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 org.gecode.gist.swing;

import org.gecode.gist.*;
import java.awt.event.ActionEvent;
import javax.swing.*;
import java.util.Enumeration;

class MenuBar extends JMenuBar {

    protected Action resetAction;
    protected Action saveAsAction;
    protected Action inspectAction;
    protected Action inspectBranchesAction;
    protected Action inspectBPAction;
    protected Action searchAllAction;
    protected Action searchOneAction;
    protected Action searchNAction;
    protected Action hideNodeAction;
    protected Action hideFailedAction;
    protected Action unhideAllAction;
    protected Action scaleToFitAction;
    
    protected Action navUpAction;
    protected Action navDownAction;
    protected Action navLeftAction;
    protected Action navRightAction;

    protected Action jumpNextSolAction;
    protected Action jumpPrevSolAction;
    protected Action jumpRootAction;
    protected Action jumpLeftmostAction;
    protected Action jumpRightmostAction;
    protected Action centerCursorAction;

    protected Action configAction;
    protected Action quitAction;

    private JPopupMenu pop;

    private GistController _ctrl;

    protected ButtonGroup inspectionActionsGroup;
    protected JMenu actionsMenu;

    public class ResetAction extends AbstractAction {
        public ResetAction() {
            super("Reset");
            putValue(SHORT_DESCRIPTION, "Reset the tree");
        }
        public void actionPerformed(ActionEvent e) {
            _ctrl.reset();
        }
    }
    public class SaveAsAction extends AbstractAction {
      public SaveAsAction() {
            super("Save as");
            putValue(SHORT_DESCRIPTION, "Save the tree as postscript");
      }
      public void actionPerformed(ActionEvent e) {
        _ctrl.saveAs();
      }
    }

    public class SelectInspectionAction extends AbstractAction {
        private String action;
        public SelectInspectionAction(String s) {
            super(s);
            action = s;
        }
        public void actionPerformed(ActionEvent e) {
            _ctrl.selectInspectionAction(action);
        }
    }
    public class InspectAction extends AbstractAction {
        public InspectAction() {
            super("Inspect");
            putValue(SHORT_DESCRIPTION, "Inspect the current node");
        }
        public void actionPerformed(ActionEvent e) {
            _ctrl.inspect();
        }
    }
    public class InspectBranchesAction extends AbstractAction {
        public InspectBranchesAction() {
            super("Inspect Branches");
            putValue(SHORT_DESCRIPTION, "Inspect branches of the current node");
        }
        public void actionPerformed(ActionEvent e) {
            _ctrl.inspectBranches();
        }
    }
    public class InspectBPAction extends AbstractAction {
        public InspectBPAction() {
            super("Inspect before propagation");
            putValue(SHORT_DESCRIPTION, "Inspect the current node before propagation");
        }
        public void actionPerformed(ActionEvent e) {
            _ctrl.inspectBeforePropagation();
        }
    }
    public class SearchAllAction extends AbstractAction {
        public SearchAllAction() {
            super("Search all");
            putValue(SHORT_DESCRIPTION, "Search all solutions");
        }
        public void actionPerformed(ActionEvent e) {
            _ctrl.exploreAll();
        }
    }
    public class SearchOneAction extends AbstractAction {
        public SearchOneAction() {
            super("Search one");
            putValue(SHORT_DESCRIPTION, "Search one solution");
        }
        public void actionPerformed(ActionEvent e) {
            _ctrl.exploreOne();
        }
    }
    public class SearchNAction extends AbstractAction {
        public SearchNAction() {
            super("Search n");
            putValue(SHORT_DESCRIPTION, "Search n solutions");
        }
        public void actionPerformed(ActionEvent e) {
            _ctrl.exploreN();
        }
    }
    public class HideNodeAction extends AbstractAction {
        public HideNodeAction() {
            super("(Un)hide node");
            putValue(SHORT_DESCRIPTION, "(Un)hide node");
        }
        public void actionPerformed(ActionEvent e) {
            _ctrl.toggleHidden();
        }
    }
    public class HideFailedAction extends AbstractAction {
        public HideFailedAction() {
            super("Hide failed");
            putValue(SHORT_DESCRIPTION, "Hide failed");
        }
        public void actionPerformed(ActionEvent e) {
            _ctrl.hideFailed();
        }
    }
    public class UnhideAllAction extends AbstractAction {
        public UnhideAllAction() {
            super("Unhide all");
            putValue(SHORT_DESCRIPTION, "Unhide all");
        }
        public void actionPerformed(ActionEvent e) {
            _ctrl.unhideAll();
        }
    }
    public class ScaleToFitAction extends AbstractAction {
        public ScaleToFitAction() {
            super("Scale to fit");
            putValue(SHORT_DESCRIPTION, "Scale to fit");
        }
        public void actionPerformed(ActionEvent e) {
            _ctrl.scaleToFit();
        }
    }

    // Navigation actions
    public class NavUpAction extends AbstractAction {
        public NavUpAction() {
            super("Up");
            putValue(SHORT_DESCRIPTION, "Navigate upwards");
        }
        public void actionPerformed(ActionEvent e) {
            _ctrl.navUp();
        }
    }
    public class NavDownAction extends AbstractAction {
        public NavDownAction() {
            super("Down");
            putValue(SHORT_DESCRIPTION, "Navigate downwards");
        }
        public void actionPerformed(ActionEvent e) {
            _ctrl.navDown();
        }
    }
    public class NavLeftAction extends AbstractAction {
        public NavLeftAction() {
            super("Left");
            putValue(SHORT_DESCRIPTION, "Navigate left");
        }
        public void actionPerformed(ActionEvent e) {
            _ctrl.navLeft();
        }
    }
    public class NavRightAction extends AbstractAction {
        public NavRightAction() {
            super("Right");
            putValue(SHORT_DESCRIPTION, "Navigate right");
        }
        public void actionPerformed(ActionEvent e) {
            _ctrl.navRight();
        }
    }

    public class JumpNextSolAction extends AbstractAction {
        public JumpNextSolAction() {
            super("Jump to next solution");
            putValue(SHORT_DESCRIPTION, "Jump to next solution");
        }
        public void actionPerformed(ActionEvent e) {
            _ctrl.jumpNextSol();
        }
    }
    public class JumpPrevSolAction extends AbstractAction {
        public JumpPrevSolAction() {
            super("Jump to previous solution");
            putValue(SHORT_DESCRIPTION, "Jump to previous solution");
        }
        public void actionPerformed(ActionEvent e) {
            _ctrl.jumpPrevSol();
        }
    }

    public class JumpRootAction extends AbstractAction {
        public JumpRootAction() {
            super("Jump to root node");
            putValue(SHORT_DESCRIPTION, "Jump to root node");
        }
        public void actionPerformed(ActionEvent e) {
            _ctrl.jumpRoot();
        }
    }
    public class JumpLeftmostAction extends AbstractAction {
        public JumpLeftmostAction() {
            super("Leftmost");
            putValue(SHORT_DESCRIPTION, "Jump to leftmost node");
        }
        public void actionPerformed(ActionEvent e) {
            _ctrl.jumpLeftmost();
        }
    }
    public class JumpRightmostAction extends AbstractAction {
        public JumpRightmostAction() {
            super("Rightmost");
            putValue(SHORT_DESCRIPTION, "Jump to rightmost node");
        }
        public void actionPerformed(ActionEvent e) {
            _ctrl.jumpRightmost();
        }
    }
    public class CenterCursorAction extends AbstractAction {
        public CenterCursorAction() {
            super("Center current node");
            putValue(SHORT_DESCRIPTION,
                     "Center view on current node (if possible)");
        }
        public void actionPerformed(ActionEvent e) {
            _ctrl.centerCursor();
        }
    }


    public class AboutAction extends AbstractAction {
        private AboutWindow aw;
        public AboutAction(JFrame f) {
            super("About");
            aw = new AboutWindow(f);
            putValue(SHORT_DESCRIPTION, "About Gecode/J Gist");
        }
        public void actionPerformed(ActionEvent e) {
            aw.open();
        }
    }

    public class HelpAction extends AbstractAction {
        private HelpWindow hw;
        public HelpAction(JFrame f) {
            super("Help");
            hw = new HelpWindow(f);
            putValue(SHORT_DESCRIPTION, "Help on the Gecode/J Gist");
        }
        public void actionPerformed(ActionEvent e) {
            hw.open();
        }
    }

    public class ConfigAction extends AbstractAction {
        private ConfigDialog cd;
        public ConfigAction(JFrame f) {
            super("Preferences");
            cd = new ConfigDialog(f);
            putValue(SHORT_DESCRIPTION, "Preferences for the Gecode/J Gist");
        }
        public void actionPerformed(ActionEvent e) {
            cd.open();
        }
    }

    // System actions
    public class QuitAction extends AbstractAction {
        public QuitAction() {
            super("Quit");
            putValue(SHORT_DESCRIPTION, "Quit Gecode Gist");
        }
        public void actionPerformed(ActionEvent e) {
            System.exit(0);
        }
    }



    public MenuBar(JFrame frame, GistController ctrl) {
        _ctrl = ctrl;

        JMenuItem menuItem = null;

        resetAction = new ResetAction();
        saveAsAction = new SaveAsAction();
        inspectAction = new InspectAction();
        inspectBranchesAction = new InspectBranchesAction();
        inspectBPAction = new InspectBPAction();
        searchAllAction = new SearchAllAction();
        searchOneAction = new SearchOneAction();
        searchNAction = new SearchNAction();
        hideNodeAction = new HideNodeAction();
        hideFailedAction = new HideFailedAction();
        unhideAllAction = new UnhideAllAction();
        scaleToFitAction = new ScaleToFitAction();

        navUpAction = new NavUpAction();
        navDownAction = new NavDownAction();
        navLeftAction = new NavLeftAction();
        navRightAction = new NavRightAction();

        jumpNextSolAction = new JumpNextSolAction();
        jumpPrevSolAction = new JumpPrevSolAction();
        jumpRootAction = new JumpRootAction();
        jumpLeftmostAction = new JumpLeftmostAction();
        jumpRightmostAction = new JumpRightmostAction();
        centerCursorAction = new CenterCursorAction();

        configAction = new ConfigAction(frame);
        quitAction = new QuitAction();

        JMenu fileMenu = new JMenu("File");
        JMenu nodeMenu = new JMenu("Node");
        JMenu searchMenu = new JMenu("Search");
        JMenu helpMenu = new JMenu("Help");

        actionsMenu = new JMenu("Inspection actions");

        menuItem = new JMenuItem(new HelpAction(frame));
        helpMenu.add(menuItem);
        menuItem = new JMenuItem(new AboutAction(frame));
        helpMenu.add(menuItem);

        pop = new JPopupMenu();

        menuItem = new JMenuItem(resetAction);
        menuItem.setIcon(null); //arbitrarily chose not to use icon
        menuItem.setAccelerator(KeyStroke.getKeyStroke("control R"));
        fileMenu.add(menuItem);


        menuItem = new JMenuItem(saveAsAction);
        menuItem.setIcon(null); //arbitrarily chose not to use icon
        menuItem.setAccelerator(KeyStroke.getKeyStroke("control S"));
        fileMenu.add(menuItem);

        updateEventListeners();
        nodeMenu.add(actionsMenu);

        menuItem = new JMenuItem(inspectAction);
        menuItem.setIcon(null); //arbitrarily chose not to use icon
        menuItem.setAccelerator(KeyStroke.getKeyStroke("ENTER"));
        nodeMenu.add(menuItem);

        menuItem = new JMenuItem(inspectBranchesAction);
        menuItem.setIcon(null); //arbitrarily chose not to use icon
        menuItem.setAccelerator(KeyStroke.getKeyStroke("control ENTER"));
        nodeMenu.add(menuItem);

        menuItem = new JMenuItem(inspectBPAction);
        menuItem.setIcon(null); //arbitrarily chose not to use icon
        menuItem.setAccelerator(KeyStroke.getKeyStroke("control shift ENTER"));
        nodeMenu.add(menuItem);

        menuItem = new JMenuItem(searchAllAction);
        menuItem.setIcon(null); //arbitrarily chose not to use icon
        menuItem.setAccelerator(KeyStroke.getKeyStroke("A"));
        searchMenu.add(menuItem);

        menuItem = new JMenuItem(searchOneAction);
        menuItem.setIcon(null); //arbitrarily chose not to use icon
        menuItem.setAccelerator(KeyStroke.getKeyStroke("1"));
        searchMenu.add(menuItem);

        menuItem = new JMenuItem(searchNAction);
        menuItem.setIcon(null); //arbitrarily chose not to use icon
        menuItem.setAccelerator(KeyStroke.getKeyStroke("N"));
        searchMenu.add(menuItem);

        menuItem = new JMenuItem(hideNodeAction);
        menuItem.setIcon(null); //arbitrarily chose not to use icon
        menuItem.setAccelerator(KeyStroke.getKeyStroke("H"));
        nodeMenu.add(menuItem);

        menuItem = new JMenuItem(hideFailedAction);
        menuItem.setIcon(null); //arbitrarily chose not to use icon
        menuItem.setAccelerator(KeyStroke.getKeyStroke("F"));
        nodeMenu.add(menuItem);

        menuItem = new JMenuItem(unhideAllAction);
        menuItem.setIcon(null); //arbitrarily chose not to use icon
        menuItem.setAccelerator(KeyStroke.getKeyStroke("U"));
        nodeMenu.add(menuItem);

        nodeMenu.addSeparator();
        menuItem = new JMenuItem(navUpAction);
        menuItem.setIcon(null); //arbitrarily chose not to use icon
        menuItem.setAccelerator(KeyStroke.getKeyStroke("control UP"));
        nodeMenu.add(menuItem);
        menuItem = new JMenuItem(navDownAction);
        menuItem.setIcon(null); //arbitrarily chose not to use icon
        menuItem.setAccelerator(KeyStroke.getKeyStroke("control DOWN"));
        nodeMenu.add(menuItem);
        menuItem = new JMenuItem(navLeftAction);
        menuItem.setIcon(null); //arbitrarily chose not to use icon
        menuItem.setAccelerator(KeyStroke.getKeyStroke("control LEFT"));
        nodeMenu.add(menuItem);
        menuItem = new JMenuItem(navRightAction);
        menuItem.setIcon(null); //arbitrarily chose not to use icon
        menuItem.setAccelerator(KeyStroke.getKeyStroke("control RIGHT"));
        nodeMenu.add(menuItem);

        nodeMenu.addSeparator();
        menuItem = new JMenuItem(jumpNextSolAction);
        menuItem.setIcon(null); //arbitrarily chose not to use icon
        menuItem.setAccelerator(KeyStroke.getKeyStroke("J"));
        nodeMenu.add(menuItem);
        menuItem = new JMenuItem(jumpPrevSolAction);
        menuItem.setIcon(null); //arbitrarily chose not to use icon
        menuItem.setAccelerator(KeyStroke.getKeyStroke("shift J"));
        nodeMenu.add(menuItem);
        menuItem = new JMenuItem(jumpRootAction);
        menuItem.setIcon(null); //arbitrarily chose not to use icon
        menuItem.setAccelerator(KeyStroke.getKeyStroke("R"));
        nodeMenu.add(menuItem);
        menuItem = new JMenuItem(jumpLeftmostAction);
        menuItem.setIcon(null); //arbitrarily chose not to use icon
        menuItem.setAccelerator(KeyStroke.getKeyStroke('-'));
        nodeMenu.add(menuItem);
        menuItem = new JMenuItem(jumpRightmostAction);
        menuItem.setIcon(null); //arbitrarily chose not to use icon
        menuItem.setAccelerator(KeyStroke.getKeyStroke('+'));
        nodeMenu.add(menuItem);
        menuItem = new JMenuItem(centerCursorAction);
        menuItem.setIcon(null); //arbitrarily chose not to use icon
        menuItem.setAccelerator(KeyStroke.getKeyStroke("C"));
        nodeMenu.add(menuItem);

        menuItem = new JMenuItem(scaleToFitAction);
        menuItem.setIcon(null); //arbitrarily chose not to use icon
        menuItem.setAccelerator(KeyStroke.getKeyStroke("Z"));
        fileMenu.add(menuItem);

        //menuItem = new JMenuItem("Preferences");
        //menuItem.setEnabled(false);
        menuItem = new JMenuItem(configAction);
        menuItem.setIcon(null); //arbitrarily chose not to use icon
        menuItem.setAccelerator(KeyStroke.getKeyStroke("control P"));
        fileMenu.add(menuItem);

        menuItem = new JMenuItem(quitAction);
        menuItem.setIcon(null); //arbitrarily chose not to use icon
        menuItem.setAccelerator(KeyStroke.getKeyStroke("control Q"));
        fileMenu.add(menuItem);

        //Set up the menu bar.
        add(fileMenu);
        add(nodeMenu);
        add(searchMenu);
        add(helpMenu);


        //Set up the popup menu
        pop.add(new JMenuItem(searchAllAction));
        pop.add(new JMenuItem(searchOneAction));
        pop.add(new JMenuItem(searchNAction));
        pop.add(new JMenuItem(hideNodeAction));
        pop.add(new JMenuItem(hideFailedAction));
        pop.add(new JMenuItem(unhideAllAction));
        pop.add(new JMenuItem(inspectBranchesAction));
        pop.add(new JMenuItem(inspectBPAction));

        pop.pack();
    }

    JPopupMenu getPopupMenu() {
        return pop;
    }

    // Methods for controlling disabling and enabling of menu entries
    public void menuInspectActive(boolean active, boolean isRoot, boolean isLeaf) {
        inspectAction.setEnabled(active);
        inspectBPAction.setEnabled(!isRoot);
        inspectBranchesAction.setEnabled(active && !isLeaf);
    }
    public void menuSearchActive(boolean active) {
        searchNAction.setEnabled(active);
        searchOneAction.setEnabled(active);
        searchAllAction.setEnabled(active);
    }
    public void menuHideNodeActive(boolean active, boolean hidden) {
        hideNodeAction.setEnabled(active);
    }
    public void menuUnhideAllActive(boolean active) {
        unhideAllAction.setEnabled(active);
    }
    public void menuHideFailedActive(boolean active) {
        hideFailedAction.setEnabled(active);
    }

    // Handling event listeners
    public void updateEventListeners() {
        updateEventListeners(_ctrl.getListeners(), _ctrl.getSelectedAction());
    }
    private void updateEventListeners(Enumeration<String> es,
                                      String selectedAction) {
        actionsMenu.removeAll();
        JRadioButtonMenuItem menuItem;
        menuItem =
            new JRadioButtonMenuItem(new SelectInspectionAction("default"));
        menuItem.setIcon(null); //arbitrarily chose not to use icon
        actionsMenu.add(menuItem);
        inspectionActionsGroup = new ButtonGroup();
        inspectionActionsGroup.add(menuItem);
        if (selectedAction.equals("default")) {
            menuItem.setSelected(true);
        }
        while (es.hasMoreElements()) {
            String name = es.nextElement();
            SelectInspectionAction sia =
                new SelectInspectionAction(name);
            menuItem =
                new JRadioButtonMenuItem(sia);
            menuItem.setIcon(null); //arbitrarily chose not to use icon
            actionsMenu.add(menuItem);
            inspectionActionsGroup.add(menuItem);
            if (selectedAction.equals(name)) {
                menuItem.setSelected(true);
            }
        }
    }
    
}