jdk/src/share/classes/java/awt/event/WindowListener.java
author darcy
Thu, 09 Jan 2014 14:15:01 -0800
changeset 22254 8550495a4d78
parent 20455 f6f9a0c2796b
permissions -rw-r--r--
8030845: Fix doclint missing issues in java.awt.event Reviewed-by: prr, anthony
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
22254
8550495a4d78 8030845: Fix doclint missing issues in java.awt.event
darcy
parents: 20455
diff changeset
     2
 * Copyright (c) 1996, 2013, Oracle and/or its affiliates. All rights reserved.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     4
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
90ce3da70b43 Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    10
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
90ce3da70b43 Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
90ce3da70b43 Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    16
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
90ce3da70b43 Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    20
 *
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    23
 * questions.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    24
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    25
90ce3da70b43 Initial load
duke
parents:
diff changeset
    26
package java.awt.event;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
import java.util.EventListener;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    29
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
/**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
 * The listener interface for receiving window events.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    32
 * The class that is interested in processing a window event
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
 * either implements this interface (and all the methods it
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
 * contains) or extends the abstract <code>WindowAdapter</code> class
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
 * (overriding only the methods of interest).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
 * The listener object created from that class is then registered with a
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
 * Window using the window's <code>addWindowListener</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
 * method. When the window's status changes by virtue of being opened,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
 * closed, activated or deactivated, iconified or deiconified,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
 * the relevant method in the listener object is invoked, and the
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
 * <code>WindowEvent</code> is passed to it.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
 * @author Carl Quinn
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
 * @see WindowAdapter
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
 * @see WindowEvent
20455
f6f9a0c2796b 8020688: Broken links in documentation at http://docs.oracle.com/javase/6/docs/api/index.
mcherkas
parents: 5506
diff changeset
    47
 * @see <a href="http://docs.oracle.com/javase/tutorial/uiswing/events/windowlistener.html">Tutorial: How to Write Window Listeners</a>
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
 * @since 1.1
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
public interface WindowListener extends EventListener {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
     * Invoked the first time a window is made visible.
22254
8550495a4d78 8030845: Fix doclint missing issues in java.awt.event
darcy
parents: 20455
diff changeset
    54
     * @param e the event to be processed
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
    public void windowOpened(WindowEvent e);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
     * Invoked when the user attempts to close the window
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
     * from the window's system menu.
22254
8550495a4d78 8030845: Fix doclint missing issues in java.awt.event
darcy
parents: 20455
diff changeset
    61
     * @param e the event to be processed
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    62
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    63
    public void windowClosing(WindowEvent e);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    64
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
     * Invoked when a window has been closed as the result
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
     * of calling dispose on the window.
22254
8550495a4d78 8030845: Fix doclint missing issues in java.awt.event
darcy
parents: 20455
diff changeset
    68
     * @param e the event to be processed
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    69
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    70
    public void windowClosed(WindowEvent e);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    71
90ce3da70b43 Initial load
duke
parents:
diff changeset
    72
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    73
     * Invoked when a window is changed from a normal to a
90ce3da70b43 Initial load
duke
parents:
diff changeset
    74
     * minimized state. For many platforms, a minimized window
90ce3da70b43 Initial load
duke
parents:
diff changeset
    75
     * is displayed as the icon specified in the window's
90ce3da70b43 Initial load
duke
parents:
diff changeset
    76
     * iconImage property.
22254
8550495a4d78 8030845: Fix doclint missing issues in java.awt.event
darcy
parents: 20455
diff changeset
    77
     * @param e the event to be processed
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    78
     * @see java.awt.Frame#setIconImage
90ce3da70b43 Initial load
duke
parents:
diff changeset
    79
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    80
    public void windowIconified(WindowEvent e);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    81
90ce3da70b43 Initial load
duke
parents:
diff changeset
    82
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    83
     * Invoked when a window is changed from a minimized
90ce3da70b43 Initial load
duke
parents:
diff changeset
    84
     * to a normal state.
22254
8550495a4d78 8030845: Fix doclint missing issues in java.awt.event
darcy
parents: 20455
diff changeset
    85
     * @param e the event to be processed
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    86
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    87
    public void windowDeiconified(WindowEvent e);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    88
90ce3da70b43 Initial load
duke
parents:
diff changeset
    89
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    90
     * Invoked when the Window is set to be the active Window. Only a Frame or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    91
     * a Dialog can be the active Window. The native windowing system may
90ce3da70b43 Initial load
duke
parents:
diff changeset
    92
     * denote the active Window or its children with special decorations, such
90ce3da70b43 Initial load
duke
parents:
diff changeset
    93
     * as a highlighted title bar. The active Window is always either the
90ce3da70b43 Initial load
duke
parents:
diff changeset
    94
     * focused Window, or the first Frame or Dialog that is an owner of the
90ce3da70b43 Initial load
duke
parents:
diff changeset
    95
     * focused Window.
22254
8550495a4d78 8030845: Fix doclint missing issues in java.awt.event
darcy
parents: 20455
diff changeset
    96
     * @param e the event to be processed
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    97
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    98
    public void windowActivated(WindowEvent e);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    99
90ce3da70b43 Initial load
duke
parents:
diff changeset
   100
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   101
     * Invoked when a Window is no longer the active Window. Only a Frame or a
90ce3da70b43 Initial load
duke
parents:
diff changeset
   102
     * Dialog can be the active Window. The native windowing system may denote
90ce3da70b43 Initial load
duke
parents:
diff changeset
   103
     * the active Window or its children with special decorations, such as a
90ce3da70b43 Initial load
duke
parents:
diff changeset
   104
     * highlighted title bar. The active Window is always either the focused
90ce3da70b43 Initial load
duke
parents:
diff changeset
   105
     * Window, or the first Frame or Dialog that is an owner of the focused
90ce3da70b43 Initial load
duke
parents:
diff changeset
   106
     * Window.
22254
8550495a4d78 8030845: Fix doclint missing issues in java.awt.event
darcy
parents: 20455
diff changeset
   107
     * @param e the event to be processed
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   108
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   109
    public void windowDeactivated(WindowEvent e);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   110
}