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.util.Vector;
033
034/**
035 * In order to handle local event, we need to compare the parent of event's
036 * source and GUIAction'parent. But if an event happened before the source added
037 * to a container, this will cause the parent of event' source is null. So we
038 * need this mechanism to store the event, then broadcast later.
039 */
040public interface StoreStateChangeEvent {
041        /**
042         * This method is called if a StateChangeEvent need to be stored
043         * 
044         * @param event
045         *            the StateChangeEvent needed to be stored
046         */
047        public void storingStateChangeEvent(StateChangeEvent event);
048
049        /**
050         * Get the stored state change event.
051         */
052        public Vector getStoredStateChangeEvent();
053
054        /**
055         * Broadcast the stored StateChangeEvent
056         */
057        public void broadcastStoredStateChangeEvent();
058}