001/*
002 * Copyright (c) 1997-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.util.Iterator;
033
034import ptolemy.kernel.util.Attribute;
035import ptolemy.kernel.util.IllegalActionException;
036import ptolemy.kernel.util.NameDuplicationException;
037import ptolemy.kernel.util.NamedObj;
038
039/**
040 * This class allows the configuration option canvasNavigationModifier to be
041 * passed via the moml configuration. The ScrollBarModifier class contains a
042 * flag which determines if the scrollbars should be displayed or not. Other
043 * such configuration options could also be added via this class.
044 */
045public class CanvasNavigationModifierFactory extends Attribute {
046
047        /**
048         * Create a factory with the given name and container.
049         * 
050         * @param container
051         *            The container.
052         * @param name
053         *            The name.
054         * @exception IllegalActionException
055         *                If the container is incompatible with this attribute.
056         * @exception NameDuplicationException
057         *                If the name coincides with an attribute already in the
058         *                container.
059         */
060        public CanvasNavigationModifierFactory(NamedObj container, String name)
061                        throws IllegalActionException, NameDuplicationException {
062                super(container, name);
063        }
064
065        // /////////////////////////////////////////////////////////////////
066        // // public methods ////
067
068        /**
069         * creates the ScrollBarModifier class and returns it
070         */
071        public ScrollBarModifier createScrollBarModifier() {
072                ScrollBarModifier modifier = null;
073                Iterator factories = attributeList(
074                                CanvasNavigationModifierFactory.class).iterator();
075                while (factories.hasNext() && modifier == null) {
076                        CanvasNavigationModifierFactory factory = (CanvasNavigationModifierFactory) factories
077                                        .next();
078                        modifier = factory.createScrollBarModifier();
079                }
080                return modifier;
081        }
082}