001/* Top-level window for Ptolemy models with a menubar and status bar.
002
003 Copyright (c) 2008-2009 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 ptolemy.actor.gui;
028
029import ptolemy.gui.Top;
030
031//////////////////////////////////////////////////////////////////////////
032//// TopPack
033
034/**
035 An interface that allows alternate pack() methods to be called from
036 TableauFrame which allows for functionality such as alternate menu systems
037 in Vergil.
038
039 @author Chad Berkley
040 @version $Id$
041 @since Ptolemy II 8.0
042 @Pt.AcceptedRating Red (berkley)
043 @Pt.ProposedRating Red (berkley)
044 */
045public interface TopPack {
046
047    /**
048     * Pack the Top JFrame.
049     * This method overrides the regular pack() call.
050     * @param top The Top to pack.
051     * @param alreadyCalled  True if pack has already been called.
052     */
053    public void pack(Top top, boolean alreadyCalled);
054
055    /**
056     * Get an object.
057     * This method allows the overrider to pass an object back to the calling object.
058     * @param identifier The object to get.
059     * @return The object found.
060     */
061    public Object getObject(Object identifier);
062}