java.awt.event
Class ContainerEvent

java.lang.Object
  extended by java.util.EventObject
      extended by java.awt.AWTEvent
          extended by java.awt.event.ComponentEvent
              extended by java.awt.event.ContainerEvent
All Implemented Interfaces:
Serializable

public class ContainerEvent
extends ComponentEvent

This event is generated when a component is added or removed from a container. Applications do not ordinarily need to handle these events since the AWT system handles them internally.

Since:
1.1
See Also:
ContainerAdapter, ContainerListener, Serialized Form

Field Summary
static int COMPONENT_ADDED
          This id indicates a component was added to the container.
static int COMPONENT_REMOVED
          This id indicates a component was removed from the container.
static int CONTAINER_FIRST
          This is the first id in the id range used by this class.
static int CONTAINER_LAST
          This is the last id in the id range used by this class.
 
Fields inherited from class java.awt.event.ComponentEvent
COMPONENT_FIRST, COMPONENT_HIDDEN, COMPONENT_LAST, COMPONENT_MOVED, COMPONENT_RESIZED, COMPONENT_SHOWN
 
Fields inherited from class java.awt.AWTEvent
ACTION_EVENT_MASK, ADJUSTMENT_EVENT_MASK, COMPONENT_EVENT_MASK, consumed, CONTAINER_EVENT_MASK, FOCUS_EVENT_MASK, HIERARCHY_BOUNDS_EVENT_MASK, HIERARCHY_EVENT_MASK, id, INPUT_METHOD_EVENT_MASK, INVOCATION_EVENT_MASK, ITEM_EVENT_MASK, KEY_EVENT_MASK, MOUSE_EVENT_MASK, MOUSE_MOTION_EVENT_MASK, MOUSE_WHEEL_EVENT_MASK, PAINT_EVENT_MASK, RESERVED_ID_MAX, TEXT_EVENT_MASK, WINDOW_EVENT_MASK, WINDOW_FOCUS_EVENT_MASK, WINDOW_STATE_EVENT_MASK
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
ContainerEvent(Component source, int id, Component child)
          Initializes a new instance of ContainerEvent with the specified source and id.
 
Method Summary
 Component getChild()
          This method returns the child object that was added or removed from the container.
 Container getContainer()
          Returns the source of this event as a Container.
 String paramString()
          This method returns a string identifying this event.
 
Methods inherited from class java.awt.event.ComponentEvent
getComponent
 
Methods inherited from class java.awt.AWTEvent
consume, getID, isConsumed, setSource, toString
 
Methods inherited from class java.util.EventObject
getSource
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

CONTAINER_FIRST

public static final int CONTAINER_FIRST
This is the first id in the id range used by this class.

See Also:
Constant Field Values

CONTAINER_LAST

public static final int CONTAINER_LAST
This is the last id in the id range used by this class.

See Also:
Constant Field Values

COMPONENT_ADDED

public static final int COMPONENT_ADDED
This id indicates a component was added to the container.

See Also:
Constant Field Values

COMPONENT_REMOVED

public static final int COMPONENT_REMOVED
This id indicates a component was removed from the container.

See Also:
Constant Field Values
Constructor Detail

ContainerEvent

public ContainerEvent(Component source,
                      int id,
                      Component child)
Initializes a new instance of ContainerEvent with the specified source and id. Additionally, the affected child component is also passed as a parameter. Note that an invalid id leads to unspecified results.

Parameters:
source - the source container of the event
id - the event id
child - the child component affected by this event
Throws:
IllegalArgumentException - if source is null
Method Detail

getContainer

public Container getContainer()
Returns the source of this event as a Container.

Returns:
the source of the event
Throws:
ClassCastException - if the source is changed to a non-Container

getChild

public Component getChild()
This method returns the child object that was added or removed from the container.

Returns:
the child object added or removed

paramString

public String paramString()
This method returns a string identifying this event. It is formatted as: (getID() == COMPONENT_ADDED ? "COMPONENT_ADDED" : "COMPONENT_REMOVED") + ",child=" + getChild().getName().

Overrides:
paramString in class ComponentEvent
Returns:
a string identifying this event