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 javax.swing.event.ChangeEvent;
035
036import ptolemy.kernel.util.NamedObj;
037
038/**
039 * An event that represents a state change in the application, showing both the
040 * state that changed and the source of the state change.
041 */
042public class StateChangeEvent extends ChangeEvent {
043
044        ////////////////////////////////////////////////////////////////////////////
045        ////////////////////////////////////////////////////////////////////////////
046        // PUBLIC STATIC STATE CHANGE EVENT TYPE CONSTANTS
047        ////////////////////////////////////////////////////////////////////////////
048        ////////////////////////////////////////////////////////////////////////////
049
050        /**
051         * Public constant to denote that a workflow is done executing
052         */
053        public static String WORKFLOW_EXECUTION_COMPLETE = "WORKFLOW_EXECUTION_COMPLETE";
054
055        // TODO: add more here
056
057        protected String changedState;
058
059        protected NamedObj reference;
060
061        /**
062         * Construct a new StateChange event.
063         * 
064         * @param source
065         *          the source of the StateChange event
066         * @param changedState
067         *          the label for the state that has changed
068         * @param reference
069         *                      reference to the object that changed
070         */
071        public StateChangeEvent(Component source, String changedState,
072                        NamedObj reference) {
073                super(source);
074                this.changedState = changedState;
075                this.reference = reference;
076        }
077
078        /**
079         * Get the value of the changedState for this event.
080         * 
081         * @return the String value for the changed state
082         */
083        public String getChangedState() {
084                return changedState;
085        }
086
087        public NamedObj getReference() {
088                return this.reference;
089        }
090}