com.vaadin.flow.component.
Class KeyPressEvent
- java.lang.Object
-
- java.util.EventObject
-
- com.vaadin.flow.component.ComponentEvent<Component>
-
- com.vaadin.flow.component.internal.KeyboardEvent
-
- com.vaadin.flow.component.KeyPressEvent
-
All Implemented Interfaces:
@DomEvent(value="keypress") public class KeyPressEvent extends KeyboardEvent
The event when a key is pressed.
Since:
1.0
Author:
Vaadin Ltd
See Also:
-
-
Field Summary
-
Fields inherited from class java.util.EventObject
source
-
-
Constructor Summary
Constructors Constructor and Description KeyPressEvent(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.
KeyPressEvent(Component source, String key)
Creates a new server-side keyboard event with no additional information.
KeyPressEvent(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
-
-
-
-
Constructor Detail
-
KeyPressEvent
public KeyPressEvent(Component source, boolean fromClient, @EventData(value="event.key") String key, @EventData(value="event.code") String code, @EventData(value="event.location") int location, @EventData(value="event.ctrlKey") boolean ctrlKey, @EventData(value="event.shiftKey") boolean shiftKey, @EventData(value="event.altKey") boolean altKey, @EventData(value="event.metaKey") boolean metaKey, @EventData(value="event.repeat") boolean repeat, @EventData(value="event.isComposing") boolean composing)
Creates a new keyboard event.
Parameters:
source
- the component that fired the eventfromClient
-true
if the event was originally fired on the client,false
if the event originates from server-side logickey
- the string value representing the keycode
- the string value representing the codelocation
- the integer value representing the location of the keyctrlKey
-true
if the control key was down when the event was fired,false
otherwiseshiftKey
-true
if the shift key was down when the event was fired,false
otherwisealtKey
-true
if the alt key was down when the event was fired,false
otherwisemetaKey
-true
if the meta key was down when the event was fired,false
otherwiserepeat
-true
if the key has been pressed in a sustained mannercomposing
-true
if the key event occurred as part of a composition session
-
KeyPressEvent
public KeyPressEvent(Component source, String key)
Creates a new server-side keyboard event with no additional information.
Parameters:
source
- the component that fired the eventkey
- the key for this event
-
-