Use text input type to control visibility of virtual keyboard

chrome/browser/ui/touch/keyboard/keyboard_manager.cc

 // Copyright (c) 2011 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "chrome/browser/ui/touch/keyboard/keyboard_manager.h"
 
+#include "base/json/json_writer.h"
+#include "base/values.h"
+#include "chrome/browser/extensions/extension_event_router.h"
 #include "chrome/browser/profiles/profile.h"
 #include "chrome/browser/profiles/profile_manager.h"
 #include "chrome/browser/tabs/tab_strip_model.h"
 #include "chrome/browser/ui/browser_list.h"
 #include "chrome/browser/ui/tab_contents/tab_contents_wrapper.h"
 #include "chrome/browser/ui/views/dom_view.h"
 #include "chrome/browser/ui/views/tab_contents/tab_contents_view_touch.h"
 #include "chrome/common/extensions/extension_messages.h"
 #include "chrome/common/chrome_notification_types.h"
 #include "chrome/common/url_constants.h"
 #include "content/browser/site_instance.h"
 #include "content/browser/tab_contents/tab_contents.h"
 #include "content/common/notification_service.h"
 #include "ui/base/animation/slide_animation.h"
 #include "ui/base/ime/text_input_type.h"
 #include "ui/gfx/interpolated_transform.h"
 #include "views/ime/text_input_client.h"
 #include "views/widget/widget.h"
 
 #if defined(OS_CHROMEOS)
 #include "chrome/browser/chromeos/input_method/virtual_keyboard_selector.h"
 #endif
 
 namespace {
 
 const int kDefaultKeyboardHeight = 300;
 const int kKeyboardSlideDuration = 300;  // In milliseconds
-
-PropertyAccessor<bool>* GetFocusedStateAccessor() {
-  static PropertyAccessor<bool> state;
-  return &state;
-}
-
-// Returns whether the keyboard visibility should be affected by this tab.
-bool TabContentsCanAffectKeyboard(const TabContents* tab_contents) {
-  // There may not be a browser, e.g. for the login window. But if there is
-  // a browser, then |tab_contents| should be the active tab.
-  Browser* browser = Browser::GetBrowserForController(
-      &tab_contents->controller(), NULL);
-  return browser == NULL ||
-        (browser == BrowserList::GetLastActive() &&
-         browser->GetSelectedTabContents() == tab_contents);
-}
+const char kOnTextInputTypeChanged[] =
+    "experimental.input.onTextInputTypeChanged";
 
 }  // namespace
 
 // TODO(sad): Is the default profile always going to be the one we want?
 
 KeyboardManager::KeyboardManager()
     : views::Widget::Widget(),
       dom_view_(new DOMView),
       ALLOW_THIS_IN_INITIALIZER_LIST(
           extension_dispatcher_(ProfileManager::GetDefaultProfile(), this)),
@@ skipping 15 matching lines @@
   SetContentsView(dom_view_);
 
   // Setup observer so the events from the keyboard can be handled.
   TabContentsObserver::Observe(dom_view_->tab_contents());
 
   // Initialize the animation.
   animation_.reset(new ui::SlideAnimation(this));
   animation_->SetTweenType(ui::Tween::LINEAR);
   animation_->SetSlideDuration(kKeyboardSlideDuration);
 
