Changeset 262051 in webkit

Timestamp:

May 22, 2020 4:15:00 AM (4 years ago)

Author:

timothy_horton@apple.com

Message:

iOS: Pressing tab in the Mail subject field moves focus to the body, but pressing shift tab doesn't move it back
​https://bugs.webkit.org/show_bug.cgi?id=212243
<rdar://problem/59127764>

Reviewed by Wenson Hsieh.

Source/WebCore:

New API Tests: WebKit.ShiftTabTakesFocusFromEditableWebView and WebKit.TabDoesNotTakeFocusFromEditableWebView

• page/FocusController.cpp:

(WebCore::FocusController::relinquishFocusToChrome):
(WebCore::FocusController::advanceFocusInDocumentOrder):

• page/FocusController.h:

Factor out the code that decides whether the Chrome might accept focus,
and transfers focus out to the Chrome, for use in EventHandler.

• page/EventHandler.cpp:

(WebCore::EventHandler::defaultTabEventHandler):
In the case where we are shift-tabbing out of an editable web view,
allow focus to pass to the Chrome. Previously, we would not allow this,
because tabKeyCyclesThroughElements is false in editable web views.
However, focus exiting the web view entirely needn't be covered by
"cycles through elements" behavior.
We can't do this for plain "tab", because that needs to be allowed to
insert a tab character instead.

Tools:

• TestWebKitAPI/Tests/WebKitCocoa/UIDelegate.mm:

(-[FocusDelegate _webView:takeFocus:]):
(-[FocusDelegate webView:runJavaScriptAlertPanelWithMessage:initiatedByFrame:completionHandler:]):
(TEST):

Location:

trunk

Files:

• Source/WebCore/ChangeLog (modified) (1 diff)
• Source/WebCore/page/EventHandler.cpp (modified) (2 diffs)
• Source/WebCore/page/FocusController.cpp (modified) (2 diffs)
• Source/WebCore/page/FocusController.h (modified) (1 diff)
• Tools/ChangeLog (modified) (1 diff)
• Tools/TestWebKitAPI/Tests/WebKitCocoa/UIDelegate.mm (modified) (3 diffs)

trunk/Source/WebCore/ChangeLog

@@ +1 @@
+2020-05-22  Tim Horton  <timothy_horton@apple.com>
+
+        iOS: Pressing tab in the Mail subject field moves focus to the body, but pressing shift tab doesn't move it back
+        https://bugs.webkit.org/show_bug.cgi?id=212243
+        <rdar://problem/59127764>
+
+        Reviewed by Wenson Hsieh.
+
+        New API Tests: WebKit.ShiftTabTakesFocusFromEditableWebView and WebKit.TabDoesNotTakeFocusFromEditableWebView
+
+        * page/FocusController.cpp:
+        (WebCore::FocusController::relinquishFocusToChrome):
+        (WebCore::FocusController::advanceFocusInDocumentOrder):
+        * page/FocusController.h:
+        Factor out the code that decides whether the Chrome might accept focus,
+        and transfers focus out to the Chrome, for use in EventHandler.
+
+        * page/EventHandler.cpp:
+        (WebCore::EventHandler::defaultTabEventHandler):
+        In the case where we are shift-tabbing out of an editable web view,
+        allow focus to pass to the Chrome. Previously, we would not allow this,
+        because tabKeyCyclesThroughElements is false in editable web views.
+        However, focus exiting the web view entirely needn't be covered by
+        "cycles through elements" behavior.
+        We can't do this for plain "tab", because that needs to be allowed to
+        insert a tab character instead.
+
 2020-05-22  Tyler Wilcock  <twilco.o@protonmail.com>
 

trunk/Source/WebCore/page/EventHandler.cpp

@@ -4095 +4095 @@
     if (!page)
         return;
-    if (!page->tabKeyCyclesThroughElements())
-        return;
 
     FocusDirection focusDirection = event.shiftKey() ? FocusDirectionBackward : FocusDirectionForward;
@@ -4103 +4101 @@
     if (m_frame.document()->inDesignMode())
         return;
+
+    // Allow shift-tab to relinquish focus even if we don't allow tab to cycle between elements inside the view.
+    // We can only do this for shift-tab, not tab itself because tabKeyCyclesThroughElements is used to make
+    // tab character insertion work in editable web views.
+    if (!page->tabKeyCyclesThroughElements()) {
+        if (focusDirection == FocusDirectionBackward) {
+            if (page->focusController().relinquishFocusToChrome(focusDirection))
+                event.setDefaultHandled();
+        }
+        return;
+    }
 
     if (page->focusController().advanceFocus(focusDirection, &event))

trunk/Source/WebCore/page/FocusController.cpp

@@ -449 +449 @@
 }
 
