edu.cmu.tetradapp.editor.GraphToolbar Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of tetrad-gui Show documentation
The newest version!
///////////////////////////////////////////////////////////////////////////////
// For information as to what this class does, see the Javadoc, below.       //
// Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,       //
// 2007, 2008, 2009, 2010, 2014, 2015, 2022 by Peter Spirtes, Richard        //
// Scheines, Joseph Ramsey, and Clark Glymour.                               //
//                                                                           //
// 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 2 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, write to the Free Software               //
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA //
///////////////////////////////////////////////////////////////////////////////

package edu.cmu.tetradapp.editor;

import edu.cmu.tetradapp.util.ImageUtils;
import edu.cmu.tetradapp.workbench.AbstractWorkbench;
import edu.cmu.tetradapp.workbench.GraphWorkbench;

import javax.swing.*;
import javax.swing.border.EmptyBorder;
import java.awt.*;
import java.beans.PropertyChangeEvent;
import java.beans.PropertyChangeListener;

/**
 * This is the toolbar for the GraphEditor.  Its tools are as follows:   The 'move' tool, allows the user to
 * select and move items in the workbench workbench. 
 The 'addObserved' tool, allows the user to add new observed
 * variables. 
 The 'addLatent' tool, allows the user to add new latent variables. 
 The 'addDirectedEdge' tool,
 * allows the user to add new directed edges. 
 The 'addNondirectedEdge' tool, allows the user to add new nondirected
 * edges. 
 The 'addPartiallyOrientedEdge' tool, allows the user to create new partially oriented edges. 
 The
 * 'addBidirectedEdge' tool, allows the user to create new bidirected edges. 
 *
 * @author Donald Crimbchin
 * @author josephramsey
 * @version $Id: $Id
 * @see GraphEditor
 */
public class GraphToolbar extends JPanel implements PropertyChangeListener {

    /**
     * The mutually exclusive button group for the buttons.
     */
    private final ButtonGroup group;

    /**
     * The panel that the buttons are in.
     */
    private final Box buttonsPanel = Box.createVerticalBox();

    /**
     * The buttons in the toolbar.
     */
    private final JToggleButton move;

    /**
     * The add observed button.
     */
    private final JToggleButton addObserved;

    /**
     * The add latent button.
     */
    private final JToggleButton addLatent;

    /**
     * The add directed edge button.
     */
    private final JToggleButton addDirectedEdge;

    /**
     * The add nondirected edge button.
     */
    private final JToggleButton addNondirectedEdge;

    /**
     * The add undirected edge button.
     */
    private final JToggleButton addUndirectedEdge;

    /**
     * The add partially oriented edge button.
     */
    private final JToggleButton addPartiallyOrientedEdge;

    /**
     * The add bidirected edge button.
     */
    private final JToggleButton addBidirectedEdge;

    /**
     * The workbench this toolbar governs.
     */
    private final GraphWorkbench workbench;

