edu.cmu.tetradapp.workbench.IDisplayEdge 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.workbench;

import edu.cmu.tetrad.graph.Edge;

import java.awt.*;

/**
 * Interface for a display edge.
 *
 * @author josephramsey
 * @version $Id: $Id
 */
public interface IDisplayEdge {
    /**
     * isSelected.
     *
     * @return a boolean
     */
    boolean isSelected();

    /**
     * setSelected.
     *
     * @param selected a boolean
     */
    void setSelected(boolean selected);

    /**
     * launchAssociatedEditor.
     */
    void launchAssociatedEditor();

    /**
     * updateTrackPoint.
     *
     * @param p a {@link java.awt.Point} object
     */
    void updateTrackPoint(Point p);

    /**
     * getNode1.
     *
     * @return a {@link edu.cmu.tetradapp.workbench.DisplayNode} object
     */
    DisplayNode getNode1();

    /**
     * getNode2.
     *
     * @return a {@link edu.cmu.tetradapp.workbench.DisplayNode} object
     */
    DisplayNode getNode2();

    /**
     * getConnectedPoints.
     *
     * @return a {@link edu.cmu.tetradapp.workbench.PointPair} object
     */
    PointPair getConnectedPoints();

    /**
     * setConnectedPoints.
     *
     * @param connectedPoints a {@link edu.cmu.tetradapp.workbench.PointPair} object
     */
    void setConnectedPoints(PointPair connectedPoints);

    /**
     * getRelativeMouseTrackPoint.
     *
     * @return a {@link java.awt.Point} object
     */
    Point getRelativeMouseTrackPoint();

    /**
     * getModelEdge.
     *
     * @return a {@link edu.cmu.tetrad.graph.Edge} object
     */
    Edge getModelEdge();

    /**
     * getOffset.
     *
     * @return a double
     */
    double getOffset();

    /**
     * setOffset.
     *
     * @param offset a double
     */
    void setOffset(double offset);

    /**
     * getPointPair.
     *
     * @return a {@link edu.cmu.tetradapp.workbench.PointPair} object
     */
    PointPair getPointPair();

    /**
     * getTrackPoint.
     *
     * @return a {@link java.awt.Point} object
     */
    Point getTrackPoint();

    /**
     * getComp1.
     *
     * @return a {@link edu.cmu.tetradapp.workbench.DisplayNode} object
     */
    DisplayNode getComp1();

    /**
     * getComp2.
     *
     * @return a {@link edu.cmu.tetradapp.workbench.DisplayNode} object
     */
    DisplayNode getComp2();

    /**
     * getLineColor.
     *
     * @return a {@link java.awt.Color} object
     */
    Color getLineColor();

    /**
     * setLineColor.
     *
     * @param lineColor a {@link java.awt.Color} object
     */
    void setLineColor(Color lineColor);

    /**
     * getSolid.
     *
     * @return a boolean
     */
    boolean getSolid();

    /**
     * setSolid.
     *
     * @param solid a boolean
     */
    void setSolid(boolean solid);

    /**
     * setThick.
     *
     * @param thick a boolean
     */
    void setThick(boolean thick);

    /**
     * getSelectedColor.
     *
     * @return a {@link java.awt.Color} object
     */
    Color getSelectedColor();

    /**
     * setSelectedColor.
     *
     * @param selectedColor a {@link java.awt.Color} object
     */
    void setSelectedColor(Color selectedColor);

    /**
     * getHighlightedColor.
     *
     * @return a {@link java.awt.Color} object
     */
    Color getHighlightedColor();

    /**
     * setHighlightedColor.
     *
     * @param selectedColor a {@link java.awt.Color} object
     */
    void setHighlightedColor(Color selectedColor);

    /**
     * getStrokeWidth.
     *
     * @return a float
     */
    float getStrokeWidth();

    /**
     * setStrokeWidth.
     *
     * @param strokeWidth a float
     */
    void setStrokeWidth(float strokeWidth);

    /**
     * setHighlighted.
     *
     * @param highlighted a boolean
     */
    void setHighlighted(boolean highlighted);
}