001/*
002 * Copyright (c) 2004-2010 The Regents of the University of California.
003 * All rights reserved.
004 *
005 * '$Author: welker $'
006 * '$Date: 2010-05-06 05:21:26 +0000 (Thu, 06 May 2010) $' 
007 * '$Revision: 24234 $'
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 java.awt.Component;
033
034import javax.swing.Box;
035
036import ptolemy.actor.gui.TableauFrame;
037import ptolemy.kernel.util.NamedObj;
038
039/**
040 * A JTabbedPane tab to be added to a TabbedDialog object. This particular pane
041 * shows the "Annotations" settings for the object being configured
042 * 
043 * @author Matthew Brooke
044 * @since 27 February 2006
045 */
046public class DialogAnnotationsTab extends AbstractDialogTab {
047
048        public DialogAnnotationsTab(NamedObj target, String targetType,
049                        TableauFrame frame) {
050                super(target, targetType, frame);
051        }
052
053        /**
054         * Validate the user-editable values associated with this tab
055         * 
056         * @return boolean - true if user values validate correctly; false otherwise
057         */
058        public boolean validateInput() {
059                /** @todo - FIXME - needs to be implemented */
060                return true;
061        }
062
063        /**
064         * Save the user-editable values associated with this tab
065         */
066        public void save() {
067                /** @todo - FIXME - needs to be implemented */
068        }
069
070        /**
071         * get the Component that will be displayed in the NORTH section of the
072         * BorderLayout. Note that if the dialog is resizable, this Component will
073         * need to stretch along the x axis, while retaining its aesthetic qualities
074         * 
075         * @return Component
076         */
077        protected Component getTopPanel() {
078                Box topPanel = Box.createHorizontalBox();
079                /** @todo - FIXME - needs to be implemented */
080                return topPanel;
081        }
082
083        /**
084         * get the Component that will be displayed in the CENTER section of the
085         * BorderLayout. Note that if the dialog is resizable, this Component will
086         * need to stretch along both the x <em>and</em> y axes, while retaining its
087         * aesthetic qualities
088         * 
089         * @return Component
090         */
091        protected Component getCenterPanel() {
092                Box centerPanel = Box.createHorizontalBox();
093                /** @todo - FIXME - needs to be implemented */
094                return centerPanel;
095
096        }
097
098        /**
099         * get the Component that will be displayed in the SOUTH section of the
100         * BorderLayout. Note that if the dialog is resizable, this Component will
101         * need to stretch along the x axis, while retaining its aesthetic qualities
102         * 
103         * @return Component
104         */
105        protected Component getBottomPanel() {
106                Box bottomPanel = Box.createHorizontalBox();
107                /** @todo - FIXME - needs to be implemented */
108                return bottomPanel;
109        }
110}