1 /*
   2  * Copyright (c) 1997, 2014, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package javax.swing.event;
  27 
  28 import javax.swing.undo.*;
  29 
  30 /**
  31  * An event indicating that an operation which can be undone has occurred.
  32  * <p>
  33  * <strong>Warning:</strong>
  34  * Serialized objects of this class will not be compatible with
  35  * future Swing releases. The current serialization support is
  36  * appropriate for short term storage or RMI between applications running
  37  * the same version of Swing.  As of 1.4, support for long term storage
  38  * of all JavaBeans
  39  * has been added to the <code>java.beans</code> package.
  40  * Please see {@link java.beans.XMLEncoder}.
  41  *
  42  * @author Ray Ryan
  43  */
  44 @SuppressWarnings("serial") // Same-version serialization only
  45 public class UndoableEditEvent extends java.util.EventObject {
  46     private UndoableEdit myEdit;
  47 
  48     /**
  49      * Constructs an UndoableEditEvent object.
  50      *
  51      * @param source  the Object that originated the event
  52      *                (typically <code>this</code>)
  53      * @param edit    an UndoableEdit object
  54      */
  55     public UndoableEditEvent(Object source, UndoableEdit edit) {
  56         super(source);
  57         myEdit = edit;
  58     }
  59 
  60     /**
  61      * Returns the edit value.
  62      *
  63      * @return the UndoableEdit object encapsulating the edit
  64      */
  65     public UndoableEdit getEdit() {
  66         return myEdit;
  67     }
  68 }