Turn off highlight of MenuItemView when mouse exits on a drag

Modified MenuController::OnMouseDragged to turn off highlight of a
MenuItemView when the mouse exits on a drag. This fixes a small visual
bug where the highlight would turn off when the mouse was released and
subsequently moved.

Bug: 553438
Change-Id: Ib6448954870d8709af222d30f4c431036bdfb975
Reviewed-on: https://chromium-review.googlesource.com/550261
Commit-Queue: Jess Zeisloft <jzeisloft@google.com>
Reviewed-by: Sadrul Chowdhury <sadrul@chromium.org>
Reviewed-by: Jonathan Ross <jonross@chromium.org>
Cr-Commit-Position: refs/heads/master@{#487264}

ui/views/controls/menu/menu_controller.cc

@@ -627,7 +627,17 @@ bool MenuController::OnMouseDragged(SubmenuView* source,
       SetSelection(part.menu ? part.menu : state_.item, SELECTION_OPEN_SUBMENU);
     }
   } else if (part.type == MenuPart::NONE) {
-    ShowSiblingMenu(source, event.location());
+    // If there is a sibling menu, show it. Otherwise, if the user has selected
+    // a menu item with no accompanying sibling menu or submenu, move selection
+    // back to the parent menu item.
+    if (!ShowSiblingMenu(source, event.location())) {
+      if (!part.is_scroll() && pending_state_.item &&
+          pending_state_.item->GetParentMenuItem() &&
+          !pending_state_.item->SubmenuIsShowing()) {
+        SetSelection(pending_state_.item->GetParentMenuItem(),
+                     SELECTION_OPEN_SUBMENU);
+      }
+    }
   }
   UpdateActiveMouseView(source, event, mouse_menu);
 
