jdk/src/share/classes/java/awt/event/KeyListener.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) 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 keyboard events (keystrokes).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    32
 * The class that is interested in processing a keyboard 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>KeyAdapter</code> class
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
 * (overriding only the methods of interest).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
 * <P>
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
 * component using the component's <code>addKeyListener</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
 * method. A keyboard event is generated when a key is pressed, released,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
 * or typed. The relevant method in the listener
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
 * object is then invoked, and the <code>KeyEvent</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 KeyAdapter
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
 * @see KeyEvent
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
 * @see <a href="http://java.sun.com/docs/books/tutorial/post1.0/ui/keylistener.html">Tutorial: Writing a Key Listener</a>
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 KeyListener extends EventListener {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
     * Invoked when a key has been typed.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
     * See the class description for {@link KeyEvent} for a definition of
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
     * a key typed event.
22254
8550495a4d78 8030845: Fix doclint missing issues in java.awt.event
darcy
parents: 5506
diff changeset
    57
     * @param e the event to be processed
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
    public void keyTyped(KeyEvent e);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    62
     * Invoked when a key has been pressed.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    63
     * See the class description for {@link KeyEvent} for a definition of
90ce3da70b43 Initial load
duke
parents:
diff changeset
    64
     * a key pressed event.
22254
8550495a4d78 8030845: Fix doclint missing issues in java.awt.event
darcy
parents: 5506
diff changeset
    65
     * @param e the event to be processed
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
    public void keyPressed(KeyEvent e);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    68
90ce3da70b43 Initial load
duke
parents:
diff changeset
    69
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    70
     * Invoked when a key has been released.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    71
     * See the class description for {@link KeyEvent} for a definition of
90ce3da70b43 Initial load
duke
parents:
diff changeset
    72
     * a key released event.
22254
8550495a4d78 8030845: Fix doclint missing issues in java.awt.event
darcy
parents: 5506
diff changeset
    73
     * @param e the event to be processed
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    74
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    75
    public void keyReleased(KeyEvent e);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    76
}