declare namespace java {
namespace awt {
namespace event {
/**
* An event which indicates a change to the Component
* hierarchy to which 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. The {@code ANCESTOR_MOVED} and
* {@code 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.) The {@code 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.
*
* An unspecified behavior will be caused if the {@code id} parameter
* of any particular {@code HierarchyEvent} instance is not
* in the range from {@code HIERARCHY_FIRST} to {@code HIERARCHY_LAST}.
*
* The {@code changeFlags} parameter of any {@code HierarchyEvent} instance takes one of the following
* values:
*
HierarchyEvent
object to identify a
* change in the Component
hierarchy.
* This method throws an
* IllegalArgumentException
if source
* is null
.
* @param source The Component
object that
* originated the event
* @param id An integer indicating the type of event.
* For information on allowable values, see
* the class description for {#link HierarchyEvent}
* @param changed The Component
at the top of
* the hierarchy which was changed
* @param changedParent The parent of the changed
component.
* This
* may be the parent before or after the
* change, depending on the type of change
* @throws IllegalArgumentException if source
is {#code null}
* @see #getSource()
* @see #getID()
* @see #getChanged()
* @see #getChangedParent()
*/
// @ts-ignore
constructor(source: java.awt.Component, id: number /*int*/, changed: java.awt.Component, changedParent: java.awt.Container)
/**
* Constructs an HierarchyEvent
object to identify
* a change in the Component
hierarchy.
*
This method throws an
* IllegalArgumentException
if source
* is null
.
* @param source The Component
object that
* originated the event
* @param id An integer indicating the type of event.
* For information on allowable values, see
* the class description for {#link HierarchyEvent}
* @param changed The Component
at the top
* of the hierarchy which was changed
* @param changedParent The parent of the changed
component.
* This
* may be the parent before or after the
* change, depending on the type of change
* @param changeFlags A bitmask which indicates the type(s) of
* the HIERARCHY_CHANGED
events
* represented in this event object.
* For information on allowable values, see
* the class description for {#link HierarchyEvent}
* @throws IllegalArgumentException if source
is null
* @see #getSource()
* @see #getID()
* @see #getChanged()
* @see #getChangedParent()
* @see #getChangeFlags()
*/
// @ts-ignore
constructor(source: java.awt.Component, id: number /*int*/, changed: java.awt.Component, changedParent: java.awt.Container, changeFlags: number /*long*/)
/**
* Marks the first integer id for the range of hierarchy event ids.
*/
// @ts-ignore
public static readonly HIERARCHY_FIRST: number /*int*/
/**
* The event id indicating that modification was made to the
* entire hierarchy tree.
*/
// @ts-ignore
public static readonly HIERARCHY_CHANGED: number /*int*/
/**
* The event id indicating an ancestor-Container was moved.
*/
// @ts-ignore
public static readonly ANCESTOR_MOVED: number /*int*/
/**
* The event id indicating an ancestor-Container was resized.
*/
// @ts-ignore
public static readonly ANCESTOR_RESIZED: number /*int*/
/**
* Marks the last integer id for the range of ancestor event ids.
*/
// @ts-ignore
public static readonly HIERARCHY_LAST: number /*int*/
/**
* A change flag indicates that the HIERARCHY_CHANGED
event
* was generated by a reparenting operation.
*/
// @ts-ignore
public static readonly PARENT_CHANGED: number /*int*/
/**
* A change flag indicates that the HIERARCHY_CHANGED
event
* was generated due to the changing of the hierarchy displayability.
* To discern the
* current displayability of the hierarchy, call the
* Component.isDisplayable
method. Displayability changes occur
* in response to explicit or implicit calls of the
* Component.addNotify
and
* Component.removeNotify
methods.
* @see java.awt.Component#isDisplayable()
* @see java.awt.Component#addNotify()
* @see java.awt.Component#removeNotify()
*/
// @ts-ignore
public static readonly DISPLAYABILITY_CHANGED: number /*int*/
/**
* A change flag indicates that the HIERARCHY_CHANGED
event
* was generated due to the changing of the hierarchy showing state.
* To discern the
* current showing state of the hierarchy, call the
* Component.isShowing
method. Showing state changes occur
* when either the displayability or visibility of the
* hierarchy occurs. Visibility changes occur in response to explicit
* or implicit calls of the Component.show
and
* Component.hide
methods.
* @see java.awt.Component#isShowing()
* @see java.awt.Component#addNotify()
* @see java.awt.Component#removeNotify()
* @see java.awt.Component#show()
* @see java.awt.Component#hide()
*/
// @ts-ignore
public static readonly SHOWING_CHANGED: number /*int*/
/**
* Returns the originator of the event.
* @return the Component
object that originated
* the event, or null
if the object is not a
* Component
.
*/
// @ts-ignore
public getComponent(): java.awt.Component
/**
* Returns the Component at the top of the hierarchy which was
* changed.
* @return the changed Component
*/
// @ts-ignore
public getChanged(): java.awt.Component
/**
* 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.
* @return the parent of the changed Component
*/
// @ts-ignore
public getChangedParent(): java.awt.Container
/**
* Returns a bitmask which indicates the type(s) of
* HIERARCHY_CHANGED events represented in this event object.
* The bits have been bitwise-ored together.
* @return the bitmask, or 0 if this is not an HIERARCHY_CHANGED
* event
*/
// @ts-ignore
public getChangeFlags(): number /*long*/
/**
* Returns a parameter string identifying this event.
* This method is useful for event-logging and for debugging.
* @return a string identifying the event and its attributes
*/
// @ts-ignore
public paramString(): string
}
}
}
}