001/*
002 * Copyright (c) 2003-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.state;
031
032import java.awt.Component;
033
034import ptolemy.kernel.util.NamedObj;
035
036/**
037 * An event that represents a state change in the application, showing both the
038 * state that changed and the source of the state change.
039 */
040public class ViewStateChangeEvent extends StateChangeEvent {
041
042        ////////////////////////////////////////////////////////////////////////////
043        ////////////////////////////////////////////////////////////////////////////
044        // PUBLIC STATIC STATE CHANGE EVENT TYPE CONSTANTS
045        ////////////////////////////////////////////////////////////////////////////
046        ////////////////////////////////////////////////////////////////////////////
047
048        public static String SHOW_VIEW = "SHOW_VIEW";
049
050        // TODO: add more here
051
052        private String viewName;
053
054        /**
055         * Construct a new StateChange event.
056         * @param source
057         * @param changedState
058         * @param reference
059         * @param viewName
060         */
061        public ViewStateChangeEvent(Component source, String changedState,
062                        NamedObj reference, String viewName) {
063                super(source, changedState, reference);
064                this.viewName = viewName;
065        }
066
067        /**
068         * Get the value of the viewName for this event.
069         * 
070         * @return the String value for the viewName
071         */
072        public String getViewName() {
073                return viewName;
074        }
075
076}