Add missing FocusShortcutListener (#11289)

* Add missing FocusShortcutListener

Was removed from 8.0 and not readded.

Fixes #8297

* Update Release note for this change

all/src/main/templates/release-notes.html

@@ -83,10 +83,7 @@
             enhancements. Below is a list of the most notable changes:</p>
 
         <ul>
-            <li>Improvements in <tt>MenuBar</tt> client-side customization.</tt></li>
-            <li>Support for improved version of <tt>ContextMenu</tt> add-on (version 3.0.0.beta1).</li>
-            <li>Rewrite <tt>OSGi</tt> bundles activation mechanism to follow <tt>OSGi</tt> best practices</li>
-            <li>Change the return type of <tt>Grid.asMultiSelect</tt> and <tt>Grid.asSingleSelect</tt> that has API to access the features of corresponding selection model</li>
+            <li>Add support for <tt>FocusShortcutListener</tt></li>
             <li>Performance improvements for the Vaadin 7 compatibility Grid, picked from the Vaadin 7 branch.</li>
             <li>Fixes to Vaadin 7 compatibility Grid issues #10343 and #10998, picked from the Vaadin 7 branch.</li>
         </ul>
@@ -94,9 +91,9 @@
         </p>
 
         <p>
-            For enhancements introduced in Vaadin Framework 8.5, see the <a
-                href="http://vaadin.com/download/release/8.5/8.5.0/release-notes.html">Release
-                Notes for Vaadin Framework 8.5.0</a>.
+            For enhancements introduced in Vaadin Framework 8.6, see the <a
+                href="http://vaadin.com/download/release/8.6/8.6.0/release-notes.html">Release
+                Notes for Vaadin Framework 8.6.0</a>.
             For migrating from previous framework versions, see <a href="#incompatible">the list of incompatible changes</a> and <a href="#migrating">how to migrate
             to Vaadin Framework 8</a>.
         </p>
@@ -107,7 +104,7 @@
             <li><tt>VaadinIcons.SEARCH_MINUS</tt> and <tt>VaadinIcons.SEARCH_PLUS</tt> codes were changed due typo fix</li>
         </ul>
 
-        <h2>For incompatible or behavior-altering changes in 8.5, please see <a href="https://vaadin.com/download/release/8.5/8.5.0/release-notes.html#incompatible">8.5 release notes</a></h2>
+        <h2>For incompatible or behavior-altering changes in 8.6, please see <a href="https://vaadin.com/download/release/8.6/8.6.0/release-notes.html#incompatible">8.6 release notes</a></h2>
 
         <h3 id="knownissues">Known Issues and Limitations</h3>
         <ul>

compatibility-server/src/main/java/com/vaadin/v7/ui/AbstractField.java

@@ -1551,7 +1551,8 @@ public abstract class AbstractField<T> extends AbstractLegacyComponent
      * A ready-made {@link ShortcutListener} that focuses the given
      * {@link Focusable} (usually a {@link Field}) when the keyboard shortcut is
      * invoked.
-     *
+     * 
+     * @deprecated Replaced in 8.0 with {@link com.vaadin.event.FocusShortcut}
      */
     @Deprecated
     public static class FocusShortcut extends ShortcutListener {

documentation/advanced/advanced-shortcuts.asciidoc

@@ -50,11 +50,10 @@ image::img/shortcut-defaultbutton.png[]
 [[advanced.shortcuts.focus]]
 == Field Focus Shortcuts
 
-You can define a shortcut key that sets the focus to a field component (any
-component that inherits [classname]#AbstractField#) by adding a
-[classname]#FocusShortcut# as a shortcut listener to the field.
+You can define a shortcut key that sets the focus to any focusable component (implements [interface]#Focusable#), usually field components, by adding a
+[interface]#FocusShortcut# as a shortcut listener to the component.
 
-The constructor of the [classname]#FocusShortcut# takes the field component as
+The constructor of the [classname]#FocusShortcut# takes the focusable component as
 its first parameter, followed by the key code, and an optional list of modifier
 keys, as listed in <<advanced.shortcuts.keycodes>>.
 
@@ -64,7 +63,7 @@ keys, as listed in <<advanced.shortcuts.keycodes>>.
 // A field with Alt+N bound to it
 TextField name = new TextField("Name (Alt+N)");
 name.addShortcutListener(
-        new AbstractField.FocusShortcut(name, KeyCode.N,
+        new FocusShortcut(name, KeyCode.N,
                                         ModifierKey.ALT));
 layout.addComponent(name);
 ----
@@ -78,7 +77,7 @@ key is indicated with an ampersand ( [literal]#++&++#).
 // A field with Alt+A bound to it, using shorthand notation
 TextField address = new TextField("Address (Alt+A)");
 address.addShortcutListener(
-        new AbstractField.FocusShortcut(address, "&Address"));
+        new FocusShortcut(address, "&Address"));
 ----
 
 This is especially useful for internationalization, so that you can determine
@@ -269,7 +268,7 @@ following defines a kbd:[Ctrl+Shift+N] key combination for a shortcut.
 ----
 TextField name = new TextField("Name (Ctrl+Shift+N)");
 name.addShortcutListener(
-        new AbstractField.FocusShortcut(name, KeyCode.N,
+        new FocusShortcut(name, KeyCode.N,
                                         ModifierKey.CTRL,
                                         ModifierKey.SHIFT));
 ----

server/src/main/java/com/vaadin/event/FocusShortcut.java

@@ -0,0 +1,76 @@
+/*
+ * Copyright 2000-2018 Vaadin Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not
+ * use this file except in compliance with the License. You may obtain a copy of
+ * the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations under
+ * the License.
+ */
+package com.vaadin.event;
+
+import com.vaadin.ui.Component.Focusable;
+
+/**
+ * A ready-made {@link ShortcutListener} that focuses the given
+ * {@link Focusable} (usually a {@link Field}) when the keyboard shortcut is
+ * invoked.
+ *
+ * @author Vaadin Ltd
+ * @since
+ */
+public class FocusShortcut extends ShortcutListener {
+    protected Focusable focusable;
+
+    /**
+     * Creates a keyboard shortcut for focusing the given {@link Focusable}
+     * using the shorthand notation defined in {@link ShortcutAction}.
+     *
+     * @param focusable
+     *            to focused when the shortcut is invoked
+     * @param shorthandCaption
+     *            caption with keycode and modifiers indicated
+     */
+    public FocusShortcut(Focusable focusable, String shorthandCaption) {
+        super(shorthandCaption);
+        this.focusable = focusable;
+    }
+
+    /**
+     * Creates a keyboard shortcut for focusing the given {@link Focusable}.
+     *
+     * @param focusable
+     *            to focused when the shortcut is invoked
+     * @param keyCode
+     *            keycode that invokes the shortcut
+     * @param modifiers
+     *            modifiers required to invoke the shortcut
+     */
+    public FocusShortcut(Focusable focusable, int keyCode, int... modifiers) {
+        super(null, keyCode, modifiers);
+        this.focusable = focusable;
+    }
+
+    /**
+     * Creates a keyboard shortcut for focusing the given {@link Focusable}.
+     *
+     * @param focusable
+     *            to focused when the shortcut is invoked
+     * @param keyCode
+     *            keycode that invokes the shortcut
+     */
+    public FocusShortcut(Focusable focusable, int keyCode) {
+        this(focusable, keyCode, null);
+    }
+
+    @Override
+    public void handleAction(Object sender, Object target) {
+        focusable.focus();
+    }
+}

uitest/src/main/java/com/vaadin/tests/components/FocusShortcuts.java

@@ -0,0 +1,30 @@
+package com.vaadin.tests.components;
+
+import com.vaadin.event.FocusShortcut;
+import com.vaadin.event.ShortcutAction.KeyCode;
+import com.vaadin.event.ShortcutAction.ModifierKey;
+import com.vaadin.server.VaadinRequest;
+import com.vaadin.ui.TextField;
+
+public class FocusShortcuts extends AbstractTestUIWithLog {
+
+    @Override
+    protected void setup(VaadinRequest request) {
+        TextField name = new TextField("Name (Alt+N)");
+        name.addShortcutListener(
+                new FocusShortcut(name, KeyCode.N, ModifierKey.ALT));
+        name.addFocusListener(event -> log("Alt+N"));
+
+        TextField address = new TextField("Address (Alt+A)");
+        address.addShortcutListener(new FocusShortcut(address, "&Address"));
+        address.addFocusListener(event -> log("Alt+A"));
+
+        TextField name2 = new TextField("Name (Ctrl+Shift+D)");
+        name2.addShortcutListener(new FocusShortcut(name2, KeyCode.D,
+                ModifierKey.CTRL, ModifierKey.SHIFT));
+        name2.addFocusListener(event -> log("Ctrl+Shift+D"));
+
+        addComponents(name, address, name2);
+    }
+
+}

uitest/src/test/java/com/vaadin/tests/components/FocusShortcutsTest.java

@@ -0,0 +1,43 @@
+package com.vaadin.tests.components;
+
+import org.junit.Assert;
+import org.junit.Test;
+import org.openqa.selenium.By;
+import org.openqa.selenium.Keys;
+import org.openqa.selenium.WebElement;
+import org.openqa.selenium.interactions.Actions;
+
+import com.vaadin.testbench.elements.TextFieldElement;
+import com.vaadin.tests.tb3.SingleBrowserTest;
+
+public class FocusShortcutsTest extends SingleBrowserTest {
+
+    @Test
+    public void triggerShortCuts() {
+        openTestURL();
+
+        WebElement body = findElement(By.xpath("//body"));
+        Actions actions = new Actions(getDriver());
+        actions.keyDown(body, Keys.LEFT_ALT).sendKeys("a").keyUp(Keys.LEFT_ALT)
+                .build().perform();
+
+        Assert.assertEquals("1. Alt+A", getLogRow(0));
+
+        body.click();
+
+        actions = new Actions(getDriver());
+        actions.keyDown(body, Keys.LEFT_ALT).sendKeys("n").keyUp(Keys.LEFT_ALT)
+                .build().perform();
+
+        Assert.assertEquals("2. Alt+N", getLogRow(0));
+
+        body.click();
+
+        actions = new Actions(getDriver());
+        actions.keyDown(body, Keys.LEFT_CONTROL).keyDown(body, Keys.LEFT_SHIFT)
+                .sendKeys("d").keyUp(Keys.LEFT_CONTROL).keyUp(Keys.LEFT_SHIFT).build().perform();
+
+        Assert.assertEquals("3. Ctrl+Shift+D", getLogRow(0));
+    }
+
+}