edu.cmu.tetradapp.util.DesktopController 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.util;

import edu.cmu.tetradapp.session.Session;

/**
 * Indirect control for the desktop to avoid package cycles. The reference to the desktop is set using the
 * activate method, as a DesktopControllable. Once set, the method calls in the DesktopControllable
 * interface are passed on to it.
 *
 * Note that all argument types are interface-tagged as well to avoid further
 * package cycles.
 *
 * 
Not pretty, but easier and cleaner by far than passing the reference to the
 * desktop down through all of the relevant classes in tetradapp.
 *
 * @author josephramsey
 * @version $Id: $Id
 */
public class DesktopController implements DesktopControllable {
    private static DesktopControllable INSTANCE;


    /**
     * 
getInstance.
     *
     * @return a {@link edu.cmu.tetradapp.util.DesktopControllable} object
     */
    public static DesktopControllable getInstance() {
        return DesktopController.INSTANCE;
    }

    /**
     * Sets the reference to the desktop that will be used throughout the application when needed. Done once when the
     * Tetrad application is launched.
     *
     * @param component a {@link edu.cmu.tetradapp.util.DesktopControllable} object
     */
    public static void setReference(DesktopControllable component) {
        DesktopController.INSTANCE = component;
    }

    /**
     * newSessionEditor.
     */
    public void newSessionEditor() {
        DesktopController.getInstance().newSessionEditor();
    }

    /**
     * getFrontmostSessionEditor.
     *
     * @return a {@link edu.cmu.tetradapp.util.SessionEditorIndirectRef} object
     */
    public SessionEditorIndirectRef getFrontmostSessionEditor() {
        return DesktopController.getInstance().getFrontmostSessionEditor();
    }

    /**
     * exitProgram.
     */
    public void exitProgram() {
        DesktopController.getInstance().exitProgram();
    }

    /**
     * {@inheritDoc}
     */
    public boolean existsSessionByName(String name) {
        return DesktopController.getInstance().existsSessionByName(name);
    }

    /**
     * {@inheritDoc}
     */
    public Session getSessionByName(String name) {
        return DesktopController.getInstance().getSessionByName(name);
    }

    /**
     * {@inheritDoc}
     */
    public void addSessionEditor(SessionEditorIndirectRef editor) {
        DesktopController.getInstance().addSessionEditor(editor);
    }

    /**
     * closeEmptySessions.
     */
    public void closeEmptySessions() {
        DesktopController.getInstance().closeAllSessions();
    }

    /**
     * {@inheritDoc}
     */
    public void putMetadata(SessionWrapperIndirectRef sessionWrapper,
                            TetradMetadataIndirectRef metadata) {
        DesktopController.getInstance().putMetadata(sessionWrapper, metadata);
    }

    /**
     * {@inheritDoc}
     */
    public TetradMetadataIndirectRef getTetradMetadata(
            SessionWrapperIndirectRef sessionWrapper) {
        return DesktopController.getInstance().getTetradMetadata(sessionWrapper);
    }

    /**
     * {@inheritDoc}
     */
    public void addEditorWindow(EditorWindowIndirectRef editorWindow, int layer) {
        DesktopController.getInstance().addEditorWindow(editorWindow, layer);
    }


    /**
     * closeFrontmostSession.
     */
    public void closeFrontmostSession() {
        DesktopController.getInstance().closeFrontmostSession();
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void closeSessionByName(String name) {
        DesktopController.getInstance().closeSessionByName(name);
    }

    /**
     * closeAllSessions.
     *
     * @return a boolean
     */
    public boolean closeAllSessions() {
        return DesktopController.getInstance().closeAllSessions();
    }
}