001 /*
002 * Copyright 1997-2001 Sun Microsystems, Inc. All Rights Reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation. Sun designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Sun in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022 * CA 95054 USA or visit www.sun.com if you need additional information or
023 * have any questions.
024 */
025 package javax.swing.event;
026
027 import java.awt.event.*;
028 import java.awt.*;
029 import javax.swing.*;
030
031 /**
032 * An event reported to a child component that originated from an
033 * ancestor in the component hierarchy.
034 * <p>
035 * <strong>Warning:</strong>
036 * Serialized objects of this class will not be compatible with
037 * future Swing releases. The current serialization support is
038 * appropriate for short term storage or RMI between applications running
039 * the same version of Swing. As of 1.4, support for long term storage
040 * of all JavaBeans<sup><font size="-2">TM</font></sup>
041 * has been added to the <code>java.beans</code> package.
042 * Please see {@link java.beans.XMLEncoder}.
043 *
044 * @version 1.26 05/05/07
045 * @author Dave Moore
046 */
047 public class AncestorEvent extends AWTEvent {
048 /**
049 * An ancestor-component was added to the hierarchy of
050 * visible objects (made visible), and is currently being displayed.
051 */
052 public static final int ANCESTOR_ADDED = 1;
053 /**
054 * An ancestor-component was removed from the hierarchy
055 * of visible objects (hidden) and is no longer being displayed.
056 */
057 public static final int ANCESTOR_REMOVED = 2;
058 /** An ancestor-component changed its position on the screen. */
059 public static final int ANCESTOR_MOVED = 3;
060
061 Container ancestor;
062 Container ancestorParent;
063
064 /**
065 * Constructs an AncestorEvent object to identify a change
066 * in an ancestor-component's display-status.
067 *
068 * @param source the JComponent that originated the event
069 * (typically <code>this</code>)
070 * @param id an int specifying {@link #ANCESTOR_ADDED},
071 * {@link #ANCESTOR_REMOVED} or {@link #ANCESTOR_MOVED}
072 * @param ancestor a Container object specifying the ancestor-component
073 * whose display-status changed
074 * @param ancestorParent a Container object specifying the ancestor's parent
075 */
076 public AncestorEvent(JComponent source, int id, Container ancestor,
077 Container ancestorParent) {
078 super (source, id);
079 this .ancestor = ancestor;
080 this .ancestorParent = ancestorParent;
081 }
082
083 /**
084 * Returns the ancestor that the event actually occurred on.
085 */
086 public Container getAncestor() {
087 return ancestor;
088 }
089
090 /**
091 * Returns the parent of the ancestor the event actually occurred on.
092 * This is most interesting in an ANCESTOR_REMOVED event, as
093 * the ancestor may no longer be in the component hierarchy.
094 */
095 public Container getAncestorParent() {
096 return ancestorParent;
097 }
098
099 /**
100 * Returns the component that the listener was added to.
101 */
102 public JComponent getComponent() {
103 return (JComponent) getSource();
104 }
105 }
|