001    /*
002     * Copyright (C) 2008-2010 by Holger Arndt
003     *
004     * This file is part of the Universal Java Matrix Package (UJMP).
005     * See the NOTICE file distributed with this work for additional
006     * information regarding copyright ownership and licensing.
007     *
008     * UJMP is free software; you can redistribute it and/or modify
009     * it under the terms of the GNU Lesser General Public License as
010     * published by the Free Software Foundation; either version 2
011     * of the License, or (at your option) any later version.
012     *
013     * UJMP is distributed in the hope that it will be useful,
014     * but WITHOUT ANY WARRANTY; without even the implied warranty of
015     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
016     * GNU Lesser General Public License for more details.
017     *
018     * You should have received a copy of the GNU Lesser General Public
019     * License along with UJMP; if not, write to the
020     * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
021     * Boston, MA  02110-1301  USA
022     */
023    
024    package org.ujmp.core.interfaces;
025    
026    import javax.swing.JFrame;
027    
028    /**
029     * Declares, that an object suitable for displaying on the screen with
030     * listeners, icon, etc. can be returned.
031     * 
032     * @see GUIObject
033     * @author Holger Arndt
034     * 
035     */
036    public interface HasGUIObject {
037    
038            /**
039             * Returns an object suitable for displaying on the screen. Ensures that,
040             * for each basic object, only one GUIObject can be returned.
041             * 
042             * @return object suitable for displaying on the screen
043             */
044            public GUIObject getGUIObject();
045    
046            /**
047             * This method is used to signal changes in the object to the corresponding
048             * GUIObject if it exists.
049             * <p>
050             * Maybe this method can be deleted, when all changes are made trough the
051             * GUIObject?
052             * 
053             */
054            public void notifyGUIObject();
055    
056            /**
057             * This method will show the object in a JFrame on the screen.
058             */
059            public JFrame showGUI();
060    
061    }