001 /*
002 * Copyright 1996-2003 Sun Microsystems, Inc. All Rights Reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation. Sun designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Sun in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022 * CA 95054 USA or visit www.sun.com if you need additional information or
023 * have any questions.
024 */
025
026 package java.awt.event;
027
028 import java.util.EventListener;
029
030 /**
031 * The listener interface for receiving window events.
032 * The class that is interested in processing a window event
033 * either implements this interface (and all the methods it
034 * contains) or extends the abstract <code>WindowAdapter</code> class
035 * (overriding only the methods of interest).
036 * The listener object created from that class is then registered with a
037 * Window using the window's <code>addWindowListener</code>
038 * method. When the window's status changes by virtue of being opened,
039 * closed, activated or deactivated, iconified or deiconified,
040 * the relevant method in the listener object is invoked, and the
041 * <code>WindowEvent</code> is passed to it.
042 *
043 * @author Carl Quinn
044 * @version 1.28, 05/05/07
045 *
046 * @see WindowAdapter
047 * @see WindowEvent
048 * @see <a href="http://java.sun.com/docs/books/tutorial/uiswing/events/windowlistener.html">Tutorial: How to Write Window Listeners</a>
049 *
050 * @since 1.1
051 */
052 public interface WindowListener extends EventListener {
053 /**
054 * Invoked the first time a window is made visible.
055 */
056 public void windowOpened(WindowEvent e);
057
058 /**
059 * Invoked when the user attempts to close the window
060 * from the window's system menu.
061 */
062 public void windowClosing(WindowEvent e);
063
064 /**
065 * Invoked when a window has been closed as the result
066 * of calling dispose on the window.
067 */
068 public void windowClosed(WindowEvent e);
069
070 /**
071 * Invoked when a window is changed from a normal to a
072 * minimized state. For many platforms, a minimized window
073 * is displayed as the icon specified in the window's
074 * iconImage property.
075 * @see java.awt.Frame#setIconImage
076 */
077 public void windowIconified(WindowEvent e);
078
079 /**
080 * Invoked when a window is changed from a minimized
081 * to a normal state.
082 */
083 public void windowDeiconified(WindowEvent e);
084
085 /**
086 * Invoked when the Window is set to be the active Window. Only a Frame or
087 * a Dialog can be the active Window. The native windowing system may
088 * denote the active Window or its children with special decorations, such
089 * as a highlighted title bar. The active Window is always either the
090 * focused Window, or the first Frame or Dialog that is an owner of the
091 * focused Window.
092 */
093 public void windowActivated(WindowEvent e);
094
095 /**
096 * Invoked when a Window is no longer the active Window. Only a Frame or a
097 * Dialog can be the active Window. The native windowing system may denote
098 * the active Window or its children with special decorations, such as a
099 * highlighted title bar. The active Window is always either the focused
100 * Window, or the first Frame or Dialog that is an owner of the focused
101 * Window.
102 */
103 public void windowDeactivated(WindowEvent e);
104 }
|