edu.cmu.tetradapp.workbench.GraphNodeMeasured 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
There is a newer version: 7.6.6
///////////////////////////////////////////////////////////////////////////////
// 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.workbench;

import edu.cmu.tetrad.graph.Graph;
import edu.cmu.tetrad.graph.Node;
import edu.cmu.tetrad.graph.NodeType;
import edu.cmu.tetrad.util.JOptionUtils;
import edu.cmu.tetrad.util.NamingProtocol;

import javax.swing.*;
import java.awt.event.FocusAdapter;
import java.awt.event.FocusEvent;
import java.util.List;

/**
 * Represents a measured (observed) variable in the workbench. Appears as an rectangle with the variable name in it.
 * Clicking on the rectangle pops up a dialog that lets the user modify the name of the variable and whether the
 * variable is latent.
 *
 * @author josephramsey
 */
public class GraphNodeMeasured extends DisplayNode {

    /**
     * True iff the user is allowed to edit existing measured variables.
     */
    private boolean editExitingMeasuredVarsAllowed = true;

    //=============================CONSTRUCTORS==========================//

    /**
     * Constructs a new measured workbench node.
     */
    public GraphNodeMeasured(Node modelNode) {
        setModelNode(modelNode);
        if (modelNode.getNodeType() != NodeType.MEASURED) {
            throw new IllegalArgumentException("GraphNodeMeasured requires " +
                    "a GraphNode of type NodeType.MEASURED.");
        }

        setDisplayComp(new MeasuredDisplayComp(modelNode.getName()));
//        setDisplayComp(new MeasuredDisplaySmallComp(modelNode.getNode()));
    }

    /**
     * Constructs a new display node for measured variables that doesn't bind to a model node, and instead has the name
     * set manually.
     */
    public GraphNodeMeasured(String name) {
        setName(name);
    }

    //=============================PUBLIC METHODS==========================//


    /**
     * Launches an editor for this node.
     *
     * @param graph Strings which are invalid names for this node.
     */
    public void doDoubleClickAction(Graph graph) {
        if (!isEditExitingMeasuredVarsAllowed()) {
            return;
        }

        String newName;
        List nodes = graph.getNodes();
        JCheckBox latentCheckBox = new JCheckBox("Latent", false);

        newName = chooseNewVariableName(latentCheckBox, nodes);

        boolean changed = false;

        if (this.getModelNode() != null &&
                !newName.equals(this.getModelNode().getName())) {
            this.getModelNode().setName(newName);
            firePropertyChange("resetGraph", null, null);
            changed = true;
        }

        if (latentCheckBox.isSelected()) {
            this.getModelNode().setNodeType(NodeType.LATENT);
            firePropertyChange("resetGraph", null, null);
            changed = true;
        }

        if (changed) {
            firePropertyChange("editingValueChanged", null, null);
        }
    }

    private String chooseNewVariableName(JCheckBox latentCheckBox,
                                         List nodes) {
        String newName;

        LOOP:
        while (true) {
            JTextField nameField = new JTextField(8);

            // This makes sure the name field has focus when the dialog (below)
            // is made visible, but that after this it allows other gadgets
            // to grab focus.
            nameField.addFocusListener(new FocusAdapter() {
                boolean alreadyLostFocus;

                public void focusLost(FocusEvent e) {
                    if (this.alreadyLostFocus) return;
                    JTextField field = (JTextField) e.getSource();
                    field.grabFocus();
                    this.alreadyLostFocus = true;
                }
            });

            nameField.setText(getName());
            nameField.setCaretPosition(0);
            nameField.moveCaretPosition(getName().length());

            JPanel message = new JPanel();

            message.add(new JLabel("Name:"));
            message.add(nameField);

            message.add(latentCheckBox);

            JOptionPane pane = new JOptionPane(message, JOptionPane.PLAIN_MESSAGE,
                    JOptionPane.OK_CANCEL_OPTION);
            JDialog dialog = pane.createDialog(this, "Node Properties");


            dialog.pack();
            dialog.setVisible(true);

            newName = nameField.getText();

            // Tests that newName is a well formed variable
            if (!NamingProtocol.isLegalName(newName)) {
                JOptionPane.showMessageDialog(JOptionUtils.centeringComp(),
                        NamingProtocol.getProtocolDescription());
                continue;
            }
            // Tests that newName is not in the nodes list.
            else if (nodes != null) {
                for (Node node : nodes) {
                    if (newName.equals(node.toString()) &&
                            !newName.equals(this.getModelNode().getName())) {
                        JOptionPane.showMessageDialog(
                                JOptionUtils.centeringComp(), "The name '" +
                                        newName + "' is already being used." +
                                        "\nPlease choose another name.");
                        continue LOOP;
                    }
                }
            }

            break;
        }

        return newName;
    }

    /**
     * Launches an dialog allowing the user to pick a new name for this variable, where no constraints are placed on the
     * name.
     */
    public void doDoubleClickAction() {
        doDoubleClickAction(null);
    }

    private boolean isEditExitingMeasuredVarsAllowed() {
        return this.editExitingMeasuredVarsAllowed;
    }

    public void setEditExitingMeasuredVarsAllowed(boolean editExitingMeasuredVarsAllowed) {
        this.editExitingMeasuredVarsAllowed = editExitingMeasuredVarsAllowed;
    }
}