blob: d5c444ff184b0042ec35d8d044cf56985c5c4dd7 [file] [log] [blame]
/*
* Copyright (c) 1996, 2006, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
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 <code>ContainerAdapter</code> class
* (overriding only the methods of interest).
* The listener object created from that class is then registered with a
* component using the component's <code>addContainerListener</code>
* 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 <code>ContainerEvent</code> is passed to it.
* <P>
* 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 <code>ComponentListener</code> or not.
*
* @see ContainerAdapter
* @see ContainerEvent
* @see <a href="http://java.sun.com/docs/books/tutorial/post1.0/ui/containerlistener.html">Tutorial: Writing a Container Listener</a>
*
* @author Tim Prinzing
* @author Amy Fowler
* @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);
}