All Packages  Class Hierarchy  This Package  Previous  Next  Index  

Class java.awt.event.ContainerEvent

java.lang.Object
    |
    +----java.util.EventObject
            |
            +----java.awt.AWTEvent
                    |
                    +----java.awt.event.ComponentEvent
                            |
                            +----java.awt.event.ContainerEvent

public class ContainerEvent
extends ComponentEvent
A low-level event which indicates that a container's contents changed because a component was added or removed.

Container events are provided for notification purposes ONLY; The AWT will automatically handle changes to the containers contents internally so that the program works properly regardless of whether the program is receiving these events or not.

This low-level event is generated by a container object (such as a Panel) when a component is added to it or removed from it. The event is passed to every ContainerListener or ContainerAdapter object which registered to receive such events using the component's addContainerListener method. (ContainerAdapter objects implement the ContainerListener interface.) Each such listener object gets this ContainerEvent when the event occurs.

See Also:
ContainerAdapter, ContainerListener, Tutorial: Writing a Container Listener, Reference: The Java Class Libraries (update file)

Variable Index

 o COMPONENT_ADDED
This event indicates that a component was added to the container.
 o COMPONENT_REMOVED
This event indicates that a component was removed from the container.
 o CONTAINER_FIRST
The first number in the range of ids used for container events.
 o CONTAINER_LAST
The last number in the range of ids used for container events.

Constructor Index

 o ContainerEvent(Component, int, Component)
Constructs a ContainerEvent object.

Method Index

 o getChild()
Returns the component that was affected by the event.
 o getContainer()
Returns the originator of the event.
 o paramString()
Returns a parameter string identifying this event.

Variables

 o CONTAINER_FIRST
public static final int CONTAINER_FIRST
The first number in the range of ids used for container events.

 o CONTAINER_LAST
public static final int CONTAINER_LAST
The last number in the range of ids used for container events.

 o COMPONENT_ADDED
public static final int COMPONENT_ADDED
This event indicates that a component was added to the container.

 o COMPONENT_REMOVED
public static final int COMPONENT_REMOVED
This event indicates that a component was removed from the container.

Constructors

 o ContainerEvent
public ContainerEvent(Component source,
                      int id,
                      Component child)
Constructs a ContainerEvent object.

Parameters:
source - the Component object (container) that originated the event
id - an integer indicating the type of event
child - the component that was added or removed

Methods

 o getContainer
public Container getContainer()
Returns the originator of the event.

Returns:
the Container object that originated the event
 o getChild
public Component getChild()
Returns the component that was affected by the event.

Returns:
the Component object that was added or removed
 o paramString
public String paramString()
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
Overrides:
paramString in class ComponentEvent

All Packages  Class Hierarchy  This Package  Previous  Next  Index  

Submit a bug or feature