-  // Start listening to notifications to maintain the keyboard visibility, size
-  // etc.
-  registrar_.Add(this,
-                 content::NOTIFICATION_NAV_ENTRY_COMMITTED,
-                 NotificationService::AllSources());
-  registrar_.Add(this,
-                 content::NOTIFICATION_FOCUS_CHANGED_IN_PAGE,
-                 NotificationService::AllSources());
-  registrar_.Add(this,
-                 content::NOTIFICATION_TAB_CONTENTS_DESTROYED,
-                 NotificationService::AllSources());
+  views::TextInputTypeTracker::GetInstance()->AddTextInputTypeObserver(this);
   registrar_.Add(this,
                  chrome::NOTIFICATION_HIDE_KEYBOARD_INVOKED,
                  NotificationService::AllSources());
   registrar_.Add(this,
                  chrome::NOTIFICATION_SET_KEYBOARD_HEIGHT_INVOKED,
                  NotificationService::AllSources());
   registrar_.Add(this,
                  chrome::NOTIFICATION_EDITABLE_ELEMENT_TOUCHED,

[bryeung, 2011/08/03 22:22:04]

Do we still need this?  Won't all editable elements generate TextInputType
changes?

[Peng, 2011/08/04 19:47:53]

I am not sure if it can be removed safely. Add mazda in this CL, I think he can
give me advice. 

[sadrul, 2011/08/04 20:07:56]

I believe this is still necessary for this case: (1) user selects a textfield;
the keyboard pops up (2) user hides the keyboard using the 'hide' key on the
keyboard; the textfield still has the focus (3) user touches the textfield
again.

[mazda, 2011/08/05 01:59:28]

Yes, it is necessary.
TextInputType change notification is not sent without the focus change. The hide
key does not cause the focus change by design. So in a case like sadrul
mentioned, the keyboard does not show up again unless
NOTIFICATION_EDITABLE_ELEMENT_TOUCHED is handled.
NOTIFICATION_EDITABLE_ELEMENT_TOUCHED is always sent when a view that has a text
input type other than TEXT_INPUT_TYPE_NONE is touched.

                  NotificationService::AllSources());
   registrar_.Add(this,
                  content::NOTIFICATION_APP_EXITING,
                  NotificationService::AllSources());
 
 #if defined(OS_CHROMEOS)
   chromeos::input_method::InputMethodManager* manager =
       chromeos::input_method::InputMethodManager::GetInstance();
   manager->AddVirtualKeyboardObserver(this);
 #endif
 }
 
 KeyboardManager::~KeyboardManager() {
+  views::TextInputTypeTracker::GetInstance()->RemoveTextInputTypeObserver(this);
 #if defined(OS_CHROMEOS)
   chromeos::input_method::InputMethodManager* manager =
       chromeos::input_method::InputMethodManager::GetInstance();
   manager->RemoveVirtualKeyboardObserver(this);
 #endif
   // TODO(sad): Do anything else?
 }
 
 void KeyboardManager::ShowKeyboardForWidget(views::Widget* widget) {
   target_ = widget;
@@ skipping 28 matching lines @@
 void KeyboardManager::AnimationProgressed(const ui::Animation* animation) {
   GetRootView()->SetTransform(
       transform_->Interpolate(animation_->GetCurrentValue()));
 }
 
 void KeyboardManager::AnimationEnded(const ui::Animation* animation) {
   if (animation_->GetCurrentValue() < 0.01)
     Widget::Hide();
 }
 
-void KeyboardManager::OnBrowserAdded(const Browser* browser) {
-  browser->tabstrip_model()->AddObserver(this);
-}
-
-void KeyboardManager::OnBrowserRemoved(const Browser* browser) {
-  browser->tabstrip_model()->RemoveObserver(this);
-}
-
 bool KeyboardManager::OnMessageReceived(const IPC::Message& message) {
   bool handled = true;
   IPC_BEGIN_MESSAGE_MAP(KeyboardManager, message)
     IPC_MESSAGE_HANDLER(ExtensionHostMsg_Request, OnRequest)
     IPC_MESSAGE_UNHANDLED(handled = false)
   IPC_END_MESSAGE_MAP()
   return handled;
 }
 
 void KeyboardManager::OnRequest(
     const ExtensionHostMsg_Request_Params& request) {
   extension_dispatcher_.Dispatch(request,
       dom_view_->tab_contents()->render_view_host());
 }
 
-void KeyboardManager::ActiveTabChanged(TabContentsWrapper* old_contents,
-                                       TabContentsWrapper* new_contents,
-                                       int index,
-                                       bool user_gesture) {
-  TabContents* contents = new_contents->tab_contents();
-  if (!TabContentsCanAffectKeyboard(contents))
-    return;
+void KeyboardManager::TextInputTypeChanged(ui::TextInputType type,
+                                           views::Widget *widget)
+{
+  // Send onTextInputTypeChanged event to keyboard extension.
+  ListValue args;

[bryeung, 2011/08/03 22:22:04]

Why a ListValue instead of a StringValue?  Looks like you'll only ever send one.

[Peng, 2011/08/04 19:47:53]

ListValue is for creating arguments for onTextInputTypeChanged(type). I don't
understand how to use StringValue here.

Maybe we could just assign json_args to "[\"type\"]" here?

+  switch (type) {
+  case ui::TEXT_INPUT_TYPE_NONE:

[bryeung, 2011/08/03 22:22:04]

Is this the right indentation?  I was expecting everything inside the switch to
be 2 spaces more indented.

[Peng, 2011/08/04 19:47:53]

Done.

+    args.Append(Value::CreateStringValue("none"));
+    break;
+  case ui::TEXT_INPUT_TYPE_TEXT:
+    args.Append(Value::CreateStringValue("text"));
+    break;
+  case ui::TEXT_INPUT_TYPE_PASSWORD:
+    args.Append(Value::CreateStringValue("password"));
+    break;
+  case ui::TEXT_INPUT_TYPE_SEARCH:
+    args.Append(Value::CreateStringValue("search"));
+    break;
+  case ui::TEXT_INPUT_TYPE_EMAIL:
+    args.Append(Value::CreateStringValue("email"));
+    break;
+  case ui::TEXT_INPUT_TYPE_NUMBER:
+    args.Append(Value::CreateStringValue("number"));
+    break;
+  case ui::TEXT_INPUT_TYPE_TELEPHONE:
+    args.Append(Value::CreateStringValue("tel"));
+    break;
+  case ui::TEXT_INPUT_TYPE_URL:
+    args.Append(Value::CreateStringValue("url"));
+    break;
+  default:
+    args.Append(Value::CreateStringValue("none"));
+    break;
+  }
 
-  // If the tab contents does not have the focus, then it should not affect the
-  // keyboard visibility.
-  views::View* view = static_cast<TabContentsViewTouch*>(contents->view());
-  views::FocusManager* fmanager = view ? view->GetFocusManager() : NULL;
-  if (!fmanager || !view->Contains(fmanager->GetFocusedView()))
-    return;
+  std::string json_args;
+  base::JSONWriter::Write(&args, false, &json_args);
 
-  bool* editable = GetFocusedStateAccessor()->GetProperty(
-      contents->property_bag());
-  if (editable && *editable)
-    ShowKeyboardForWidget(view->GetWidget());
+  Profile* profile =
+      Profile::FromBrowserContext(dom_view_->tab_contents()->browser_context());
+  profile->GetExtensionEventRouter()->DispatchEventToRenderers(
+      kOnTextInputTypeChanged, json_args, NULL, GURL());

[sadrul, 2011/08/03 23:01:14]

Does this send the event to all extension renderers, instead of just the
keyboard extension? Can that be a security/privacy issue?

[Peng, 2011/08/04 19:47:53]

It will send the event to all extensions which listen on the  event by calling
chrome.experimental.input.onTextInputTypeChanged.addListener(). And the
chrome.experimental.input is only visible to extension declares right
permissions in manifest file. So probably it will not be a privacy issue.

+
+  if (type == ui::TEXT_INPUT_TYPE_NONE)
+    Hide();
   else
-    Hide();
+    ShowKeyboardForWidget(widget);
 }
 
 Browser* KeyboardManager::GetBrowser() {
   // TODO(sad): Find a better way. Perhaps just return NULL, and fix
   // SendKeyboardEventInputFunction::GetTopLevelWidget to somehow interact with
   // the WM to find the top level widget?
   return BrowserList::GetLastActive();
 }
 
 gfx::NativeView KeyboardManager::GetNativeViewOfHost() {
@@ skipping 12 matching lines @@
   const GURL& url = virtual_keyboard.GetURLForLayout(virtual_keyboard_layout);
   dom_view_->LoadURL(url);
   VLOG(1) << "VirtualKeyboardChanged: Switched to " << url.spec();
 }
 #endif
 
 void KeyboardManager::Observe(int type,
                               const NotificationSource& source,
                               const NotificationDetails& details) {
   switch (type) {
-    case content::NOTIFICATION_NAV_ENTRY_COMMITTED: {
-      // When a navigation happens, we want to hide the keyboard if the focus is
-      // in the web-page. Otherwise, the keyboard visibility should not change.
-      NavigationController* controller =
-          Source<NavigationController>(source).ptr();
-      TabContents* tab_contents = controller->tab_contents();
-      GetFocusedStateAccessor()->SetProperty(tab_contents->property_bag(),
-                                             false);
-      if (!TabContentsCanAffectKeyboard(tab_contents))
-        break;
-
-      TabContentsViewTouch* view =
-          static_cast<TabContentsViewTouch*>(tab_contents->view());
-      views::View* focused = view->GetFocusManager()->GetFocusedView();
-      views::TextInputClient* input =
-          focused ? focused->GetTextInputClient() : NULL;
-      // Show the keyboard if the focused view supports text-input.
-      if (input && input->GetTextInputType() != ui::TEXT_INPUT_TYPE_NONE)
-        ShowKeyboardForWidget(focused->GetWidget());
-      else
-        Hide();
-      break;
-    }
-
-    case content::NOTIFICATION_FOCUS_CHANGED_IN_PAGE: {
-      // If the focus in the page moved to an editable field, then the keyboard
-      // should be visible, otherwise not.
-      TabContents* tab_contents = Source<TabContents>(source).ptr();
-      const bool editable = *Details<const bool>(details).ptr();
-      GetFocusedStateAccessor()->SetProperty(tab_contents->property_bag(),
-          editable);
-      if (!TabContentsCanAffectKeyboard(tab_contents))
-        break;
-
-      if (editable) {
-        TabContentsViewTouch* view =
-            static_cast<TabContentsViewTouch*>(tab_contents->view());
-        ShowKeyboardForWidget(view->GetWidget());
-      } else {
-        Hide();
-      }
-
-      break;
-    }
-
-    case content::NOTIFICATION_TAB_CONTENTS_DESTROYED: {
-      // Tab content was destroyed. Forget everything about it.
-      GetFocusedStateAccessor()->DeleteProperty(
-          Source<TabContents>(source).ptr()->property_bag());
-      break;
-    }
-
     case chrome::NOTIFICATION_HIDE_KEYBOARD_INVOKED: {
-      // The keyboard is hiding itself.
-      Browser* browser = BrowserList::GetLastActive();
-      if (browser) {
-        TabContents* tab_contents = browser->GetSelectedTabContents();
-        if (tab_contents) {
-          GetFocusedStateAccessor()->SetProperty(tab_contents->property_bag(),
-              false);
-        }
-      }
-
       Hide();
       break;
     }
 
     case chrome::NOTIFICATION_SET_KEYBOARD_HEIGHT_INVOKED: {
       // The keyboard is resizing itself.
 
       // TODO(penghuang) Allow extension conrtol the virtual keyboard directly
       // instead of using Notification.
       int height = *Details<int>(details).ptr();
@@ skipping 31 matching lines @@
 
     default:
       NOTREACHED();
   }
 }
 
 // static
 KeyboardManager* KeyboardManager::GetInstance() {
   return Singleton<KeyboardManager>::get();
 }