edu.cmu.tetradapp.knowledge_editor.KnowledgeDisplayNode 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.knowledge_editor;

import edu.cmu.tetrad.graph.EdgeListGraph;
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 edu.cmu.tetradapp.workbench.DisplayNode;
import edu.cmu.tetradapp.workbench.DisplayNodeUtils;

import javax.swing.*;
import java.awt.*;
import java.awt.geom.Rectangle2D;
import java.util.List;

/**
 * This class represents a knowledge variable on screen.
 *
 * @author josephramsey
 */
public class KnowledgeDisplayNode extends DisplayNode {

    /**
     * Constructs a new measured workbench node.
     */
    public KnowledgeDisplayNode(Node modelNode) {
        setModelNode(modelNode);
        setBackground(DisplayNodeUtils.getNodeFillColor());
        setFont(DisplayNodeUtils.getFont());
    }

    /**
     * Determines whether the given coordinate lie inside the component.
     */
    public boolean contains(int x, int y) {
        return getShape().contains(x, y);
    }

    /**
     * Calculates the size of the component based on its name.
     */
    public Dimension getPreferredSize() {
        FontMetrics fm = getFontMetrics(DisplayNodeUtils.getFont());
        int width = fm.stringWidth(getName()) + 11;
        int height = fm.getMaxAscent() + 6;
        return new Dimension(width, height);
    }

    /**
     * @return the shape of the component.
     */
    private Shape getShape() {
        return new Rectangle2D.Double(0, 0,
                getPreferredSize().width - 1,
                getPreferredSize().height - 1);
    }

    /**
     * Launches an editor for this node.
     *
     * @param graph Strings which are invalid names for this node.
     */
    public void doDoubleClickAction(Graph graph) {
        String newName;
        List nodes = graph.getNodes();

        JCheckBox latentCheckBox = new JCheckBox("Latent", false);

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

            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;
        }

        boolean changed = false;

        if (this.getModelNode() != null /*&&
                !newName.equals(super.getModelNode().getNode())*/) {
            this.getModelNode().setName(newName);
            changed = true;
        }

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

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

    /**
     * Launches an editor for this node.
     */
    public void doDoubleClickAction() {
        doDoubleClickAction(new EdgeListGraph());
    }

    /**
     * Paints the component.
     *
     * @param g the graphics context.
     */
    public void paint(Graphics g) {
        Graphics2D g2 = (Graphics2D) g;
        FontMetrics fm = getFontMetrics(DisplayNodeUtils.getFont());
        final int stringX = 6;
        int stringY = fm.getMaxAscent() + 1;

        g2.setColor(isSelected() ? DisplayNodeUtils.getNodeSelectedFillColor() : DisplayNodeUtils.getNodeFillColor());
        g2.fill(getShape());
        g2.setColor(Color.BLACK);
        g2.draw(getShape());
        g2.setColor(Color.BLACK);
        g2.drawString(getName(), stringX, stringY);
    }
}