java.awt.event
Class HierarchyEvent

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by java.util.EventObject sample code for java.util.EventObject definition code for java.util.EventObject 
      extended by java.awt.AWTEvent sample code for java.awt.AWTEvent definition code for java.awt.AWTEvent 
          extended by java.awt.event.HierarchyEvent
All Implemented Interfaces:
Serializable sample code for java.io.Serializable definition code for java.io.Serializable

public class HierarchyEvent
extends AWTEvent sample code for java.awt.AWTEvent definition code for java.awt.AWTEvent

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.

Since:
1.3
See Also:
HierarchyListener sample code for java.awt.event.HierarchyListener definition code for java.awt.event.HierarchyListener , HierarchyBoundsAdapter sample code for java.awt.event.HierarchyBoundsAdapter definition code for java.awt.event.HierarchyBoundsAdapter , HierarchyBoundsListener sample code for java.awt.event.HierarchyBoundsListener definition code for java.awt.event.HierarchyBoundsListener , Serialized Form

Field Summary
static int ANCESTOR_MOVED sample code for java.awt.event.HierarchyEvent.ANCESTOR_MOVED definition code for java.awt.event.HierarchyEvent.ANCESTOR_MOVED
          The event id indicating an ancestor-Container was moved.
static int ANCESTOR_RESIZED sample code for java.awt.event.HierarchyEvent.ANCESTOR_RESIZED definition code for java.awt.event.HierarchyEvent.ANCESTOR_RESIZED
          The event id indicating an ancestor-Container was resized.
static int DISPLAYABILITY_CHANGED sample code for java.awt.event.HierarchyEvent.DISPLAYABILITY_CHANGED definition code for java.awt.event.HierarchyEvent.DISPLAYABILITY_CHANGED
          Indicates that the HIERARCHY_CHANGED event was generated due to a change in the displayability of the hierarchy.
static int HIERARCHY_CHANGED sample code for java.awt.event.HierarchyEvent.HIERARCHY_CHANGED definition code for java.awt.event.HierarchyEvent.HIERARCHY_CHANGED
          The event id indicating that modification was made to the entire hierarchy tree.
static int HIERARCHY_FIRST sample code for java.awt.event.HierarchyEvent.HIERARCHY_FIRST definition code for java.awt.event.HierarchyEvent.HIERARCHY_FIRST
          Marks the first integer id for the range of hierarchy event ids.
static int HIERARCHY_LAST sample code for java.awt.event.HierarchyEvent.HIERARCHY_LAST definition code for java.awt.event.HierarchyEvent.HIERARCHY_LAST
          Marks the last integer id for the range of ancestor event ids.
static int PARENT_CHANGED sample code for java.awt.event.HierarchyEvent.PARENT_CHANGED definition code for java.awt.event.HierarchyEvent.PARENT_CHANGED
          Indicates that the HIERARCHY_CHANGED event was generated by a reparenting operation.
static int SHOWING_CHANGED sample code for java.awt.event.HierarchyEvent.SHOWING_CHANGED definition code for java.awt.event.HierarchyEvent.SHOWING_CHANGED
          Indicates that the HIERARCHY_CHANGED event was generated due to a change in the showing state of the hierarchy.
 
