Package com.vaadin.flow.component

Class KeyDownEvent

java.lang.Object

java.util.EventObject

com.vaadin.flow.component.ComponentEvent<Component>

com.vaadin.flow.component.internal.KeyboardEvent

com.vaadin.flow.component.KeyDownEvent

All Implemented Interfaces:

Serializable

@DomEvent("keydown")
public class KeyDownEvent
extends KeyboardEvent

The event when a key is pressed.

Since:

1.0

Author:

Vaadin Ltd

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor	Description
KeyDownEvent(Component source, boolean fromClient, String key, String code, int location, boolean ctrlKey, boolean shiftKey, boolean altKey, boolean metaKey, boolean repeat, boolean composing)	Creates a new keyboard event.
KeyDownEvent(Component source, String key)	Creates a new server-side keyboard event with no additional information.
KeyDownEvent(Component source, String key, String code)	Creates a new server-side keyboard event with no additional information.

Method Summary

Methods inherited from class com.vaadin.flow.component.internal.KeyboardEvent

getCode, getKey, getLocation, getModifiers, isComposing, isRepeat

Methods inherited from class com.vaadin.flow.component.ComponentEvent

getSource, isFromClient, unregisterListener

Methods inherited from class java.util.EventObject

toString

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyDownEvent

public KeyDownEvent(Component source,
                    boolean fromClient,
                    @EventData("event.key")
                    String key,
                    @EventData("event.code")
                    String code,
                    @EventData("event.location")
                    int location,
                    @EventData("event.ctrlKey")
                    boolean ctrlKey,
                    @EventData("event.shiftKey")
                    boolean shiftKey,
                    @EventData("event.altKey")
                    boolean altKey,
                    @EventData("event.metaKey")
                    boolean metaKey,
                    @EventData("event.repeat")
                    boolean repeat,
                    @EventData("event.isComposing")
                    boolean composing)

Creates a new keyboard event.

Parameters:

source - the component that fired the event

fromClient - true if the event was originally fired on the client, false if the event originates from server-side logic

key - the string value representing the key

code - the string value representing the code

location - the integer value representing the location of the key

ctrlKey - true if the control key was down when the event was fired, false otherwise

shiftKey - true if the shift key was down when the event was fired, false otherwise

altKey - true if the alt key was down when the event was fired, false otherwise

metaKey - true if the meta key was down when the event was fired, false otherwise

repeat - true if the key has been pressed in a sustained manner

composing - true if the key event occurred as part of a composition session

KeyDownEvent

public KeyDownEvent(Component source,
                    String key)

Creates a new server-side keyboard event with no additional information.

Parameters:

source - the component that fired the event

key - the key for this event

KeyDownEvent

public KeyDownEvent(Component source,
                    String key,
                    String code)

Creates a new server-side keyboard event with no additional information.

Parameters:

source - the component that fired the event

key - the key for this event

code - the code for this event