    /**
     * Constructs a new Graph toolbar governing the modes of the given GraphWorkbench.
     *
     * @param workbench a {@link edu.cmu.tetradapp.workbench.GraphWorkbench} object
     */
    public GraphToolbar(GraphWorkbench workbench) {
        if (workbench == null) {
            throw new NullPointerException();
        }

        this.workbench = workbench;
        this.group = new ButtonGroup();

        setLayout(new BoxLayout(this, BoxLayout.X_AXIS));
        this.buttonsPanel.setBorder(new EmptyBorder(10, 10, 10, 10));
        add(this.buttonsPanel);

        // construct the bottons.
        this.move = new JToggleButton();
        this.addObserved = new JToggleButton();
        this.addLatent = new JToggleButton();
        this.addNondirectedEdge = new JToggleButton();
        this.addDirectedEdge = new JToggleButton();
        this.addUndirectedEdge = new JToggleButton();
        this.addPartiallyOrientedEdge = new JToggleButton();
        this.addBidirectedEdge = new JToggleButton();

        // Apparently it's not acting like this anymore, and recently the
        // focus listeners have caused some weird behavior, so commenting
        // them out. jdramsey 2014.02.28
//        // Adding this listener fixes a previous bug where if you
//        // select a button and then move the mouse away from the
//        // button without releasing the mouse it would deselect. J
//        // Ramsey 11/02/01
//        FocusListener focusListener = new FocusAdapter() {
//            public void focusGained(FocusEvent e) {
//                JToggleButton component = (JToggleButton) e.getComponent();
//                component.doClick();
//            }
//        };

//        move.addFocusListener(focusListener);
//        addObserved.addFocusListener(focusListener);
//        addLatent.addFocusListener(focusListener);
//        addNondirectedEdge.addFocusListener(focusListener);
//        addDirectedEdge.addFocusListener(focusListener);
//        addPartiallyOrientedEdge.addFocusListener(focusListener);
//        addBidirectedEdge.addFocusListener(focusListener);

        // add listeners
        this.move.addActionListener(e -> {
            GraphToolbar.this.move.getModel().setSelected(true);
            setWorkbenchMode(AbstractWorkbench.SELECT_MOVE);
        });

        this.addObserved.addActionListener(e -> {
            GraphToolbar.this.addObserved.getModel().setSelected(true);
            setWorkbenchMode(AbstractWorkbench.ADD_NODE);
            setNodeMode(GraphWorkbench.MEASURED_NODE);
        });

        this.addLatent.addActionListener(e -> {
            GraphToolbar.this.addLatent.getModel().setSelected(true);
            setWorkbenchMode(AbstractWorkbench.ADD_NODE);
            setNodeMode(GraphWorkbench.LATENT_NODE);
        });

        this.addDirectedEdge.addActionListener(e -> {
            GraphToolbar.this.addDirectedEdge.getModel().setSelected(true);
            setWorkbenchMode(AbstractWorkbench.ADD_EDGE);
            setEdgeMode(GraphWorkbench.DIRECTED_EDGE);
        });

        this.addNondirectedEdge.addActionListener(e -> {
            GraphToolbar.this.addNondirectedEdge.getModel().setSelected(true);
            setWorkbenchMode(AbstractWorkbench.ADD_EDGE);
            setEdgeMode(GraphWorkbench.NONDIRECTED_EDGE);
        });

        this.addUndirectedEdge.addActionListener(e -> {
            GraphToolbar.this.addUndirectedEdge.getModel().setSelected(true);
            setWorkbenchMode(AbstractWorkbench.ADD_EDGE);
            setEdgeMode(GraphWorkbench.UNDIRECTED_EDGE);
        });

        this.addPartiallyOrientedEdge.addActionListener(e -> {
            GraphToolbar.this.addPartiallyOrientedEdge.getModel().setSelected(true);
            setWorkbenchMode(AbstractWorkbench.ADD_EDGE);
            setEdgeMode(GraphWorkbench.PARTIALLY_ORIENTED_EDGE);
        });

        this.addBidirectedEdge.addActionListener(e -> {
            GraphToolbar.this.addBidirectedEdge.getModel().setSelected(true);
            setWorkbenchMode(AbstractWorkbench.ADD_EDGE);
            setEdgeMode(GraphWorkbench.BIDIRECTED_EDGE);
        });

        // add buttons to the toolbar.
        addButton(this.move, "move");
        addButton(this.addObserved, "variable");
        addButton(this.addLatent, "latent");
        addButton(this.addDirectedEdge, "directed");
        addButton(this.addNondirectedEdge, "nondirected");
        addButton(this.addUndirectedEdge, "undirected");
        addButton(this.addPartiallyOrientedEdge, "partiallyoriented");
        addButton(this.addBidirectedEdge, "bidirected");
        workbench.addPropertyChangeListener(this);
        selectArrowTools();

        this.buttonsPanel.add(Box.createGlue());

        this.move.setSelected(true);

    }

    /**
     * Convenience method to set the mode of the workbench.  Placed here because Java will not allow access to the
     * variable 'workbench' from inner classes.
     */
    private void setWorkbenchMode(int mode) {
        this.workbench.setWorkbenchMode(mode);

        setCursor(this.workbench.getCursor());
    }

    /**
     * Convenience method to set the mode of the workbench.  Placed here because Java will not allow access to the
     * variable 'workbench' from inner classes.
     */
    private void setEdgeMode(int mode) {
        this.workbench.setEdgeMode(mode);
    }

    /**
     * Convenience method to set the mode of the workbench.  Placed here because Java will not allow access to the
     * variable 'workbench' from inner classes.
     */
    private void setNodeMode(int mode) {
        this.workbench.setNodeType(mode);
    }

    /**
     * Adds the various buttons to the toolbar, setting their properties appropriately.
     */
    private void addButton(JToggleButton button, String name) {
        button.setIcon(new ImageIcon(ImageUtils.getImage(this, name + "3.gif")));
        button.setMaximumSize(new Dimension(80, 40));
        button.setPreferredSize(new Dimension(80, 40));
        this.buttonsPanel.add(button);
        this.buttonsPanel.add(Box.createVerticalStrut(5));
        this.group.add(button);
    }

    /**
     * {@inheritDoc}
     * 
     * Responds to property change events.
     */
    public void propertyChange(PropertyChangeEvent e) {
        if ("graph".equals(e.getPropertyName())) {
            selectArrowTools();
        }
    }

    /**
     * For each workbench type, enables the arrow tools which that workbench can use and disables all others.
     */
    private void selectArrowTools() {
        this.addDirectedEdge.setEnabled(true);
        this.addNondirectedEdge.setEnabled(true);
        this.addPartiallyOrientedEdge.setEnabled(true);
        this.addBidirectedEdge.setEnabled(true);
        this.addUndirectedEdge.setEnabled(true);
    }

}