org.eclipse.swt.events.KeyListener Maven / Gradle / Ivy

/*******************************************************************************
 * Copyright (c) 2000, 2016 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *     Lars Vogel  - Bug 507185
 *******************************************************************************/
package org.eclipse.swt.events;


import java.util.function.*;

import org.eclipse.swt.internal.*;

/**
 * Classes which implement this interface provide methods
 * that deal with the events that are generated as keys
 * are pressed on the system keyboard.
 * 
 * After creating an instance of a class that implements
 * this interface it can be added to a control using the
 * addKeyListener method and removed using
 * the removeKeyListener method. When a
 * key is pressed or released, the appropriate method will
 * be invoked.
 * 
 *
 * @see KeyAdapter
 * @see KeyEvent
 */
public interface KeyListener extends SWTEventListener {

/**
 * Sent when a key is pressed on the system keyboard.
 *
 * @param e an event containing information about the key press
 */
public void keyPressed(KeyEvent e);

/**
 * Sent when a key is released on the system keyboard.
 *
 * @param e an event containing information about the key release
 */
public void keyReleased(KeyEvent e);

/**
 * Static helper method to create a KeyListener for the
 * {@link #keyPressed(KeyEvent e)}) method with a lambda expression.
 *
 * @param c the consumer of the event
 * @return KeyListener
 * @since 3.106
 */
public static KeyListener keyPressedAdapter(Consumer c) {
	return new KeyAdapter() {
		@Override
		public void keyPressed(KeyEvent e) {
			c.accept(e);
		}
	};
}

/**
 * Static helper method to create a KeyListener for the
 * {@link #keyReleased(KeyEvent e)}) method with a lambda expression.
 *
 * @param c the consumer of the event
 * @return KeyListener
 * @since 3.106
*/
public static KeyListener keyReleasedAdapter(Consumer c) {
	return new KeyAdapter() {
		@Override
		public void keyReleased(KeyEvent e) {
			c.accept(e);
		}
	};
}

}