nextapp.echo.event
Class HierarchyEvent

java.lang.Object
  extended by java.util.EventObject
      extended by nextapp.echo.event.HierarchyEvent
All Implemented Interfaces:
java.io.Serializable

public class HierarchyEvent
extends java.util.EventObject

An event describing a change to the component hierarchy.

See Also:
Serialized Form

Field Summary
static int PARENT_CHANGED
           
static int REGISTRATION_CHANGED
           
static int SHOWING_CHANGED
           
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
HierarchyEvent(Component source, long changeFlags, Component changed, Component changedParent)
          Creates a new HierarchyEvent
 
Method Summary
 Component getChanged()
          Returns the component whose state within the hierarchy changed.
 Component getChangedParent()
          Returns the parent (or former parent) of the component whose state within the hierarchy changed.
 long getChangeFlags()
          Returns a bitmask describing the change to the heirarchy.
 Component getComponent()
          Returns the component which generated this event.
 boolean isParentChanged()
          Returns true if the Component's parent has changed.
 boolean isRegistrationChanged()
          Returns true if the Component's registration state has changed.
 boolean isShowingChanged()
          Returns true if the Component's showing state has changed.
 
Methods inherited from class java.util.EventObject
getSource, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

SHOWING_CHANGED

public static final int SHOWING_CHANGED
See Also:
Constant Field Values

PARENT_CHANGED

public static final int PARENT_CHANGED
See Also:
Constant Field Values

REGISTRATION_CHANGED

public static final int REGISTRATION_CHANGED
See Also:
Constant Field Values
Constructor Detail

HierarchyEvent

public HierarchyEvent(Component source,
                      long changeFlags,
                      Component changed,
                      Component changedParent)
Creates a new HierarchyEvent

Parameters:
source - The generator of the event.
Method Detail

getChangeFlags

public long getChangeFlags()
Returns a bitmask describing the change to the heirarchy.

Returns:
A bitmask describing the change to the hierarchy, consisting of the following bits:
  • SHOWING_CHANGED
  • PARENT_CHANGED
  • REGISTRATION_CHANGED

getChanged

public Component getChanged()
Returns the component whose state within the hierarchy changed.

Returns:
The component whose state within the hierarchy changed.

getChangedParent

public Component getChangedParent()
Returns the parent (or former parent) of the component whose state within the hierarchy changed.

Returns:
The parent (or former parent) of the component whose state within the hierarchy changed.

getComponent

public Component getComponent()
Returns the component which generated this event.

Returns:
The component which generated this event.

isParentChanged

public boolean isParentChanged()
Returns true if the Component's parent has changed.

Returns:
True if the Component's parent has changed.

isRegistrationChanged

public boolean isRegistrationChanged()
Returns true if the Component's registration state has changed.

Returns:
True if the Component's registration state has changed.

isShowingChanged

public boolean isShowingChanged()
Returns true if the Component's showing state has changed.

Returns:
True if the Component's showing state has changed.