Package com.vaadin.flow.component

Class KeyEventListener<E extends KeyboardEvent>

java.lang.Object

com.vaadin.flow.component.KeyEventListener<E>

Type Parameters:

E - the type of the KeyboardEvent

All Implemented Interfaces:

ComponentEventListener<E>, Serializable, EventListener

public class KeyEventListener<E extends KeyboardEvent>
extends Object
implements ComponentEventListener<E>

A conditional event listener for KeyboardEvents.

Since:

1.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
KeyEventListener(ComponentEventListener<E> listener, Key key, KeyModifier... modifiers)	Create a listener which will delegate to listener only if key is the target key.

Method Summary

Modifier and Type	Method	Description
void	onComponentEvent(E event)	Invoked when a component event has been fired.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KeyEventListener

public KeyEventListener(ComponentEventListener<E> listener,
                        Key key,
                        KeyModifier... modifiers)

Create a listener which will delegate to listener only if key is the target key. If any modifiers is required, the delegation occurs only if all the modifiers keys where pressed.

Parameters:

listener - the listener to delegate

key - the key to check

modifiers - the optional modifier keys

Method Detail

onComponentEvent

public void onComponentEvent(E event)

Description copied from interface: ComponentEventListener

Invoked when a component event has been fired.

Specified by:

onComponentEvent in interface ComponentEventListener<E extends KeyboardEvent>

Parameters:

event - component event