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 java.io.Serializable;
027    
028    import javax.swing.Icon;
029    import javax.swing.JFrame;
030    import javax.swing.JPanel;
031    
032    /**
033     * A GUIObject is an object that can be displayed in a Frame. This interface is
034     * needed to indicate that an object can be displayed when the package
035     * org.ujmp.gui is available. In org.ujmp.matrix is also known that such an
036     * object exists, but not what methods it provides. The object will be created
037     * using the Reflection Api.
038     * 
039     * @author Holger Arndt
040     * 
041     */
042    public interface GUIObject extends Serializable, Cloneable, Clearable, HasLabel, HasDescription,
043                    HasToolTip {
044    
045            /**
046             * Indicates that changed in the object have been made, that should be
047             * updated on the screen.
048             */
049            public void fireValueChanged();
050    
051            public JFrame showGUI();
052    
053            public Icon getIcon();
054    
055            public int getModCount();
056    
057            /**
058             * This method will return a JFrame for this object.
059             */
060            public JFrame getFrame();
061    
062            /**
063             * This method will return a JPanel for this object.
064             */
065            public JPanel getPanel();
066    
067            public CoreObject getCoreObject();
068    
069    }