View Javadoc
1   /*
2    * Copyright (c) 1996, 2006, Oracle and/or its affiliates. All rights reserved.
3    * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4    *
5    * This code is free software; you can redistribute it and/or modify it
6    * under the terms of the GNU General Public License version 2 only, as
7    * published by the Free Software Foundation.  Oracle designates this
8    * particular file as subject to the "Classpath" exception as provided
9    * by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22   * or visit www.oracle.com if you need additional information or have any
23   * 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   *
45   * @see KeyAdapter
46   * @see KeyEvent
47   * @see <a href="http://java.sun.com/docs/books/tutorial/post1.0/ui/keylistener.html">Tutorial: Writing a Key Listener</a>
48   *
49   * @since 1.1
50   */
51  public interface KeyListener extends EventListener {
52  
53      /**
54       * Invoked when a key has been typed.
55       * See the class description for {@link KeyEvent} for a definition of
56       * a key typed event.
57       */
58      public void keyTyped(KeyEvent e);
59  
60      /**
61       * Invoked when a key has been pressed.
62       * See the class description for {@link KeyEvent} for a definition of
63       * a key pressed event.
64       */
65      public void keyPressed(KeyEvent e);
66  
67      /**
68       * Invoked when a key has been released.
69       * See the class description for {@link KeyEvent} for a definition of
70       * a key released event.
71       */
72      public void keyReleased(KeyEvent e);
73  }