java.awt.event.ContainerListener Maven / Gradle / Ivy

/*


NOTICE





(c) 2005-2007 Sun Microsystems, Inc. All Rights Reserved.

Neither this file nor any files generated from it describe a complete
specification, and they may only be used as described below. For
example, no permission is given for you to incorporate this file, in
whole or in part, in an implementation of a Java specification.

Sun Microsystems Inc. owns the copyright in this file and it is provided
to you for informative, as opposed to normative, use. The file and any
files generated from it may be used to generate other informative
documentation, such as a unified set of documents of API signatures for
a platform that includes technologies expressed as Java APIs. The file
may also be used to produce "compilation stubs," which allow
applications to be compiled and validated for such platforms.

Any work generated from this file, such as unified javadocs or compiled
stub files, must be accompanied by this notice in its entirety.

This work corresponds to the API signatures of JSR 217: Personal Basis
Profile 1.1. In the event of a discrepency between this work and the
JSR 217 specification, which is available at
http://www.jcp.org/en/jsr/detail?id=217, the latter takes precedence.
*/


  


package java.awt.event;

import java.util.EventListener;

/** 
 * The listener interface for receiving container events.
 * The class that is interested in processing a container event
 * either implements this interface (and all the methods it
 * contains) or extends the abstract ContainerAdapter class
 * (overriding only the methods of interest).
 * The listener object created from that class is then registered with a
 * component using the component's addContainerListener 
 * method. When the container's contents change because a component
 * has been added or removed, the relevant method in the listener object 
 * is invoked, and the ContainerEvent is passed to it.
 * 
 * Container events are provided for notification purposes ONLY;
 * The AWT will automatically handle add and remove operations
 * internally so the program works properly regardless of
 * whether the program registers a ComponentListener or not.
 *
 * @see ContainerAdapter
 * @see ContainerEvent
 * @see Tutorial: Writing a Container Listener
 * @see Reference: The Java Class Libraries (update file)
 *
 * @author Tim Prinzing
 * @author Amy Fowler
 * @version 1.10 01/23/03
 * @since 1.1
 */
public interface ContainerListener extends EventListener
{

    /** 
     * Invoked when a component has been added to the container.
     */
    public void componentAdded(ContainerEvent e);

    /** 
     * Invoked when a component has been removed from the container.
     */
    public void componentRemoved(ContainerEvent e);
}