Issues/4893 Finalize shortcut api #4969
Conversation
ShortcutRegistration is a result of adding a shortcut and can be used to both configure and remove a shortcut. ShortcutActions is used to register custom shortcut actions.
ClickNotifier has a method for adding a "click shortcut" and Focusable has a method for adding a "focus shortcut".
Still lacking few features: - visibility check for components - Key designator which follows platform conventions (or an API for making shortcuts conform to platform conventions)
Added comments to ShortcutRegistration constructor
Covers: - click shortcut - focus shortcut - scoped shortcut - global shortcut - shortcut tied to visibility flopping component - shortcut tied to attach/detach flopping component
And renamed a method to better represent its functionality.
The method is an overload of the Registration addShortcut(...) variant and it allows for configuration of both owner and lifecycle owner. Also, in Shortcuts, where there was Component owner before, now is Component lifecycleOwner - when writing the IT tests, I noticed a distinct need to make configuring the lifecycle owner easier. I didn't care about owner over much.
There was a problem hiding this comment.
Reviewed 10 of 10 files at r1.
Reviewable status:complete! all discussions resolved, 1 of 1 LGTMs obtained
There was a problem hiding this comment.
Reviewed 1 of 1 files at r2.
Reviewable status:
| KeyModifier... keyModifiers) { | ||
| if (lifecycleOwner == null) { | ||
| throw new InvalidParameterException(String.format(NULL, | ||
| "lifecycleOwner")); |
There was a problem hiding this comment.
| * @author Vaadin Ltd. | ||
| * @since | ||
| */ | ||
| public final class Shortcuts { |
There was a problem hiding this comment.
| "lifecycleOwner")); | ||
| } | ||
| if (command == null) { | ||
| throw new InvalidParameterException(String.format(NULL, "command")); |
There was a problem hiding this comment.
| } | ||
|
|
||
| if (key == null) { | ||
| throw new InvalidParameterException( |
There was a problem hiding this comment.
| } | ||
|
|
||
| if (key == null) { | ||
| throw new InvalidParameterException( |
There was a problem hiding this comment.
| } | ||
|
|
||
| if (key == null) { | ||
| throw new InvalidParameterException( |
There was a problem hiding this comment.
| String.format(Shortcuts.NULL, key)); | ||
| } | ||
|
|
||
| final Component _this = (Component) this; |
There was a problem hiding this comment.
| } | ||
|
|
||
| if (key == null) { | ||
| throw new InvalidParameterException( |
There was a problem hiding this comment.
| executionRegistration.remove(); | ||
| } | ||
| // isLifecycleOwnerAttached checks for UI status | ||
| executionRegistration = lifecycleOwner.getUI().get() |
There was a problem hiding this comment.
| * together. | ||
| */ | ||
| private static class CompoundRegistration implements Registration { | ||
| Set<Registration> registrations; |
There was a problem hiding this comment.
|
|
||
| private static String generateEventKeyFilter(Key key) { | ||
| // will now allow shortcut to happen without primary key | ||
| if (key == null) return "false"; |
There was a problem hiding this comment.
|
|
||
| private void markClean() { | ||
| synchronized (this) { | ||
| if (!isDirty.get()) return; |
There was a problem hiding this comment.
| keydownRegistration); | ||
| } | ||
| } | ||
| else { |
There was a problem hiding this comment.
| private static String generateEventModifierFilter( | ||
| Collection<Key> modifiers) { | ||
|
|
||
| if (modifiers.size() == 0) return "true"; |
There was a problem hiding this comment.
| assert lifecycleOwner != null; | ||
|
|
||
| synchronized (this) { | ||
| if (isDirty.get()) return; |
There was a problem hiding this comment.
| return this; | ||
| } | ||
|
|
||
| /** |
There was a problem hiding this comment.
| } | ||
|
|
||
| private final SerializableConsumer<ExecutionContext> | ||
| beforeClientResponseConsumer = executionContext -> { |
There was a problem hiding this comment.
| prepareForClientResponse(); | ||
| } | ||
| } | ||
| else { |
There was a problem hiding this comment.
There was a problem hiding this comment.
Reviewable status: 18 unresolved discussions, 1 of 1 LGTMs obtained (waiting on @vaadin-bot)
There was a problem hiding this comment.
Dismissed @vaadin-bot from 18 discussions.
Reviewable status:
* Adds isModifier(Key) to Key interface * Brings over DX tested ShortcutRegistration and ShortcutActions ShortcutRegistration is a result of adding a shortcut and can be used to both configure and remove a shortcut. ShortcutActions is used to register custom shortcut actions. * Adds shortcut support to ClickNotifier and Focusable interfaces ClickNotifier has a method for adding a "click shortcut" and Focusable has a method for adding a "focus shortcut". * Newest API changes for Shortcuts based on the DX testing. Still lacking few features: - visibility check for components - Key designator which follows platform conventions (or an API for making shortcuts conform to platform conventions) * Shortcuts UI test basefile (old demo file) * Added AltGr to KeyModifiers for completeness (also, Key.ALT != Key.ALT_GRAPH) * Removed char-based APIs from Shortcuts. Added comments to ShortcutRegistration constructor * Small unit tests for shortcut registration and due fixes. * Visibility handling, cleaning, and more unit tests * Updated JavaDocs for ShortcutRegistration * Basic IT tests for Shortcuts Covers: - click shortcut - focus shortcut - scoped shortcut - global shortcut - shortcut tied to visibility flopping component - shortcut tied to attach/detach flopping component * Cleaned some duplicate code from ShortcutRegistration. And renamed a method to better represent its functionality. * Added JavaDocs to Shortcuts.java and an extra method. The method is an overload of the Registration addShortcut(...) variant and it allows for configuration of both owner and lifecycle owner. Also, in Shortcuts, where there was Component owner before, now is Component lifecycleOwner - when writing the IT tests, I noticed a distinct need to make configuring the lifecycle owner easier. I didn't care about owner over much. * Added JavaDocs to UI's shortcut methods * Added JavaDocs for Focusable's shortcut methods * JavaDoc for ClickNotifier's shortcut methods * Fixed IT test since the Shortcuts API had changed a little * Added Shortcuts.java exclusion pattern for serialization test
Adds support for Keyboard Shortcuts to Flow.
Shortcut entry points:
UIfor global shortcutsFocusablefor focus shortcutsClickNotifierfor click shortcutsShortcutsfor registering a more customizable shortcutThere are two method variants for adding shortcuts:
Registration add...(...)andShortcutRegistration register...(...). add-methods perform the most basic of registrations and minimal configurability while register-methods returnShortcutRegistrationwhich provides a fluent configuration API for the shortcut.ShortcutRegistrationprovides methods for fluently configuringKeys,KeyModifiers, lifecycleOwner, and client-side event behavior (preventDefault, stopPropagation). The shortcuts recognize two semantics forComponents: owner and lifecycleOwner.Owner is the
componentto which the shortcut's event listener is tied to. In most cases, this will be an instance ofUI, making the shortcut operate in the global scope. If anothercomponentis assigned as the owner, the shortcut will only be triggered, if some child html element of thecomponentis focused during the key event.LifecycleOwner is a component which controls, when the shortcut is active. If the lifecycleOwner is detached or invisible, the shortcut won't get triggered (in case of the invisibility, the check is on the server-side, so the shortcut will in fact get triggered but not executed).
This change is