+bool FocusController::relinquishFocusToChrome(FocusDirection direction)
+{
+    RefPtr<Document> document = focusedOrMainFrame().document();
+    if (!document)
+        return false;
+
+    if (!m_page.chrome().canTakeFocus(direction) || m_page.isControlledByAutomation())
+        return false;
+
+    document->setFocusedElement(nullptr);
+    setFocusedFrame(nullptr);
+    m_page.chrome().takeFocus(direction);
+    return true;
+}
+
 bool FocusController::advanceFocusInDocumentOrder(FocusDirection direction, KeyboardEvent* event, bool initialFocus)
 {
@@ -467 +482 @@
     if (!element) {
         // We didn't find a node to focus, so we should try to pass focus to Chrome.
-        if (!initialFocus && m_page.chrome().canTakeFocus(direction) && !m_page.isControlledByAutomation()) {
-            document->setFocusedElement(nullptr);
-            setFocusedFrame(nullptr);
-            m_page.chrome().takeFocus(direction);
-            return true;
+        if (!initialFocus) {
+            if (relinquishFocusToChrome(direction))
+                return true;
         }
 

trunk/Source/WebCore/page/FocusController.h

@@ -79 +79 @@
     Seconds timeSinceFocusWasSet() const;
 
+    bool relinquishFocusToChrome(FocusDirection);
+
 private:
     void setActiveInternal(bool);

trunk/Tools/ChangeLog

@@ +1 @@
+2020-05-22  Tim Horton  <timothy_horton@apple.com>
+
+        iOS: Pressing tab in the Mail subject field moves focus to the body, but pressing shift tab doesn't move it back
+        https://bugs.webkit.org/show_bug.cgi?id=212243
+        <rdar://problem/59127764>
+
+        Reviewed by Wenson Hsieh.
+
+        * TestWebKitAPI/Tests/WebKitCocoa/UIDelegate.mm:
+        (-[FocusDelegate _webView:takeFocus:]):
+        (-[FocusDelegate webView:runJavaScriptAlertPanelWithMessage:initiatedByFrame:completionHandler:]):
+        (TEST):
+
 2020-05-21  Wenson Hsieh  <wenson_hsieh@apple.com>
 

trunk/Tools/TestWebKitAPI/Tests/WebKitCocoa/UIDelegate.mm

@@ -810 +810 @@
 }
 
-static _WKFocusDirection takenDirection;
-
 @interface FocusDelegate : NSObject <WKUIDelegatePrivate>
-@end
-
-@implementation FocusDelegate
+@property (nonatomic) _WKFocusDirection takenDirection;
+@property (nonatomic) BOOL useShiftTab;
+@end
+
+@implementation FocusDelegate {
+@package
+    bool _done;
+    bool _didSendKeyEvent;
+}
 
 - (void)_webView:(WKWebView *)webView takeFocus:(_WKFocusDirection)direction
 {
-    takenDirection = direction;
-    done = true;
+    _takenDirection = direction;
+    _done = true;
 }
 
@@ -826 +830 @@
 {
     completionHandler();
-    synthesizeTab([webView window], webView, true);
+    _didSendKeyEvent = true;
+    synthesizeTab([webView window], webView, _useShiftTab);
 }
 
@@ -835 +840 @@
     auto webView = adoptNS([[WKWebView alloc] initWithFrame:CGRectMake(0, 0, 800, 600)]);
     auto delegate = adoptNS([[FocusDelegate alloc] init]);
+    [delegate setUseShiftTab:YES];
     [webView setUIDelegate:delegate.get()];
     NSString *html = @"<script>function loaded() { document.getElementById('in').focus(); alert('ready'); }</script>"
     "<body onload='loaded()'><input type='text' id='in'></body>";
     [webView loadHTMLString:html baseURL:[NSURL URLWithString:@"http://example.com/"]];
-    TestWebKitAPI::Util::run(&done);
-    ASSERT_EQ(takenDirection, _WKFocusDirectionBackward);
+    TestWebKitAPI::Util::run(&delegate->_done);
+    ASSERT_EQ([delegate takenDirection], _WKFocusDirectionBackward);
+}
+
+TEST(WebKit, ShiftTabTakesFocusFromEditableWebView)
+{
+    auto webView = adoptNS([[WKWebView alloc] initWithFrame:CGRectMake(0, 0, 800, 600)]);
+    [webView _setEditable:YES];
+
+    auto delegate = adoptNS([[FocusDelegate alloc] init]);
+    [delegate setUseShiftTab:YES];
+    [webView setUIDelegate:delegate.get()];
+    NSString *html = @"<script>function loaded() { document.body.focus(); alert('ready'); }</script>"
+    "<body onload='loaded()'></body>";
+    [webView loadHTMLString:html baseURL:[NSURL URLWithString:@"http://example.com/"]];
+    TestWebKitAPI::Util::run(&delegate->_done);
+    ASSERT_EQ([delegate takenDirection], _WKFocusDirectionBackward);
+}
+
+TEST(WebKit, TabDoesNotTakeFocusFromEditableWebView)
+{
+    auto webView = adoptNS([[TestWKWebView alloc] initWithFrame:CGRectMake(0, 0, 800, 600)]);
+    [webView _setEditable:YES];
+
+    auto delegate = adoptNS([[FocusDelegate alloc] init]);
+    [webView setUIDelegate:delegate.get()];
+    NSString *html = @"<script>function loaded() { document.body.focus(); alert('ready'); }</script>"
+    "<body onload='loaded()'></body>";
+    [webView loadHTMLString:html baseURL:[NSURL URLWithString:@"http://example.com/"]];
+    TestWebKitAPI::Util::run(&delegate->_didSendKeyEvent);
+    EXPECT_WK_STREQ("\t", [webView stringByEvaluatingJavaScript:@"document.body.textContent"]);
+    ASSERT_FALSE(delegate->_done);
 }