FileDocCategorySizeDatePackage
AncestorEvent.javaAPI DocJava SE 5 API2993Fri Aug 26 14:58:00 BST 2005javax.swing.event

AncestorEvent

public class AncestorEvent extends AWTEvent
An event reported to a child component that originated from an ancestor in the component hierarchy.

Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeansTM has been added to the java.beans package. Please see {@link java.beans.XMLEncoder}.

version
1.19 12/19/03
author
Dave Moore

Fields Summary
public static final int
ANCESTOR_ADDED
An ancestor-component was added to the hierarchy of visible objects (made visible), and is currently being displayed.
public static final int
ANCESTOR_REMOVED
An ancestor-component was removed from the hierarchy of visible objects (hidden) and is no longer being displayed.
public static final int
ANCESTOR_MOVED
An ancestor-component changed its position on the screen.
Container
ancestor
Container
ancestorParent
Constructors Summary
public AncestorEvent(JComponent source, int id, Container ancestor, Container ancestorParent)
Constructs an AncestorEvent object to identify a change in an ancestor-component's display-status.

param
source the JComponent that originated the event (typically this)
param
id an int specifying {@link #ANCESTOR_ADDED}, {@link #ANCESTOR_REMOVED} or {@link #ANCESTOR_MOVED}
param
ancestor a Container object specifying the ancestor-component whose display-status changed
param
ancestorParent a Container object specifying the ancestor's parent


                                                                                                                                                                   
             
        super(source, id);
        this.ancestor = ancestor;
        this.ancestorParent = ancestorParent;
Methods Summary
public java.awt.ContainergetAncestor()
Returns the ancestor that the event actually occurred on.

        return ancestor;
public java.awt.ContainergetAncestorParent()
Returns the parent of the ancestor the event actually occurred on. This is most interesting in an ANCESTOR_REMOVED event, as the ancestor may no longer be in the component hierarchy.

        return ancestorParent;
public javax.swing.JComponentgetComponent()
Returns the component that the listener was added to.

        return (JComponent)getSource();