01 /*
02 * Copyright 1996-2006 Sun Microsystems, Inc. All Rights Reserved.
03 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
04 *
05 * This code is free software; you can redistribute it and/or modify it
06 * under the terms of the GNU General Public License version 2 only, as
07 * published by the Free Software Foundation. Sun designates this
08 * particular file as subject to the "Classpath" exception as provided
09 * by Sun in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any questions.
24 */
25
26 package java.awt.event;
27
28 import java.util.EventListener;
29
30 /**
31 * The listener interface for receiving keyboard events (keystrokes).
32 * The class that is interested in processing a keyboard event
33 * either implements this interface (and all the methods it
34 * contains) or extends the abstract <code>KeyAdapter</code> class
35 * (overriding only the methods of interest).
36 * <P>
37 * The listener object created from that class is then registered with a
38 * component using the component's <code>addKeyListener</code>
39 * method. A keyboard event is generated when a key is pressed, released,
40 * or typed. The relevant method in the listener
41 * object is then invoked, and the <code>KeyEvent</code> is passed to it.
42 *
43 * @author Carl Quinn
44 * @version 1.26 05/05/07
45 *
46 * @see KeyAdapter
47 * @see KeyEvent
48 * @see <a href="http://java.sun.com/docs/books/tutorial/post1.0/ui/keylistener.html">Tutorial: Writing a Key Listener</a>
49 *
50 * @since 1.1
51 */
52 public interface KeyListener extends EventListener {
53
54 /**
55 * Invoked when a key has been typed.
56 * See the class description for {@link KeyEvent} for a definition of
57 * a key typed event.
58 */
59 public void keyTyped(KeyEvent e);
60
61 /**
62 * Invoked when a key has been pressed.
63 * See the class description for {@link KeyEvent} for a definition of
64 * a key pressed event.
65 */
66 public void keyPressed(KeyEvent e);
67
68 /**
69 * Invoked when a key has been released.
70 * See the class description for {@link KeyEvent} for a definition of
71 * a key released event.
72 */
73 public void keyReleased(KeyEvent e);
74 }
|