Index (Frames) | Index (No Frames) | Package | Package Tree | Tree
java.awt.event

Class HierarchyEvent

java.lang.Object
|
+--java.util.EventObject
   |
   +--java.awt.AWTEvent
      |
      +--java.awt.event.HierarchyEvent


public class HierarchyEvent

extends AWTEvent

This class represents an event generated for an ancestor component which may affect this component. These events normally do not need to be handled by the application, since the AWT system automatically takes care of them.

There are two types of hierarchy events. The first type is handled by HierarchyListener, and includes addition or removal of an ancestor, or an ancestor changing its on-screen status (visible and/or displayble). The second type is handled by HierarchyBoundsListener, and includes resizing or moving of an ancestor.

Since:Author:See Also:

Field Summary

static intANCESTOR_MOVED

This id indicates that an ancestor was moved.
static intANCESTOR_RESIZED

This id indicates that an ancestor was resized.
static intDISPLAYABILITY_CHANGED

This indicates that the HIERARCHY_CHANGED is caused by a change in displayability.
static intHIERARCHY_CHANGED

This id indicates that the hierarchy tree changed.
static intHIERARCHY_FIRST

This is the first id in the range of ids used by this class.
static intHIERARCHY_LAST

This is the last id in the range of ids used by this class.
static intPARENT_CHANGED

This indicates that the HIERARCHY_CHANGED is a changed parent.
static intSHOWING_CHANGED

This indicates that the HIERARCHY_CHANGED is a changed visibility.

Constructor Summary

HierarchyEvent(java.awt.Component source, int id, java.awt.Component changed, java.awt.Container changedParent)

Initializes a new instance of HierarchyEvent with the specified parameters.
HierarchyEvent(java.awt.Component source, int id, java.awt.Component changed, java.awt.Container changedParent, long changeFlags)

Initializes a new instance of HierarchyEvent with the specified parameters.

Method Summary

longgetChangeFlags()

If this is a HIERARCHY_CHANGED event, this returns a bitmask of the types of changes that took place.
java.awt.ComponentgetChanged()

Returns the component at the top of the hierarchy which changed.
java.awt.ContainergetChangedParent()

Returns the parent of the component listed in getChanged().
java.awt.ComponentgetComponent()

This method returns the event source as a Component.
java.lang.StringparamString()

This method returns a string identifying this event.

Field Details

ANCESTOR_MOVED

public static final int ANCESTOR_MOVED

This id indicates that an ancestor was moved.


ANCESTOR_RESIZED

public static final int ANCESTOR_RESIZED

This id indicates that an ancestor was resized.


DISPLAYABILITY_CHANGED

public static final int DISPLAYABILITY_CHANGED

This indicates that the HIERARCHY_CHANGED is caused by a change in displayability.

See Also:


HIERARCHY_CHANGED

public static final int HIERARCHY_CHANGED

This id indicates that the hierarchy tree changed.


HIERARCHY_FIRST

public static final int HIERARCHY_FIRST

This is the first id in the range of ids used by this class.


HIERARCHY_LAST

public static final int HIERARCHY_LAST

This is the last id in the range of ids used by this class.


PARENT_CHANGED

public static final int PARENT_CHANGED

This indicates that the HIERARCHY_CHANGED is a changed parent.


SHOWING_CHANGED

public static final int SHOWING_CHANGED

This indicates that the HIERARCHY_CHANGED is a changed visibility.

See Also:


Constructor Details

HierarchyEvent

public HierarchyEvent(java.awt.Component source, int id, java.awt.Component changed, java.awt.Container changedParent)

Initializes a new instance of HierarchyEvent with the specified parameters. Note that an invalid id leads to unspecified results.

Parameters:

Throws:


HierarchyEvent

public HierarchyEvent(java.awt.Component source, int id, java.awt.Component changed, java.awt.Container changedParent, long changeFlags)

Initializes a new instance of HierarchyEvent with the specified parameters. Note that an invalid id leads to unspecified results.

Parameters:

Throws:


Method Details

getChangeFlags

public long getChangeFlags()

If this is a HIERARCHY_CHANGED event, this returns a bitmask of the types of changes that took place.

Returns:

See Also:


getChanged

public Component getChanged()

Returns the component at the top of the hierarchy which changed.

Returns:


getChangedParent

public Container getChangedParent()

Returns the parent of the component listed in getChanged(). If the cause of this event was Container.add, this is the new parent; if the cause was Container.remove, this is the old parent; otherwise it is the unchanged parent.

Returns:


getComponent

public Component getComponent()

This method returns the event source as a Component. If the source has subsequently been modified to a non-Component, this returns null.

Returns:


paramString

public String paramString()

This method returns a string identifying this event. This is the field name of the id type, followed by a parenthesized listing of the changed component and its parent container. In addition, if the type is HIERARCHY_CHANGED, the flags preceed the changed component, in the order PARENT_CHANGED, DISPLAYABILITY_CHANGED, and SHOWING_CHANGED.

Returns: