Package com.vaadin.flow.component

Class ShortcutRegistration

java.lang.Object
com.vaadin.flow.component.ShortcutRegistration
All Implemented Interfaces:
Registration, Serializable
public class ShortcutRegistration extends Object implements Registration, Serializable
A registration object for both configuring and removing the registered keyboard shortcut.
Since:
1.3
Author:
Vaadin Ltd.
See Also:

  • Method Details

    • withModifiers

      public ShortcutRegistration withModifiers(KeyModifier... keyModifiers)
      Configures KeyModifiers for the shortcut. Calling this method will overwrite any previously set modifier keys. Hence, calling shortcutRegistration.withModifiers(); will remove all previously set modifier keys.
      Parameters:
      keyModifiers - Key modifiers. Can be empty.
      Returns:
      this ShortcutRegistration

    • withAlt

      public ShortcutRegistration withAlt()
      Fluently adds KeyModifier.ALT to the shortcut's modifiers.
      Returns:
      this ShortcutRegistration

    • withCtrl

      public ShortcutRegistration withCtrl()
      Fluently adds KeyModifier.CONTROL to the shortcut's modifiers.
      Returns:
      this ShortcutRegistration

    • withMeta

      public ShortcutRegistration withMeta()
      Fluently adds KeyModifier.META to the shortcut's modifiers.
      Returns:
      this ShortcutRegistration

    • withShift

      public ShortcutRegistration withShift()
      Fluently adds KeyModifier.SHIFT to the shortcut's modifiers.
      Returns:
      this ShortcutRegistration

    • allowBrowserDefault

      public ShortcutRegistration allowBrowserDefault()
      Allows the default keyboard event handling when the shortcut is invoked.
      Returns:
      this ShortcutRegistration
      See Also:

    • allowEventPropagation

      public ShortcutRegistration allowEventPropagation()
      Allow the event to propagate upwards in the DOM tree, when the shortcut is invoked.
      Returns:
      this ShortcutRegistration
      See Also:

    • allowEventsFromNestedModals

      public ShortcutRegistration allowEventsFromNestedModals()
      Allow the shortcut to trigger for keyboard events that originate from a modal or popover nested inside the shortcut's listening scope.

      By default the shortcut does not trigger for such events. This restores behavior where a shortcut bound to a parent overlay would react to a keydown coming from a nested dialog/overlay that has focus.

      Returns:
      this ShortcutRegistration
      See Also:

    • resetFocusOnActiveElement

      public ShortcutRegistration resetFocusOnActiveElement()
      Reset focus on active element before triggering shortcut event handler.
      Returns:
      this ShortcutRegistration
      Since:
      24.3
      See Also:

    • bindLifecycleTo

      public ShortcutRegistration bindLifecycleTo(Component component)
      Binds the shortcut's life cycle to that of the given Component. When the given component is attached, the shortcut's listener is attached to the Component that owns the shortcut. When the given component is detached, so is the listener. is detached, the shortcut is removed from all attached scopes.
      Parameters:
      component - New lifecycle owner of the shortcut
      Returns:
      this ShortcutRegistration

    • listenOn

      public ShortcutRegistration listenOn(Component... listenOnComponents)
      Fluently define the Component onto which the shortcut's listener is bound. Calling this method will remove the previous listener from the component it was bound to.
      Parameters:
      listenOnComponents - Components onto which the shortcut listeners are bound. Must not be null. Must not contain null. Must not have duplicate components.
      Returns:
      this ShortcutRegistration
      Since:
      2.2

    • remove

      public void remove()
      Removes the ShortcutRegistration

      Removes all the underlying registrations tied to owner and lifecycle owner components.

      Specified by:
      remove in interface Registration
      See Also:

    • isShortcutActive

      public boolean isShortcutActive()
      Is the shortcut active on the current UI. For this to be true, the lifecycle owner needs to be attached and visible and handler owner needs to be attached.
      Returns:
      Is the shortcut active

    • getKey

      public Key getKey()
      Get the primary Key of the shortcut. Primary key can be any key besides modifier keys.
      Returns:
      Primary key

    • getModifiers

      public Set<Key> getModifiers()
      Get a set of keys where each key is an instance of a KeyModifier.
      Returns:
      Set of modifier keys

    • isBrowserDefaultAllowed

      public boolean isBrowserDefaultAllowed()
      Checks if the default key behaviour in the browser is allowed by the shortcut. The default value is false.
      Returns:
      Allows default key behavior
      Since:
      1.4

    • setBrowserDefaultAllowed

      public void setBrowserDefaultAllowed(boolean browserDefaultAllowed)
      Set whether the default key behavior is allowed in the browser. The default value is false, and it prevents the default key events from taking place in the browser.
      Parameters:
      browserDefaultAllowed - Allow default behavior on keydown
      Since:
      1.4

    • isEventPropagationAllowed

      public boolean isEventPropagationAllowed()
      Checks if the shortcut allows keydown event (associated with the shortcut) propagation in the browser. The default value is false.
      Returns:
      Allows event propagation
      Since:
      1.4

    • setEventPropagationAllowed

      public void setEventPropagationAllowed(boolean eventPropagationAllowed)
      Set whether shortcut's keydown event is allowed to propagate up the DOM tree in the browser. The default value is false, and the DOM event is consumed by the shortcut handler.
      Parameters:
      eventPropagationAllowed - Allow event propagation
      Since:
      1.4

    • isEventsFromNestedModalsAllowed

      public boolean isEventsFromNestedModalsAllowed()
      Checks if the shortcut triggers for keyboard events originating from a modal or popover nested inside the shortcut's listening scope. The default value is false.
      Returns:
      true if events from nested modals are allowed to trigger the shortcut

    • setEventsFromNestedModalsAllowed

      public void setEventsFromNestedModalsAllowed(boolean eventsFromNestedModalsAllowed)
      Sets whether the shortcut triggers for keyboard events that originate from a modal or popover nested inside the shortcut's listening scope. The default value is false, meaning a keydown coming from a nested dialog/overlay does not trigger a shortcut bound to a parent scope.
      Parameters:
      eventsFromNestedModalsAllowed - true to allow events from nested modals to trigger the shortcut

    • isResetFocusOnActiveElement

      public boolean isResetFocusOnActiveElement()
      Checks if shortcut resets focus on active element before triggering shortcut event handler.
      Returns:
      True when focus is reset on the active element, false otherwise.
      Since:
      24.3

    • setResetFocusOnActiveElement

      public void setResetFocusOnActiveElement(boolean resetFocusOnActiveElement)
      Set if shortcut resets focus on active element before triggering shortcut event handler. Reset means to first blur() and then focus() the element. If element is an input field with a ValueChangeMode.ON_CHANGE, then resetting focus ensures that value change event is triggered before shortcut event is handled. Active element is document.activeElement or shadowRoot.activeElement if active element is the shadowRoot.
      Parameters:
      resetFocusOnActiveElement - Reset focus on active element
      Since:
      24.3

    • getOwners

      public Component[] getOwners()
      The Components which own the shortcuts key event listeners.
      Returns:
      Component[]
      Since:
      2.2

    • getLifecycleOwner

      public Component getLifecycleOwner()
      Component which controls when the shortcut is active and when it is not.
      Returns:
      Component
      See Also:

    • setDisabledUpdateMode

      public ShortcutRegistration setDisabledUpdateMode(DisabledUpdateMode disabledUpdateMode)
      Configure whether this listener will be called even in cases when the component is disabled. Defaults to DisabledUpdateMode.ONLY_WHEN_ENABLED.
      Parameters:
      disabledUpdateMode - DisabledUpdateMode.ONLY_WHEN_ENABLED to only fire events when the component is enabled, DisabledUpdateMode.ALWAYS to fire events also when the component is disabled.
      Returns:
      this registration, for chaining
      Since:
      24.7

    • getDisabledUpdateMode

      public DisabledUpdateMode getDisabledUpdateMode()
      Returns whether this listener will be called even in cases when the component is disabled.
      Returns:
      current disabledUpdateMode for this listener
      Since:
      24.7

    • toString

      public String toString()
      Overrides:
      toString in class Object