com.vaadin.flow.component.

Class Shortcuts


  • public final class Shortcuts
extends Object

    Since:

    Author:

    Vaadin Ltd.

    • Method Detail

      • addShortcutListener

        public static ShortcutRegistration addShortcutListener(Component lifecycleOwner,
                                                       Command command,
                                                       Key key,
                                                       KeyModifier... keyModifiers)

        Invoke a Command when the shortcut is invoked.

        Registering a shortcut using this method will tie it to lifecycleOwner and the shortcut is available in the global scope.

        By default, the shortcut's listener is bound to UI. The listening component can be changed by calling ShortcutRegistration.listenOn(Component).

        Parameters:

        lifecycleOwner - the component that controls, when the shortcut is active. If the component is either invisible or detached, the shortcut won't work. Cannot be null

        command - code to execute when the shortcut is invoked. Cannot be null

        key - primary Key used to trigger the shortcut. Cannot be null

        keyModifiers - KeyModifiers which also need to be pressed for the shortcut to trigger

        Returns:

        ShortcutRegistration for configuring and removing the shortcut

      • addShortcutListener

        public ShortcutRegistration addShortcutListener(Component lifecycleOwner,
                                                ShortcutEventListener listener,
                                                Key key,
                                                KeyModifier... keyModifiers)

        Invoke a ShortcutEventListener when the shortcut is invoked.

        Registering a shortcut using this method will tie it to lifecycleOwner and the shortcut is available in the global scope.

        By default, the shortcut's listener is bound to UI. The listening component can be changed by calling ShortcutRegistration.listenOn(Component).

        Parameters:

        lifecycleOwner - the component that controls, when the shortcut is active. If the component is either invisible or detached, the shortcut won't work. Cannot be null

        listener - listener to execute when the shortcut is invoked. Receives a ShortcutEvent. Cannot be null

        key - primary Key used to trigger the shortcut. Cannot be null

        keyModifiers - KeyModifiers which also need to be pressed for the shortcut to trigger

        Returns:

        ShortcutRegistration for configuring and removing the shortcut