Fields inherited from class java.awt.AWTEvent sample code for java.awt.AWTEvent definition code for java.awt.AWTEvent
ACTION_EVENT_MASK sample code for java.awt.AWTEvent.ACTION_EVENT_MASK definition code for java.awt.AWTEvent.ACTION_EVENT_MASK , ADJUSTMENT_EVENT_MASK sample code for java.awt.AWTEvent.ADJUSTMENT_EVENT_MASK definition code for java.awt.AWTEvent.ADJUSTMENT_EVENT_MASK , COMPONENT_EVENT_MASK sample code for java.awt.AWTEvent.COMPONENT_EVENT_MASK definition code for java.awt.AWTEvent.COMPONENT_EVENT_MASK , consumed sample code for java.awt.AWTEvent.consumed definition code for java.awt.AWTEvent.consumed , CONTAINER_EVENT_MASK sample code for java.awt.AWTEvent.CONTAINER_EVENT_MASK definition code for java.awt.AWTEvent.CONTAINER_EVENT_MASK , FOCUS_EVENT_MASK sample code for java.awt.AWTEvent.FOCUS_EVENT_MASK definition code for java.awt.AWTEvent.FOCUS_EVENT_MASK , HIERARCHY_BOUNDS_EVENT_MASK sample code for java.awt.AWTEvent.HIERARCHY_BOUNDS_EVENT_MASK definition code for java.awt.AWTEvent.HIERARCHY_BOUNDS_EVENT_MASK , HIERARCHY_EVENT_MASK sample code for java.awt.AWTEvent.HIERARCHY_EVENT_MASK definition code for java.awt.AWTEvent.HIERARCHY_EVENT_MASK , id sample code for java.awt.AWTEvent.id definition code for java.awt.AWTEvent.id , INPUT_METHOD_EVENT_MASK sample code for java.awt.AWTEvent.INPUT_METHOD_EVENT_MASK definition code for java.awt.AWTEvent.INPUT_METHOD_EVENT_MASK , INVOCATION_EVENT_MASK sample code for java.awt.AWTEvent.INVOCATION_EVENT_MASK definition code for java.awt.AWTEvent.INVOCATION_EVENT_MASK , ITEM_EVENT_MASK sample code for java.awt.AWTEvent.ITEM_EVENT_MASK definition code for java.awt.AWTEvent.ITEM_EVENT_MASK , KEY_EVENT_MASK sample code for java.awt.AWTEvent.KEY_EVENT_MASK definition code for java.awt.AWTEvent.KEY_EVENT_MASK , MOUSE_EVENT_MASK sample code for java.awt.AWTEvent.MOUSE_EVENT_MASK definition code for java.awt.AWTEvent.MOUSE_EVENT_MASK , MOUSE_MOTION_EVENT_MASK sample code for java.awt.AWTEvent.MOUSE_MOTION_EVENT_MASK definition code for java.awt.AWTEvent.MOUSE_MOTION_EVENT_MASK , MOUSE_WHEEL_EVENT_MASK sample code for java.awt.AWTEvent.MOUSE_WHEEL_EVENT_MASK definition code for java.awt.AWTEvent.MOUSE_WHEEL_EVENT_MASK , PAINT_EVENT_MASK sample code for java.awt.AWTEvent.PAINT_EVENT_MASK definition code for java.awt.AWTEvent.PAINT_EVENT_MASK , RESERVED_ID_MAX sample code for java.awt.AWTEvent.RESERVED_ID_MAX definition code for java.awt.AWTEvent.RESERVED_ID_MAX , TEXT_EVENT_MASK sample code for java.awt.AWTEvent.TEXT_EVENT_MASK definition code for java.awt.AWTEvent.TEXT_EVENT_MASK , WINDOW_EVENT_MASK sample code for java.awt.AWTEvent.WINDOW_EVENT_MASK definition code for java.awt.AWTEvent.WINDOW_EVENT_MASK , WINDOW_FOCUS_EVENT_MASK sample code for java.awt.AWTEvent.WINDOW_FOCUS_EVENT_MASK definition code for java.awt.AWTEvent.WINDOW_FOCUS_EVENT_MASK , WINDOW_STATE_EVENT_MASK sample code for java.awt.AWTEvent.WINDOW_STATE_EVENT_MASK definition code for java.awt.AWTEvent.WINDOW_STATE_EVENT_MASK
 
Fields inherited from class java.util.EventObject sample code for java.util.EventObject definition code for java.util.EventObject
source sample code for java.util.EventObject.source definition code for java.util.EventObject.source
 
Constructor Summary
HierarchyEvent sample code for java.awt.event.HierarchyEvent.HierarchyEvent(java.awt.Component, int, java.awt.Component, java.awt.Container) definition code for java.awt.event.HierarchyEvent.HierarchyEvent(java.awt.Component, int, java.awt.Component, java.awt.Container) (Component sample code for java.awt.Component definition code for java.awt.Component  source, int id, Component sample code for java.awt.Component definition code for java.awt.Component  changed, Container sample code for java.awt.Container definition code for java.awt.Container  changedParent)
          Constructs an HierarchyEvent object to identify a change in the Component hierarchy.
HierarchyEvent sample code for java.awt.event.HierarchyEvent.HierarchyEvent(java.awt.Component, int, java.awt.Component, java.awt.Container, long) definition code for java.awt.event.HierarchyEvent.HierarchyEvent(java.awt.Component, int, java.awt.Component, java.awt.Container, long) (Component sample code for java.awt.Component definition code for java.awt.Component  source, int id, Component sample code for java.awt.Component definition code for java.awt.Component  changed, Container sample code for java.awt.Container definition code for java.awt.Container  changedParent, long changeFlags)
          Constructs an HierarchyEvent object to identify a change in the Component hierarchy.
 
