001/*
002 * Copyright (c) 2006-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.io.IOException;
033
034import org.kepler.icon.ComponentEntityConfig;
035
036import ptolemy.kernel.util.IllegalActionException;
037import ptolemy.kernel.util.NameDuplicationException;
038import ptolemy.kernel.util.NamedObj;
039import ptolemy.moml.IconLoader;
040
041//////////////////////////////////////////////////////////////////////////
042//// KeplerIconLoader
043
044/**
045 * @author Christopher Brooks, contributor: Edward A. Lee
046 * @version $Id: KeplerIconLoader.java 24234 2010-05-06 05:21:26Z welker $
047 * @since Ptolemy II 6.0
048 * @Pt.ProposedRating
049 * @Pt.AcceptedRating
050 */
051public class KeplerIconLoader implements IconLoader {
052        /**
053         * Load an icon for a class in a particular context.
054         * 
055         * @param className
056         *            The name of the class for which the icon is to be loaded.
057         * @param context
058         *            The context in which the icon is loaded.
059         * @return true if the icon was successfully loaded.
060         * @exception IllegalActionException
061         *                If there is a problem adding the icon.
062         * @exception NameDuplicationException
063         *                If the icon being added has the same name as an element
064         *                already in the context.
065         * @exception IOException
066         *                If the icon base path cannot be found.
067         */
068        public boolean loadIconForClass(String className, NamedObj context)
069                        throws IllegalActionException, NameDuplicationException,
070                        IOException {
071                ComponentEntityConfig.addSVGIconTo(context);
072                // FIXME: need to return a better value here
073                return true;
074        }
075}