jdk/src/share/classes/java/awt/event/WindowFocusListener.java
author tbell
Wed, 07 Oct 2009 14:15:01 -0700
changeset 3965 63aae8ce7f47
parent 2 90ce3da70b43
child 5506 202f599c92aa
permissions -rw-r--r--
Merge
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
90ce3da70b43 Initial load
duke
parents:
diff changeset
     2
 * Copyright 2000-2006 Sun Microsystems, Inc.  All Rights Reserved.
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
90ce3da70b43 Initial load
duke
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Sun designates this
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
90ce3da70b43 Initial load
duke
parents:
diff changeset
     9
 * by Sun in the LICENSE file that accompanied this code.
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
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    21
 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    22
 * CA 95054 USA or visit www.sun.com if you need additional information or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    23
 * have any questions.
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 <code>WindowEvents</code>, including
90ce3da70b43 Initial load
duke
parents:
diff changeset
    32
 * <code>WINDOW_GAINED_FOCUS</code> and <code>WINDOW_LOST_FOCUS</code> events.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
 * The class that is interested in processing a <code>WindowEvent</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
 * either implements this interface (and
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
 * all the methods it contains) or extends the abstract
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
 * <code>WindowAdapter</code> class (overriding only the methods of interest).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
 * The listener object created from that class is then registered with a
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
 * <code>Window</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
 * using the <code>Window</code>'s <code>addWindowFocusListener</code> method.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
 * When the <code>Window</code>'s
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
 * status changes by virtue of it being opened, closed, activated, deactivated,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
 * iconified, or deiconified, or by focus being transfered into or out of the
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
 * <code>Window</code>, the relevant method in the listener object is invoked,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
 * and the <code>WindowEvent</code> is passed to it.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
 * @author David Mendenhall
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
 * @see WindowAdapter
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
 * @see WindowEvent
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
 * @see <a href="http://java.sun.com/docs/books/tutorial/post1.0/ui/windowlistener.html">Tutorial: Writing a Window Listener</a>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
 * @since 1.4
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
public interface WindowFocusListener extends EventListener {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
     * Invoked when the Window is set to be the focused Window, which means
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
     * that the Window, or one of its subcomponents, will receive keyboard
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
     * events.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
    public void windowGainedFocus(WindowEvent e);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    62
90ce3da70b43 Initial load
duke
parents:
diff changeset
    63
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    64
     * Invoked when the Window is no longer the focused Window, which means
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
     * that keyboard events will no longer be delivered to the Window or any of
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
     * its subcomponents.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    68
    public void windowLostFocus(WindowEvent e);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    69
}