jdk/src/share/classes/java/awt/event/AWTEventListener.java
author darcy
Thu, 09 Jan 2014 14:15:01 -0800
changeset 22254 8550495a4d78
parent 5506 202f599c92aa
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: 5506
diff changeset
     2
 * Copyright (c) 1998, 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
import java.awt.AWTEvent;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
/**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    32
 * The listener interface for receiving notification of events
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
 * dispatched to objects that are instances of Component or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
 * MenuComponent or their subclasses.  Unlike the other EventListeners
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
 * in this package, AWTEventListeners passively observe events
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
 * being dispatched in the AWT, system-wide.  Most applications
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
 * should never use this class; applications which might use
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
 * AWTEventListeners include event recorders for automated testing,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
 * and facilities such as the Java Accessibility package.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
 * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
 * The class that is interested in monitoring AWT events
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
 * implements this interface, and the object created with that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
 * class is registered with the Toolkit, using the Toolkit's
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
 * <code>addAWTEventListener</code> method.  When an event is
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
 * dispatched anywhere in the AWT, that object's
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
 * <code>eventDispatched</code> method is invoked.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
 * @see java.awt.AWTEvent
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
 * @see java.awt.Toolkit#addAWTEventListener
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
 * @see java.awt.Toolkit#removeAWTEventListener
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
 * @author Fred Ecks
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
 * @since 1.2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
public interface AWTEventListener extends EventListener {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
     * Invoked when an event is dispatched in the AWT.
22254
8550495a4d78 8030845: Fix doclint missing issues in java.awt.event
darcy
parents: 5506
diff changeset
    59
     * @param event the event to be processed
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
    public void eventDispatched(AWTEvent event);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    62
90ce3da70b43 Initial load
duke
parents:
diff changeset
    63
}