/*
 * Copyright (c) 1996, 2014, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package java.awt.event;

import java.util.EventListener;

The listener interface for receiving keyboard events (keystrokes). The class that is interested in processing a keyboard event either implements this interface (and all the methods it contains) or extends the abstract KeyAdapter class (overriding only the methods of interest).

The listener object created from that class is then registered with a component using the component's addKeyListener method. A keyboard event is generated when a key is pressed, released, or typed. The relevant method in the listener object is then invoked, and the KeyEvent is passed to it.

Author:Carl Quinn
See Also:
Since:1.1
/** * The listener interface for receiving keyboard events (keystrokes). * The class that is interested in processing a keyboard event * either implements this interface (and all the methods it * contains) or extends the abstract {@code KeyAdapter} class * (overriding only the methods of interest). * <P> * The listener object created from that class is then registered with a * component using the component's {@code addKeyListener} * method. A keyboard event is generated when a key is pressed, released, * or typed. The relevant method in the listener * object is then invoked, and the {@code KeyEvent} is passed to it. * * @author Carl Quinn * * @see KeyAdapter * @see KeyEvent * @see <a href="https://docs.oracle.com/javase/tutorial/uiswing/events/keylistener.html">Tutorial: Writing a Key Listener</a> * * @since 1.1 */
public interface KeyListener extends EventListener {
Invoked when a key has been typed. See the class description for KeyEvent for a definition of a key typed event.
Params:
  • e – the event to be processed
/** * Invoked when a key has been typed. * See the class description for {@link KeyEvent} for a definition of * a key typed event. * @param e the event to be processed */
public void keyTyped(KeyEvent e);
Invoked when a key has been pressed. See the class description for KeyEvent for a definition of a key pressed event.
Params:
  • e – the event to be processed
/** * Invoked when a key has been pressed. * See the class description for {@link KeyEvent} for a definition of * a key pressed event. * @param e the event to be processed */
public void keyPressed(KeyEvent e);
Invoked when a key has been released. See the class description for KeyEvent for a definition of a key released event.
Params:
  • e – the event to be processed
/** * Invoked when a key has been released. * See the class description for {@link KeyEvent} for a definition of * a key released event. * @param e the event to be processed */
public void keyReleased(KeyEvent e); }