@@ -1329,8 +1339,7 @@ void MenuController::OnKeyDown(ui::KeyboardCode key_code) {
     case ui::VKEY_ESCAPE:
       if (!state_.item->GetParentMenuItem() ||
           (!state_.item->GetParentMenuItem()->GetParentMenuItem() &&
-           (!state_.item->HasSubmenu() ||
-            !state_.item->GetSubmenu()->IsShowing()))) {
+           (!state_.item->SubmenuIsShowing()))) {
         // User pressed escape and current menu has no submenus. If we are
         // nested, close the current menu on the stack. Otherwise fully exit the
         // menu.
@@ -1633,7 +1642,7 @@ MenuController::MenuPart MenuController::GetMenuPartByScreenCoordinateUsingMenu(
     const gfx::Point& screen_loc) {
   MenuPart part;
   for (; item; item = item->GetParentMenuItem()) {
-    if (item->HasSubmenu() && item->GetSubmenu()->IsShowing() &&
+    if (item->SubmenuIsShowing() &&
         GetMenuPartByScreenCoordinateImpl(item->GetSubmenu(), screen_loc,
                                           &part)) {
       return part;
@@ -1764,8 +1773,7 @@ void MenuController::CommitPendingSelection() {
     } else {
       state_.submenu_open = false;
     }
-  } else if (state_.item->HasSubmenu() &&
-             state_.item->GetSubmenu()->IsShowing()) {
+  } else if (state_.item->SubmenuIsShowing()) {
     state_.item->GetSubmenu()->Hide();
   }
 
@@ -1775,7 +1783,7 @@ void MenuController::CommitPendingSelection() {
     bool found = false;
     for (MenuItemView* item = state_.item; item && !found;
          item = item->GetParentMenuItem()) {
-      found = (item->HasSubmenu() && item->GetSubmenu()->IsShowing() &&
+      found = (item->SubmenuIsShowing() &&
                item->GetSubmenu() == scroll_task_->submenu());
     }
     if (!found)
@@ -2184,8 +2192,7 @@ void MenuController::IncrementSelection(
     SelectionIncrementDirectionType direction) {
   MenuItemView* item = pending_state_.item;
   DCHECK(item);
-  if (pending_state_.submenu_open && item->HasSubmenu() &&
-      item->GetSubmenu()->IsShowing()) {
+  if (pending_state_.submenu_open && item->SubmenuIsShowing()) {
     // A menu is selected and open, but none of its children are selected,
     // select the first menu item that is visible and enabled.
     if (item->GetSubmenu()->GetMenuItemCount()) {
@@ -2278,7 +2285,7 @@ void MenuController::CloseSubmenu() {
   DCHECK(item);
   if (!item->GetParentMenuItem())
     return;
-  if (item->HasSubmenu() && item->GetSubmenu()->IsShowing())
+  if (item->SubmenuIsShowing())
     SetSelection(item, SELECTION_UPDATE_IMMEDIATELY);
   else if (item->GetParentMenuItem()->GetParentMenuItem())
     SetSelection(item->GetParentMenuItem(), SELECTION_UPDATE_IMMEDIATELY);
@@ -2346,7 +2353,7 @@ void MenuController::SelectByChar(base::char16 character) {
   base::char16 char_array[] = { character, 0 };
   base::char16 key = base::i18n::ToLower(char_array)[0];
   MenuItemView* item = pending_state_.item;
-  if (!item->HasSubmenu() || !item->GetSubmenu()->IsShowing())
+  if (!item->SubmenuIsShowing())
     item = item->GetParentMenuItem();
   DCHECK(item);
   DCHECK(item->HasSubmenu());
@@ -2672,8 +2679,7 @@ void MenuController::HandleMouseLocation(SubmenuView* source,
     SetSelection(part.menu, SELECTION_OPEN_SUBMENU);
   } else if (!part.is_scroll() && pending_state_.item &&
              pending_state_.item->GetParentMenuItem() &&
-             (!pending_state_.item->HasSubmenu() ||
-              !pending_state_.item->GetSubmenu()->IsShowing())) {
+             !pending_state_.item->SubmenuIsShowing()) {
     // On exit if the user hasn't selected an item with a submenu, move the
     // selection back to the parent menu item.
     SetSelection(pending_state_.item->GetParentMenuItem(),

ui/views/controls/menu/menu_controller_unittest.cc

@@ -1417,6 +1417,47 @@ TEST_F(MenuControllerTest, RepostEventToEmptyMenuItem) {
   EXPECT_EQ(menu_controller_delegate(), GetCurrentDelegate());
 }
 
+// Drag the mouse from an external view into a menu
+// When the mouse leaves the menu while still in the process of dragging
+// the menu item view highlight should turn off
+TEST_F(MenuControllerTest, DragFromViewIntoMenuAndExit) {
+  SubmenuView* sub_menu = menu_item()->GetSubmenu();
+  MenuItemView* first_item = sub_menu->GetMenuItemAt(0);
+
+  std::unique_ptr<View> drag_view = base::MakeUnique<View>();
+  drag_view->SetBoundsRect(gfx::Rect(0, 500, 100, 100));
+  sub_menu->ShowAt(owner(), gfx::Rect(0, 0, 100, 100), false);
+  gfx::Point press_location(drag_view->bounds().CenterPoint());
+  gfx::Point drag_location(first_item->bounds().CenterPoint());
+  gfx::Point release_location(200, 50);
+
+  // Begin drag on an external view
+  ui::MouseEvent press_event(ui::ET_MOUSE_PRESSED, press_location,
+                             press_location, ui::EventTimeForNow(),
+                             ui::EF_LEFT_MOUSE_BUTTON, 0);
+  drag_view->OnMousePressed(press_event);
+
+  // Drag into a menu item
+  ui::MouseEvent drag_event_enter(ui::ET_MOUSE_DRAGGED, drag_location,
+                                  drag_location, ui::EventTimeForNow(),
+                                  ui::EF_LEFT_MOUSE_BUTTON, 0);
+  ProcessMouseDragged(sub_menu, drag_event_enter);
+  EXPECT_TRUE(first_item->IsSelected());
+
+  // Drag out of the menu item
+  ui::MouseEvent drag_event_exit(ui::ET_MOUSE_DRAGGED, release_location,
+                                 release_location, ui::EventTimeForNow(),
+                                 ui::EF_LEFT_MOUSE_BUTTON, 0);
+  ProcessMouseDragged(sub_menu, drag_event_exit);
+  EXPECT_FALSE(first_item->IsSelected());
+
+  // Complete drag with release
+  ui::MouseEvent release_event(ui::ET_MOUSE_RELEASED, release_location,
+                               release_location, ui::EventTimeForNow(),
+                               ui::EF_LEFT_MOUSE_BUTTON, 0);
+  ProcessMouseReleased(sub_menu, release_event);
+}
+
 #endif  // defined(USE_AURA)
 
 }  // namespace test

ui/views/controls/menu/menu_item_view.cc

@@ -347,6 +347,10 @@ SubmenuView* MenuItemView::GetSubmenu() const {
   return submenu_;
 }
 
+bool MenuItemView::SubmenuIsShowing() const {
+  return HasSubmenu() && GetSubmenu()->IsShowing();
+}
+
 void MenuItemView::SetTitle(const base::string16& title) {
   title_ = title;
   invalidate_dimensions();  // Triggers preferred size recalculation.

ui/views/controls/menu/menu_item_view.h

@@ -222,6 +222,9 @@ class VIEWS_EXPORT MenuItemView : public View {
   // Returns the view containing child menu items.
   virtual SubmenuView* GetSubmenu() const;
 
+  // Returns true if this menu item has a submenu and it is showing
+  virtual bool SubmenuIsShowing() const;
+
   // Returns the parent menu item.
   MenuItemView* GetParentMenuItem() { return parent_menu_item_; }
   const MenuItemView* GetParentMenuItem() const { return parent_menu_item_; }