Method Summary
 Component sample code for java.awt.Component definition code for java.awt.Component getChanged sample code for java.awt.event.HierarchyEvent.getChanged() definition code for java.awt.event.HierarchyEvent.getChanged() ()
          Returns the Component at the top of the hierarchy which was changed.
 Container sample code for java.awt.Container definition code for java.awt.Container getChangedParent sample code for java.awt.event.HierarchyEvent.getChangedParent() definition code for java.awt.event.HierarchyEvent.getChangedParent() ()
          Returns the parent of the Component returned by getChanged().
 long getChangeFlags sample code for java.awt.event.HierarchyEvent.getChangeFlags() definition code for java.awt.event.HierarchyEvent.getChangeFlags() ()
          Returns a bitmask which indicates the type(s) of HIERARCHY_CHANGED events represented in this event object.
 Component sample code for java.awt.Component definition code for java.awt.Component getComponent sample code for java.awt.event.HierarchyEvent.getComponent() definition code for java.awt.event.HierarchyEvent.getComponent() ()
          Returns the originator of the event.
 String sample code for java.lang.String definition code for java.lang.String paramString sample code for java.awt.event.HierarchyEvent.paramString() definition code for java.awt.event.HierarchyEvent.paramString() ()
          Returns a parameter string identifying this event.
 
Methods inherited from class java.awt.AWTEvent sample code for java.awt.AWTEvent definition code for java.awt.AWTEvent
consume sample code for java.awt.AWTEvent.consume() definition code for java.awt.AWTEvent.consume() , getID sample code for java.awt.AWTEvent.getID() definition code for java.awt.AWTEvent.getID() , isConsumed sample code for java.awt.AWTEvent.isConsumed() definition code for java.awt.AWTEvent.isConsumed() , setSource sample code for java.awt.AWTEvent.setSource(java.lang.Object) definition code for java.awt.AWTEvent.setSource(java.lang.Object) , toString sample code for java.awt.AWTEvent.toString() definition code for java.awt.AWTEvent.toString()
 
Methods inherited from class java.util.EventObject sample code for java.util.EventObject definition code for java.util.EventObject
getSource sample code for java.util.EventObject.getSource() definition code for java.util.EventObject.getSource()
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() , equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , hashCode sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Field Detail

HIERARCHY_FIRST sample code for java.awt.event.HierarchyEvent.HIERARCHY_FIRST

public static final int HIERARCHY_FIRST
Marks the first integer id for the range of hierarchy event ids.

See Also:
Constant Field Values

HIERARCHY_CHANGED sample code for java.awt.event.HierarchyEvent.HIERARCHY_CHANGED

public static final int HIERARCHY_CHANGED
The event id indicating that modification was made to the entire hierarchy tree.

See Also:
Constant Field Values

ANCESTOR_MOVED sample code for java.awt.event.HierarchyEvent.ANCESTOR_MOVED

public static final int ANCESTOR_MOVED
The event id indicating an ancestor-Container was moved.

See Also:
Constant Field Values

ANCESTOR_RESIZED sample code for java.awt.event.HierarchyEvent.ANCESTOR_RESIZED

public static final int ANCESTOR_RESIZED
The event id indicating an ancestor-Container was resized.

See Also:
Constant Field Values

HIERARCHY_LAST sample code for java.awt.event.HierarchyEvent.HIERARCHY_LAST

public static final int HIERARCHY_LAST
Marks the last integer id for the range of ancestor event ids.

See Also:
Constant Field Values

PARENT_CHANGED sample code for java.awt.event.HierarchyEvent.PARENT_CHANGED

public static final int PARENT_CHANGED
Indicates that the HIERARCHY_CHANGED event was generated by a reparenting operation.

See Also:
Constant Field Values

DISPLAYABILITY_CHANGED sample code for java.awt.event.HierarchyEvent.DISPLAYABILITY_CHANGED

public static final int DISPLAYABILITY_CHANGED
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:
Component.isDisplayable() sample code for java.awt.Component.isDisplayable() definition code for java.awt.Component.isDisplayable() , Component.addNotify() sample code for java.awt.Component.addNotify() definition code for java.awt.Component.addNotify() , Component.removeNotify() sample code for java.awt.Component.removeNotify() definition code for java.awt.Component.removeNotify() , Constant Field Values

