001/*
002 * Copyright (c) 2003-2010 The Regents of the University of California.
003 * All rights reserved.
004 *
005 * '$Author: aschultz $'
006 * '$Date: 2010-12-23 19:01:04 +0000 (Thu, 23 Dec 2010) $' 
007 * '$Revision: 26600 $'
008 * 
009 * Permission is hereby granted, without written agreement and without
010 * license or royalty fees, to use, copy, modify, and distribute this
011 * software and its documentation for any purpose, provided that the above
012 * copyright notice and the following two paragraphs appear in all copies
013 * of this software.
014 *
015 * IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
016 * FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
017 * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
018 * THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
019 * SUCH DAMAGE.
020 *
021 * THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
022 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
023 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
024 * PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
025 * CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
026 * ENHANCEMENTS, OR MODIFICATIONS.
027 *
028 */
029
030package org.kepler.gui;
031
032import ptolemy.actor.gui.TableauFrame;
033
034/**
035 * This interface is to be implemented by anyone wanting to add a tab to the
036 * Kepler. The TabPaneFactory generates instances of TabPane.
037 * 
038 * @author Aaron Schultz
039 */
040public interface TabPane {
041
042        /**
043         * Initialization of the tab should be done at some point after the
044         * constructor is called. The setParentFrame() method is called by the
045         * factory before calling initializeTab(). This also allows for more easily
046         * adding new functions to this interface later on.
047         * 
048         * @throws Exception
049         */
050        public abstract void initializeTab() throws Exception;
051
052        /**
053         * This method should return the name of the tab which is used to label the
054         * tab in the TabbedPane
055         */
056        public abstract String getTabName();
057
058        /**
059         * This method must return the TableauFrame this tab is associated with.
060         */
061        public abstract TableauFrame getParentFrame();
062
063        /**
064         * This method sets the TableauFrame this tab is associated with.
065         */
066        public abstract void setParentFrame(TableauFrame parent);
067}