001/* An interface for a frame that can have multiple containers.
002
003 Copyright (c) 1998-2007 The Regents of the University of California.
004 All rights reserved.
005 Permission is hereby granted, without written agreement and without
006 license or royalty fees, to use, copy, modify, and distribute this
007 software and its documentation for any purpose, provided that the above
008 copyright notice and the following two paragraphs appear in all copies
009 of this software.
010
011 IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
012 FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
013 ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
014 THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
015 SUCH DAMAGE.
016
017 THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
018 INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
019 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
020 PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
021 CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
022 ENHANCEMENTS, OR MODIFICATIONS.
023
024 PT_COPYRIGHT_VERSION_2
025 COPYRIGHTENDKEY
026 */
027package org.mlc.swing.layout;
028
029import java.awt.Container;
030
031/** An interface for frames that can have multiple containers.
032 *  Classes that implement this interface are required to be subclasses
033 *  of JFrame.
034 *  <p>
035 *  I added this interface so that FormEditor could be contained
036 *  in frames that were not instances of LayoutFrame.  LayoutFrame
037 *  implements this interface.
038 *
039 *  @author Edward A. Lee eal&#064;eecs.berkeley.edu
040@version $Id$
041@since Ptolemy II 8.0
042 */
043public interface MultiContainerFrame {
044
045    /** Add a container with the specified name.
046     *  @param name The name of the container.
047     *  @param container The container.
048     */
049    public void addContainer(String name, Container container);
050
051    /** Return true if the frame has a container with the specified name.
052     *  @param name The name of the container.
053     */
054    public boolean hasContainer(String name);
055
056    /** Remove the container with the specified name.
057     *  This may throw a RuntimeException if the container does not exist.
058     *  @param name The name of the container.
059     */
060    public void removeContainer(String name);
061}