001/* Load Icons
002
003 Copyright (c) 2006-2013 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
027 */
028package ptolemy.moml;
029
030import ptolemy.kernel.util.NamedObj;
031
032///////////////////////////////////////////////////////////////////
033//// IconLoader
034
035/**
036 Interface for loading icons.
037
038 @see MoMLParser
039 @author Edward A. Lee, Christopher Brooks
040 @version $Id$
041 @since Ptolemy II 5.2
042 @Pt.ProposedRating Red (eal)
043 @Pt.AcceptedRating Red (cxh)
044 */
045public interface IconLoader {
046
047    // This interface is used by Kepler so that the createHierarchy
048    // command brings up the proper icon.
049    // See kepler/gui/src/org/kepler/gui/KeplerGraphFrame.java
050
051    ///////////////////////////////////////////////////////////////////
052    ////                         public methods                    ////
053
054    /** Load an icon for a class in a particular context.
055     *  @param className The name of the class for which the icon is
056     *  to be loaded.
057     *  @param context The context in which the icon is loaded.
058     *  @return true if the icon was successfully loaded.
059     *  @exception Exception If there is a problem adding
060     *  the icon.
061     *  @see ptolemy.moml.MoMLParser#getIconLoader()
062     *  @see ptolemy.moml.MoMLParser#setIconLoader(IconLoader)
063     */
064    public boolean loadIconForClass(String className, NamedObj context)
065            throws Exception;
066}