001/*
002 Platform independent container for placing UI components into itself.
003
004 Copyright (c) 2011-2013 The Regents of the University of California.
005 All rights reserved.
006 Permission is hereby granted, without written agreement and without
007 license or royalty fees, to use, copy, modify, and distribute this
008 software and its documentation for any purpose, provided that the above
009 copyright notice and the following two paragraphs appear in all copies
010 of this software.
011
012 IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
013 FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
014 ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
015 THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
016 SUCH DAMAGE.
017
018 THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
019 INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
020 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
021 PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
022 CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
023 ENHANCEMENTS, OR MODIFICATIONS.
024
025 PT_COPYRIGHT_VERSION_2
026 COPYRIGHTENDKEY
027 */
028
029package ptolemy.actor.injection;
030
031///////////////////////////////////////////////////////////////////
032//// PortableContainer
033
034/** Platform independent container for placing UI components into itself.
035 *  The implementor of this interface would wrap the platform dependent container.
036 *
037 *  @author Anar Huseynov
038 *  @version $Id$
039 *  @since Ptolemy II 10.0
040 *  @Pt.ProposedRating Red (ahuseyno)
041 *  @Pt.AcceptedRating Red (ahuseyno)
042 */
043public interface PortableContainer {
044
045    ///////////////////////////////////////////////////////////////////
046    ////                         public methods                    ////
047
048    /** Add the specified component into the container.
049     *  @param component The component to be added.
050     */
051    public void add(Object component);
052
053    /** Return the platform dependent container that this instance wraps.
054     *  @return The platform dependent container.
055     */
056    public Object getPlatformContainer();
057}