SHOWING_CHANGED sample code for java.awt.event.HierarchyEvent.SHOWING_CHANGED

public static final int SHOWING_CHANGED
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:
Component.isShowing() sample code for java.awt.Component.isShowing() definition code for java.awt.Component.isShowing() , Component.addNotify() sample code for java.awt.Component.addNotify() definition code for java.awt.Component.addNotify() , Component.removeNotify() sample code for java.awt.Component.removeNotify() definition code for java.awt.Component.removeNotify() , Component.show() sample code for java.awt.Component.show() definition code for java.awt.Component.show() , Component.hide() sample code for java.awt.Component.hide() definition code for java.awt.Component.hide() , Constant Field Values
Constructor Detail

HierarchyEvent sample code for java.awt.event.HierarchyEvent(java.awt.Component, int, java.awt.Component, java.awt.Container) definition code for java.awt.event.HierarchyEvent(java.awt.Component, int, java.awt.Component, java.awt.Container)

public HierarchyEvent(Component sample code for java.awt.Component definition code for java.awt.Component  source,
                      int id,
                      Component sample code for java.awt.Component definition code for java.awt.Component  changed,
                      Container sample code for java.awt.Container definition code for java.awt.Container  changedParent)
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.

Parameters:
source - the Component object that originated the event
id - an integer indicating the type of event
changed - the Component at the top of the hierarchy which was changed
changedParent - the parent of changed; this may be the parent before or after the change, depending on the type of change
Throws:
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if source is null

HierarchyEvent sample code for java.awt.event.HierarchyEvent(java.awt.Component, int, java.awt.Component, java.awt.Container, long) definition code for java.awt.event.HierarchyEvent(java.awt.Component, int, java.awt.Component, java.awt.Container, long)

public HierarchyEvent(Component sample code for java.awt.Component definition code for java.awt.Component  source,
                      int id,
                      Component sample code for java.awt.Component definition code for java.awt.Component  changed,
                      Container sample code for java.awt.Container definition code for java.awt.Container  changedParent,
                      long changeFlags)
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.

Parameters:
source - the Component object that originated the event
id - an integer indicating the type of event
changed - the Component at the top of the hierarchy which was changed
changedParent - the parent of changed; this may be the parent before or after the change, depending on the type of change
changeFlags - a bitmask which indicates the type(s) of HIERARCHY_CHANGED events represented in this event object
Throws:
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if source is null
Method Detail

getComponent sample code for java.awt.event.HierarchyEvent.getComponent() definition code for java.awt.event.HierarchyEvent.getComponent()

public Component sample code for java.awt.Component definition code for java.awt.Component  getComponent()
Returns the originator of the event.

Returns:
the Component object that originated the event, or null if the object is not a Component.

getChanged sample code for java.awt.event.HierarchyEvent.getChanged() definition code for java.awt.event.HierarchyEvent.getChanged()

public Component sample code for java.awt.Component definition code for java.awt.Component  getChanged()
Returns the Component at the top of the hierarchy which was changed.

Returns:
the changed Component

getChangedParent sample code for java.awt.event.HierarchyEvent.getChangedParent() definition code for java.awt.event.HierarchyEvent.getChangedParent()

public Container sample code for java.awt.Container definition code for java.awt.Container  getChangedParent()
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.

Returns:
the parent of the changed Component

getChangeFlags sample code for java.awt.event.HierarchyEvent.getChangeFlags() definition code for java.awt.event.HierarchyEvent.getChangeFlags()

public long getChangeFlags()
Returns a bitmask which indicates the type(s) of HIERARCHY_CHANGED events represented in this event object. The bits have been bitwise-ored together.

Returns:
the bitmask, or 0 if this is not an HIERARCHY_CHANGED event

paramString sample code for java.awt.event.HierarchyEvent.paramString() definition code for java.awt.event.HierarchyEvent.paramString()

public String sample code for java.lang.String definition code for java.lang.String  paramString()
Returns a parameter string identifying this event. This method is useful for event-logging and for debugging.

Overrides:
paramString sample code for java.awt.AWTEvent.paramString() definition code for java.awt.AWTEvent.paramString() in class AWTEvent sample code for java.awt.AWTEvent definition code for java.awt.AWTEvent
Returns:
a string identifying the event and its attributes