OpenJDK 27 · javax.swing.event.AncestorEvent · APIdia, the JavaDoc alternative

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 JavaBeans has been added to the java.beans package. Please see java.beans.XMLEncoder.

Field Summary

Modifier and Type	Field and Description
pack-priv Container	ancestor
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_MOVED An ancestor-component changed its position on the screen.
public static final int	ANCESTOR_REMOVED An ancestor-component was removed from the hierarchy of visible objects (hidden) and is no longer being displayed.
pack-priv Container	ancestorParent

Constructor Summary

Access Constructor and Description

Access	Constructor and Description
public	AncestorEvent(JComponent the JComponent that originated the event (typically `this`) source, int an int specifying `ANCESTOR_ADDED`, `ANCESTOR_REMOVED` or `ANCESTOR_MOVED` id, Container a Container object specifying the ancestor-component whose display-status changed ancestor, Container a Container object specifying the ancestor's parent ancestorParent) Constructs an AncestorEvent object to identify a change in an ancestor-component's display-status.

public

AncestorEvent(JComponent

the JComponent that originated the event (typically this)

source, int

an int specifying ANCESTOR_ADDED, ANCESTOR_REMOVED or ANCESTOR_MOVED

id, Container

a Container object specifying the ancestor-component whose display-status changed

ancestor, Container

a Container object specifying the ancestor's parent

ancestorParent)

Constructs an AncestorEvent object to identify a change in an ancestor-component's display-status.

Method Summary

Modifier and Type	Method and Description
public Container	Returns: the `Container` object specifying the ancestor component getAncestor() Returns the ancestor that the event actually occurred on.
public Container	Returns: the `Container` object specifying the ancestor's parent getAncestorParent() Returns the parent of the ancestor the event actually occurred on.
public JComponent	Returns: the `JComponent` on which the event occurred getComponent() Returns the component that the listener was added to.

Inherited from java.awt.AWTEvent:: consume getID isConsumed paramString setSource toString

Field Detail

ancestor	back to summary
pack-priv Container ancestor

ANCESTOR_ADDED	back to 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.

ANCESTOR_MOVED	back to summary
public static final int ANCESTOR_MOVED An ancestor-component changed its position on the screen.

ANCESTOR_REMOVED	back to summary
public static final int ANCESTOR_REMOVED An ancestor-component was removed from the hierarchy of visible objects (hidden) and is no longer being displayed.

ancestorParent	back to summary
pack-priv Container ancestorParent

Constructor Detail

AncestorEvent back to summary

AncestorEvent	back to 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. Parameters source:JComponent the JComponent that originated the event (typically `this`) id:int an int specifying `ANCESTOR_ADDED`, `ANCESTOR_REMOVED` or `ANCESTOR_MOVED` ancestor:Container a Container object specifying the ancestor-component whose display-status changed ancestorParent:Container a Container object specifying the ancestor's parent

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.

Parameters

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

Method Detail

getAncestor back to summary

getAncestor	back to summary
public Container getAncestor() Returns the ancestor that the event actually occurred on. Returns:Container the `Container` object specifying the ancestor component

public Container getAncestor()

Returns the ancestor that the event actually occurred on.

Returns:Container: the Container object specifying the ancestor component

getAncestorParent back to summary

getAncestorParent	back to summary
public Container getAncestorParent() 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. Returns:Container the `Container` object specifying the ancestor's parent

public Container getAncestorParent()

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.

Returns:Container: the Container object specifying the ancestor's parent

getComponent back to summary

getComponent	back to summary
public JComponent getComponent() Returns the component that the listener was added to. Returns:JComponent the `JComponent` on which the event occurred

public JComponent getComponent()

Returns the component that the listener was added to.

Returns:JComponent: the JComponent on which the event occurred