| |
|
| java.awt.AWTEvent
 java.awt.event.HierarchyEvent
| HierarchyEvent | | public class HierarchyEvent extends AWTEvent (Code) | | 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.
author:
David Mendenhall
version:
1.20, 05/05/07
See Also: HierarchyListener
See Also: HierarchyBoundsAdapter
See Also: HierarchyBoundsListener
since:
1.3 |
| Field Summary | |
| 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 | DISPLAYABILITY_CHANGED
Indicates that the HIERARCHY_CHANGED event
was generated due to a change in the displayability
of the hierarchy. | | final public static int | HIERARCHY_CHANGED
The event id indicating that modification was made to the
entire hierarchy tree. | | final public static int | HIERARCHY_FIRST
Marks the first integer id for the range of hierarchy event ids. | | 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 | SHOWING_CHANGED
Indicates that the HIERARCHY_CHANGED event
was generated due to a change in the showing state
of the hierarchy. | | long | changeFlags
| | Component | changed
| | Container | changedParent
|
| Constructor Summary | |
| 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. | | 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. |
| Method Summary | |
| public long | getChangeFlags()
Returns a bitmask which indicates the type(s) of
HIERARCHY_CHANGED events represented in this event object. | | 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(). | | public Component | getComponent()
Returns the originator of the event.
the Component object that originated the event, or null if the object is not a Component. | | public String | paramString()
Returns a parameter string identifying this event. |
| ANCESTOR_MOVED | | final public static int ANCESTOR_MOVED(Code) | | The event id indicating an ancestor-Container was moved.
|
| ANCESTOR_RESIZED | | final public static int ANCESTOR_RESIZED(Code) | | The event id indicating an ancestor-Container was resized.
|
| DISPLAYABILITY_CHANGED | | final public static int DISPLAYABILITY_CHANGED(Code) | | 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
See Also: java.awt.Component.addNotify
See Also: java.awt.Component.removeNotify |
| HIERARCHY_CHANGED | | final public static int HIERARCHY_CHANGED(Code) | | The event id indicating that modification was made to the
entire hierarchy tree.
|
| HIERARCHY_FIRST | | final public static int HIERARCHY_FIRST(Code) | | Marks the first integer id for the range of hierarchy event ids.
|
| HIERARCHY_LAST | | final public static int HIERARCHY_LAST(Code) | | Marks the last integer id for the range of ancestor event ids.
|
| PARENT_CHANGED | | final public static int PARENT_CHANGED(Code) | | Indicates that the HIERARCHY_CHANGED event
was generated by a reparenting operation.
|
| changeFlags | | long changeFlags(Code) | | |
| HierarchyEvent | | public HierarchyEvent(Component source, int id, Component changed, Container changedParent)(Code) | | 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 thatoriginated the event
Parameters:
id - an integer indicating the type of event
Parameters:
changed - the Component at the top ofthe hierarchy which was changed
Parameters:
changedParent - the parent of changed; thismay be the parent before or after thechange, depending on the type of change
throws:
IllegalArgumentException - if source is null |
| HierarchyEvent | | public HierarchyEvent(Component source, int id, Component changed, Container changedParent, long changeFlags)(Code) | | 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 thatoriginated the event
Parameters:
id - an integer indicating the type of event
Parameters:
changed - the Component at the topof the hierarchy which was changed
Parameters:
changedParent - the parent of changed; thismay be the parent before or after thechange, depending on the type of change
Parameters:
changeFlags - a bitmask which indicates the type(s) ofHIERARCHY_CHANGED eventsrepresented in this event object
throws:
IllegalArgumentException - if source is null |
| getChangeFlags | | public long getChangeFlags()(Code) | | Returns a bitmask which indicates the type(s) of
HIERARCHY_CHANGED events represented in this event object.
The bits have been bitwise-ored together.
the bitmask, or 0 if this is not an HIERARCHY_CHANGEDevent |
| getChanged | | public Component getChanged()(Code) | | Returns the Component at the top of the hierarchy which was
changed.
the changed Component |
| getChangedParent | | public Container getChangedParent()(Code) | | 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.
the parent of the changed Component |
| getComponent | | public Component getComponent()(Code) | | Returns the originator of the event.
the Component object that originated the event, or null if the object is not a Component. |
| paramString | | public String paramString()(Code) | | Returns a parameter string identifying this event.
This method is useful for event-logging and for debugging.
a string identifying the event and its attributes |
|
|
|