Method Details

• 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 static 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

• setShortcutListenOnElement

  public static Registration setShortcutListenOnElement(String elementLocatorJs, Component listenOnComponent)

  Setup an element, that is only accessible on the browser (not server side), to listen for shortcut events on and delegate to the given component. The element will be located in the browser by executing the given JS statement. This needs to be set for each listen-on component instance.

  This should be only used by component developers, when their component is used as the listenOn component for shortcuts, and their component does some magic on the browser which means that the shortcut events are not coming through from the actual element. Thus when an application developer calls e.g.
  myButton.addClickShortcut(Key.ENTER).listenOn(dialog);
  the framework will automatically make sure the events are passed from the browser only element to the listenOn component (dialog in this case).

  Parameters:

  elementLocatorJs - js execution string that references the desired element in DOM or null to any remove existing locator

  listenOnComponent - the component that is setup for listening shortcuts on ShortcutRegistration.listenOn(Component...)

  Returns:

  a registration for removing the locator, does not affect active shortcuts or if the locator has changed from what was set for this registration

  Since: