java::awt::event::HierarchyEvent Class Reference

Inheritance diagram for java::awt::event::HierarchyEvent:

Inheritance graph
java::awt::AWTEventjava::util::EventObjectjava::lang::Object
[legend]
Collaboration diagram for java::awt::event::HierarchyEvent:

Collaboration graph
java::awt::AWTEventjava::util::EventObjectjava::lang::Objectjava::lang::ObjectRefjava::lang::Interfacejava::lang::Comparable
[legend]

List of all members.


Detailed Description

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.

Author:
David Mendenhall
Version:
1.10, 01/23/03
See also:
HierarchyListener

HierarchyBoundsAdapter

HierarchyBoundsListener

Since:
1.3

Public Types

enum  HIERARCHY_EVENT_ID {
  HIERARCHY_FIRST = 1400, HIERARCHY_CHANGED = HIERARCHY_FIRST, HIERARCHY_BOUNDS_FIRST, ANCESTOR_MOVED = HIERARCHY_BOUNDS_FIRST,
  ANCESTOR_RESIZED, HIERARCHY_BOUNDS_LAST = ANCESTOR_RESIZED, HIERARCHY_LAST = ANCESTOR_RESIZED
}
enum  HIERARCHY_CHANGE_FLAG { PARENT_CHANGED = 0x1, DISPLAYABILITY_CHANGED = 0x2, SHOWING_CHANGED = 0x4 }

Public Member Functions

 HierarchyEvent (const Ref< Component > &source=0, jint id=HIERARCHY_FIRST, const Ref< Component > &changed=0, const Ref< Container > &changedParent=0, jlong changeFlags=0)
 Constructs an HierarchyEvent object to identify a change in the Component hierarchy.
virtual Ref< ComponentgetComponent () const
 Returns the originator of the event.
virtual Ref< ComponentgetChanged () const
 Returns the Component at the top of the hierarchy which was changed.
virtual Ref< ContainergetChangedParent () const
 Returns the parent of the Component returned by getChanged().
virtual jlong getChangeFlags () const
 Returns a bitmask which indicates the type(s) of HIERARCHY_CHANGED events represented in this event object.
virtual String paramString () const
 Returns a parameter string identifying this event.

Protected Attributes

Ref< Componentchanged
Ref< ContainerchangedParent
jlong changeFlags

Member Enumeration Documentation

enum java::awt::event::HierarchyEvent::HIERARCHY_EVENT_ID

Enumerator:
HIERARCHY_FIRST  Marks the first integer id for the range of hierarchy event ids.
HIERARCHY_CHANGED  The event id indicating that modification was made to the entire hierarchy tree.
HIERARCHY_BOUNDS_FIRST  Marks the first integer id for the range of hierarchy bounds event ids.
ANCESTOR_MOVED  The event id indicating an ancestor-Container was moved.
ANCESTOR_RESIZED  The event id indicating an ancestor-Container was resized.
HIERARCHY_BOUNDS_LAST  Marks the last integer id for the range of hierarchy bounds event ids.
HIERARCHY_LAST  Marks the last integer id for the range of nierarchy event ids.

enum java::awt::event::HierarchyEvent::HIERARCHY_CHANGE_FLAG

Enumerator:
PARENT_CHANGED  Indicates that the HIERARCHY_CHANGED event was generated by a reparenting operation.
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:
java.awt.Component::isDisplayable()

java.awt.Component::addNotify()

java.awt.Component::removeNotify()

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:
java.awt.Component::isShowing()

java.awt.Component::addNotify()

java.awt.Component::removeNotify()

java.awt.Component::show()

java.awt.Component::hide()


Constructor & Destructor Documentation

java::awt::event::HierarchyEvent::HierarchyEvent ( const Ref< Component > &  source = 0,
jint  id = HIERARCHY_FIRST,
const Ref< Component > &  changed = 0,
const Ref< Container > &  changedParent = 0,
jlong  changeFlags = 0 
)

Constructs an HierarchyEvent object to identify a change in the Component hierarchy.

Note that passing in an invalid id results in unspecified behavior.

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


Member Function Documentation

virtual Ref<Component> java::awt::event::HierarchyEvent::getComponent (  )  const [virtual]

Returns the originator of the event.

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

virtual Ref<Component> java::awt::event::HierarchyEvent::getChanged (  )  const [virtual]

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

Returns:
the changed Component

virtual Ref<Container> java::awt::event::HierarchyEvent::getChangedParent (  )  const [virtual]

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

virtual jlong java::awt::event::HierarchyEvent::getChangeFlags (  )  const [virtual]

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

virtual String java::awt::event::HierarchyEvent::paramString (  )  const [virtual]

Returns a parameter string identifying this event.

This method is useful for event-logging and for debugging.

Returns:
a string identifying the event and its attributes

Reimplemented from java::awt::AWTEvent.


Member Data Documentation

Ref<Component> java::awt::event::HierarchyEvent::changed [protected]

Ref<Container> java::awt::event::HierarchyEvent::changedParent [protected]

jlong java::awt::event::HierarchyEvent::changeFlags [protected]


The documentation for this class was generated from the following file:
Generated on Fri May 16 11:56:16 2008 for CrossPlatformJavaLikeC++API by  doxygen 1.5.3