public class java.awt.event
HierarchyEvent


Show All Login
Java SE 6
  
Extends: EventObject > AWTEvent
Details
An event which indicates a change to the Component hierarchy to which a Component belongs.

Hierarchy events are provided for notification purposes ONLY. The AWT will automatically handle changes to the hierarchy internally so that GUI layout and displayability works properly regardless of whether a program is receiving these events or not.

This event is generated by a Container object (such as a Panel) when the Container is added, removed, moved, or resized, and passed down the hierarchy. It is also generated by a Component object when that object's addNotify, removeNotify, show, or hide method is called. ANCESTOR_MOVED and ANCESTOR_RESIZED events are dispatched to every HierarchyBoundsListener or HierarchyBoundsAdapter object which registered to receive such events using the Component's addHierarchyBoundsListener method. (HierarchyBoundsAdapter objects implement the HierarchyBoundsListener interface.) HIERARCHY_CHANGED events are dispatched to every HierarchyListener object which registered to receive such events using the Component's addHierarchyListener method. Each such listener object gets this HierarchyEvent when the event occurs.
version1.14, 11/17/05
since1.3
See also java.awt.event.HierarchyListener, java.awt.event.HierarchyBoundsAdapter, java.awt.event.HierarchyBoundsListener


Fields
final public static int HIERARCHY_FIRST
Marks the first integer id for the range of hierarchy event ids.
final public static int HIERARCHY_CHANGED
The event id indicating that modification was made to the entire hierarchy tree.
final public static int ANCESTOR_MOVED
The event id indicating an ancestor-Container was moved.
final public static int ANCESTOR_RESIZED
The event id indicating an ancestor-Container was resized.
final public static int HIERARCHY_LAST
Marks the last integer id for the range of ancestor event ids.
final public static int PARENT_CHANGED
Indicates that the HIERARCHY_CHANGED event was generated by a reparenting operation.
final public static int DISPLAYABILITY_CHANGED Details
Indicates that the HIERARCHY_CHANGED event was generated due to a change in the displayability of the hierarchy. To discern the current displayability of the hierarchy, call Component.isDisplayable. Displayability changes occur in response to explicit or implicit calls to Component.addNotify and Component.removeNotify.
See also isDisplayable(), addNotify(), removeNotify()
final public static int SHOWING_CHANGED Details
Indicates that the HIERARCHY_CHANGED event was generated due to a change in the showing state of the hierarchy. To discern the current showing state of the hierarchy, call Component.isShowing. Showing state changes occur when either the displayability or visibility of the hierarchy occurs. Visibility changes occur in response to explicit or implicit calls to Component.show and Component.hide.
See also isShowing(), addNotify(), removeNotify(), show(), hide()

Constructors
public HierarchyEvent(Component source, int id, Component changed, Container changedParent) Details
Constructs an HierarchyEvent object to identify a change in the Component hierarchy.

Note that passing in an invalid id results in unspecified behavior. This method throws an IllegalArgumentException if source is null.
sourcethe Component object that originated the event
idan integer indicating the type of event
changedthe Component at the top of the hierarchy which was changed
changedParentthe parent of changed; this may be the parent before or after the change, depending on the type of change
ThrowsIllegalArgumentException: if source is null

public HierarchyEvent(Component source, int id, Component changed, Container changedParent, long changeFlags) Details
Constructs an HierarchyEvent object to identify a change in the Component hierarchy.

Note that passing in an invalid id results in unspecified behavior. This method throws an IllegalArgumentException if source is null.
sourcethe Component object that originated the event
idan integer indicating the type of event
changedthe Component at the top of the hierarchy which was changed
changedParentthe parent of changed; this may be the parent before or after the change, depending on the type of change
changeFlagsa bitmask which indicates the type(s) of HIERARCHY_CHANGED events represented in this event object
ThrowsIllegalArgumentException: if source is null


Methods
public String paramString() Details
Returns a parameter string identifying this event. This method is useful for event-logging and for debugging.
returna string identifying the event and its attributes

Properties
public Component getChanged() Details
Returns the Component at the top of the hierarchy which was changed.
returnthe changed Component
public Container getChangedParent() Details
Returns the parent of the Component returned by getChanged(). For a HIERARCHY_CHANGED event where the change was of type PARENT_CHANGED via a call to Container.add, the parent returned is the parent after the add operation. For a HIERARCHY_CHANGED event where the change was of type PARENT_CHANGED via a call to Container.remove, the parent returned is the parent before the remove operation. For all other events and types, the parent returned is the parent during the operation.
returnthe parent of the changed Component
public long getChangeFlags() Details
Returns a bitmask which indicates the type(s) of HIERARCHY_CHANGED events represented in this event object. The bits have been bitwise-ored together.
returnthe bitmask, or 0 if this is not an HIERARCHY_CHANGED event
public Component getComponent() Details
Returns the originator of the event.
returnthe Component object that originated the event, or null if the object is not a Component.
About DocWeb · Bundles · Export · Export AllTop 10 · Statistics · Login
About Sun · Contact · Privacy · Terms of Use · Trademarks
Java SE 6
· Copyright © 1994-2013 Sun Microsystems, Inc.
All rights reserved. Use is subject to license terms