HierarchyEvent JDK 1.6)

Description

public class HierarchyEvent

An event which indicates a change to the Component hierarchy to which a Component belongs.

Hierarchy Change Events (HierarchyListener)
- addition of an ancestor
- removal of an ancestor
- hierarchy made displayable
- hierarchy made undisplayable
- hierarchy shown on the screen (both visible and displayable)
- hierarchy hidden on the screen (either invisible or undisplayable)
Ancestor Reshape Events (HierarchyBoundsListener)
- an ancestor was resized
- an ancestor was moved

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.

See also: HierarchyListener HierarchyBoundsAdapter HierarchyBoundsListener

Constructors

public HierarchyEvent (Component source, int id, Component changed, 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 - if source is null

public HierarchyEvent (Component source, int id, Component changed, 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 - if source is null

Methods

Hide/Show inherited methods

protected void consume () [Inherited From AWTEvent]

Consumes this event, if this event can be consumed.

public Component getChanged ()

Returns the Component at the top of the hierarchy which was changed.

public Container getChangedParent ()

Returns the parent of the Component returned by


 getChanged()

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

public long getChangeFlags ()

Returns a bitmask which indicates the type(s) of HIERARCHY_CHANGED events represented in this event object.

public Component getComponent ()

Returns the originator of the event.

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

public int getID () [Inherited From AWTEvent]

Returns the event type.

public Object getSource () [Inherited From EventObject]

The object on which the Event initially occurred.

protected boolean isConsumed () [Inherited From AWTEvent]

Returns whether this event has been consumed.

public String paramString () [Overrides AWTEvent]

Returns a parameter string identifying this event.

public void setSource (Object newSource) [Inherited From AWTEvent]

Retargets an event to a new source.

public String toString () [Inherited From AWTEvent]

Returns a String representation of this object.

Fields

Hide/Show inherited fields

publicfinalstatic long ACTION_EVENT_MASK = "128" [Inherited From AWTEvent]

The event mask for selecting action events.

publicfinalstatic long ADJUSTMENT_EVENT_MASK = "256" [Inherited From AWTEvent]

The event mask for selecting adjustment events.

publicfinalstatic int ANCESTOR_MOVED = "1401"

The event id indicating an ancestor-Container was moved.

publicfinalstatic int ANCESTOR_RESIZED = "1402"

The event id indicating an ancestor-Container was resized.

pack-private Component changed

pack-private Container changedParent

pack-private long changeFlags

publicfinalstatic long COMPONENT_EVENT_MASK = "1" [Inherited From AWTEvent]

The event mask for selecting component events.

protected boolean consumed [Inherited From AWTEvent]

Controls whether or not the event is sent back down to the peer once the source has processed it - false means it's sent to the peer; true means it's not.

publicfinalstatic long CONTAINER_EVENT_MASK = "2" [Inherited From AWTEvent]

The event mask for selecting container events.

publicfinalstatic int DISPLAYABILITY_CHANGED = "2"

Indicates that the HIERARCHY_CHANGED event was generated due to a change in the displayability of the hierarchy.

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(), Component.addNotify(), Component.removeNotify(),

publicfinalstatic long FOCUS_EVENT_MASK = "4" [Inherited From AWTEvent]

The event mask for selecting focus events.

publicfinalstatic long HIERARCHY_BOUNDS_EVENT_MASK = "65536" [Inherited From AWTEvent]

The event mask for selecting hierarchy bounds events.

publicfinalstatic int HIERARCHY_CHANGED = "1400"

The event id indicating that modification was made to the entire hierarchy tree.

publicfinalstatic long HIERARCHY_EVENT_MASK = "32768" [Inherited From AWTEvent]

The event mask for selecting hierarchy events.

publicfinalstatic int HIERARCHY_FIRST = "1400"

Marks the first integer id for the range of hierarchy event ids.

publicfinalstatic int HIERARCHY_LAST = "1402"

Marks the last integer id for the range of ancestor event ids.

protected int id [Inherited From AWTEvent]

The event's id.

publicfinalstatic long INPUT_METHOD_EVENT_MASK = "2048" [Inherited From AWTEvent]

The event mask for selecting input method events.

publicfinalstatic long INVOCATION_EVENT_MASK = "16384" [Inherited From AWTEvent]

The event mask for selecting invocation events.

publicfinalstatic long ITEM_EVENT_MASK = "512" [Inherited From AWTEvent]

The event mask for selecting item events.

publicfinalstatic long KEY_EVENT_MASK = "8" [Inherited From AWTEvent]

The event mask for selecting key events.

publicfinalstatic long MOUSE_EVENT_MASK = "16" [Inherited From AWTEvent]

The event mask for selecting mouse events.

publicfinalstatic long MOUSE_MOTION_EVENT_MASK = "32" [Inherited From AWTEvent]

The event mask for selecting mouse motion events.

publicfinalstatic long MOUSE_WHEEL_EVENT_MASK = "131072" [Inherited From AWTEvent]

The event mask for selecting mouse wheel events.

publicfinalstatic long PAINT_EVENT_MASK = "8192" [Inherited From AWTEvent]

The event mask for selecting paint events.

publicfinalstatic int PARENT_CHANGED = "1"

Indicates that the HIERARCHY_CHANGED event was generated by a reparenting operation.

publicfinalstatic int RESERVED_ID_MAX = "1999" [Inherited From AWTEvent]

The maximum value for reserved AWT event IDs.

publicfinalstatic int SHOWING_CHANGED = "4"

Indicates that the HIERARCHY_CHANGED event was generated due to a change in the showing state of the hierarchy.

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(), Component.addNotify(), Component.removeNotify(), Component.show(), Component.hide(),

protectedtransient Object source [Inherited From EventObject]

The object on which the Event initially occurred.

publicfinalstatic long TEXT_EVENT_MASK = "1024" [Inherited From AWTEvent]

The event mask for selecting text events.

publicfinalstatic long WINDOW_EVENT_MASK = "64" [Inherited From AWTEvent]

The event mask for selecting window events.

publicfinalstatic long WINDOW_FOCUS_EVENT_MASK = "524288" [Inherited From AWTEvent]

The event mask for selecting window focus events.

publicfinalstatic long WINDOW_STATE_EVENT_MASK = "262144" [Inherited From AWTEvent]

The event mask for selecting window state events.