Replace 'Scanning' text in Network Status Area with throbber

ash/system/chromeos/network/network_state_list_detailed_view.cc

 // Copyright (c) 2012 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 "ash/system/chromeos/network/network_state_list_detailed_view.h"
 
 #include <vector>
 
 #include "ash/ash_switches.h"
 #include "ash/metrics/user_metrics_recorder.h"
 #include "ash/networking_config_delegate.h"
 #include "ash/root_window_controller.h"
 #include "ash/shell.h"
 #include "ash/shell_delegate.h"
 #include "ash/shell_window_ids.h"
 #include "ash/system/chromeos/network/tray_network_state_observer.h"
 #include "ash/system/chromeos/network/vpn_list_view.h"
 #include "ash/system/tray/fixed_sized_image_view.h"
 #include "ash/system/tray/fixed_sized_scroll_view.h"
 #include "ash/system/tray/hover_highlight_view.h"
 #include "ash/system/tray/system_tray.h"
 #include "ash/system/tray/system_tray_delegate.h"
+#include "ash/system/tray/throbber_view.h"
 #include "ash/system/tray/tray_constants.h"
 #include "ash/system/tray/tray_details_view.h"
 #include "ash/system/tray/tray_popup_header_button.h"
 #include "ash/system/tray/tray_popup_label_button.h"
 #include "base/command_line.h"
 #include "base/message_loop/message_loop.h"
 #include "base/strings/string_number_conversions.h"
 #include "base/strings/utf_string_conversions.h"
 #include "base/time/time.h"
 #include "chromeos/chromeos_switches.h"
 #include "chromeos/network/device_state.h"
 #include "chromeos/network/network_state.h"
 #include "chromeos/network/network_state_handler.h"
 #include "grit/ash_resources.h"
 #include "grit/ash_strings.h"
 #include "grit/ui_chromeos_strings.h"
 #include "third_party/cros_system_api/dbus/service_constants.h"
 #include "ui/aura/window.h"
 #include "ui/base/l10n/l10n_util.h"
 #include "ui/base/resource/resource_bundle.h"
 #include "ui/chromeos/network/network_connect.h"
 #include "ui/chromeos/network/network_icon.h"
 #include "ui/chromeos/network/network_icon_animation.h"
 #include "ui/chromeos/network/network_info.h"
 #include "ui/chromeos/network/network_list.h"
 #include "ui/chromeos/network/network_list_view_base.h"
 #include "ui/chromeos/resources/grit/ui_chromeos_resources.h"
+#include "ui/compositor/layer.h"
+#include "ui/compositor/scoped_layer_animation_settings.h"
 #include "ui/gfx/text_constants.h"
 #include "ui/views/bubble/bubble_delegate.h"
 #include "ui/views/controls/label.h"
 #include "ui/views/layout/box_layout.h"
 #include "ui/views/layout/fill_layout.h"
+#include "ui/views/layout/layout_manager.h"
 #include "ui/views/widget/widget.h"
 
 using chromeos::DeviceState;
 using chromeos::NetworkHandler;
 using chromeos::NetworkState;
 using chromeos::NetworkStateHandler;
 using chromeos::NetworkTypePattern;
 using ui::NetworkInfo;
 
 namespace ash {
@@ skipping 48 matching lines @@
   ~InfoBubble() override { detailed_view_->OnInfoBubbleDestroyed(); }
 
  private:
   // Not owned.
   NetworkStateListDetailedView* detailed_view_;
 
   DISALLOW_COPY_AND_ASSIGN(InfoBubble);
 };
 
 //------------------------------------------------------------------------------
+
+// A throbber button that can also be clicked on.
+class ThrobberButton : public ThrobberView {
+ public:
+  explicit ThrobberButton(NetworkStateListDetailedView* owner)
+      : owner_(owner) {}
+  ~ThrobberButton() override {}
+
+  // views::View
+  bool OnMousePressed(const ui::MouseEvent& event) override {
+    return owner_->ThrobberPressed(this, event);
+  }
+
+ private:
+  NetworkStateListDetailedView* owner_;
+
+  DISALLOW_COPY_AND_ASSIGN(ThrobberButton);
+};
+
+//------------------------------------------------------------------------------
+
+const int kFadeIconMs = 500;
+
+// A TrayPopupHeaderButton that fades in/out when shown/hidden.
+class InfoIcon : public TrayPopupHeaderButton {
+ public:
+  explicit InfoIcon(views::ButtonListener* listener)
+      : TrayPopupHeaderButton(listener,
+                              IDR_AURA_UBER_TRAY_NETWORK_INFO,
+                              IDR_AURA_UBER_TRAY_NETWORK_INFO,
+                              IDR_AURA_UBER_TRAY_NETWORK_INFO_HOVER,
+                              IDR_AURA_UBER_TRAY_NETWORK_INFO_HOVER,
+                              IDS_ASH_STATUS_TRAY_NETWORK_INFO) {
+    SetPaintToLayer(true);
+    layer()->SetFillsBoundsOpaquely(false);
+    layer()->SetOpacity(1.0);
+  }
+  ~InfoIcon() override {}
+
+  // views::View
+  void SetVisible(bool visible) override {
+    layer()->GetAnimator()->StopAnimating();  // Stop any previous animation.
+    ui::ScopedLayerAnimationSettings animation(layer()->GetAnimator());
+    animation.SetTransitionDuration(
+        base::TimeDelta::FromMilliseconds(kFadeIconMs));
+    layer()->SetOpacity(visible ? 1.0 : 0.0);
+  }
+
+ private:
+  DISALLOW_COPY_AND_ASSIGN(InfoIcon);
+};
+
+//------------------------------------------------------------------------------
+
+// Special layout to overlap the scanning throbber and the info button.
+class InfoThrobberLayout : public views::LayoutManager {
+ public:
+  InfoThrobberLayout() {}
+  ~InfoThrobberLayout() override {}
+
+  // views::LayoutManager
+  void Layout(views::View* host) override {
+    gfx::Size max_size(GetMaxChildSize(host));
+    // Center each child view within |max_size|.
+    for (int i = 0; i < host->child_count(); ++i) {
+      views::View* child = host->child_at(i);
+      if (!child->visible())
+        continue;
+      gfx::Size child_size = child->GetPreferredSize();
+      gfx::Point origin;
+      origin.set_x((max_size.width() - child_size.width()) / 2);
+      origin.set_y((max_size.height() - child_size.height()) / 2);
+      gfx::Rect bounds(origin, child_size);
+      bounds.Inset(-host->GetInsets());
+      child->SetBoundsRect(bounds);
+    }
+  }
+
+  gfx::Size GetPreferredSize(const views::View* host) const override {
+    gfx::Point origin;
+    gfx::Rect rect(origin, GetMaxChildSize(host));
+    rect.Inset(-host->GetInsets());
+    return rect.size();
+  }
+
+ private:
+  gfx::Size GetMaxChildSize(const views::View* host) const {
+    int width = 0, height = 0;
+    for (int i = 0; i < host->child_count(); ++i) {
+      const views::View* child = host->child_at(i);
+      if (!child->visible())
+        continue;
+      gfx::Size child_size = child->GetPreferredSize();
+      width = std::max(width, child_size.width());
+      height = std::max(height, child_size.width());
+    }
+    return gfx::Size(width, height);
+  }
+
+  DISALLOW_COPY_AND_ASSIGN(InfoThrobberLayout);
+};
+
+//------------------------------------------------------------------------------
 // NetworkStateListDetailedView
 
 NetworkStateListDetailedView::NetworkStateListDetailedView(
     SystemTrayItem* owner,
     ListType list_type,
     user::LoginStatus login)
     : NetworkDetailedView(owner),
       list_type_(list_type),
       login_(login),
+      wifi_scanning_(false),
       info_icon_(nullptr),
       button_wifi_(nullptr),
       button_mobile_(nullptr),
       other_wifi_(nullptr),
       turn_on_wifi_(nullptr),
       other_mobile_(nullptr),
       settings_(nullptr),
       proxy_settings_(nullptr),
-      info_bubble_(nullptr) {
+      info_bubble_(nullptr),
+      scanning_throbber_(nullptr) {
   if (list_type == LIST_TYPE_VPN) {
     // Use a specialized class to list VPNs.
     network_list_view_.reset(new VPNListView(this));
   } else {
     // Use a common class to list any other network types.
     network_list_view_.reset(new ui::NetworkListView(this));
   }
 }
 
 NetworkStateListDetailedView::~NetworkStateListDetailedView() {
   if (info_bubble_)
     info_bubble_->GetWidget()->CloseNow();
 }
 
 void NetworkStateListDetailedView::Update() {
   UpdateNetworkList();
   UpdateHeaderButtons();
   UpdateNetworkExtra();
   Layout();
 }
 
 // Overridden from NetworkDetailedView:
 
 void NetworkStateListDetailedView::Init() {
   Reset();
-  info_icon_ = NULL;
-  button_wifi_ = NULL;
-  button_mobile_ = NULL;
-  other_wifi_ = NULL;
-  turn_on_wifi_ = NULL;
-  other_mobile_ = NULL;
-  settings_ = NULL;
-  proxy_settings_ = NULL;
+  info_icon_ = nullptr;
+  button_wifi_ = nullptr;
+  button_mobile_ = nullptr;
+  other_wifi_ = nullptr;
+  turn_on_wifi_ = nullptr;
+  other_mobile_ = nullptr;
+  settings_ = nullptr;
+  proxy_settings_ = nullptr;
+  scanning_throbber_ = nullptr;
 
   CreateScrollableList();
   CreateNetworkExtra();
   CreateHeaderEntry();
-  CreateHeaderButtons();
 
   network_list_view_->set_container(scroll_content());
   Update();
 
   CallRequestScan();
 }
 
 NetworkDetailedView::DetailedViewType
 NetworkStateListDetailedView::GetViewType() const {
   return STATE_LIST_VIEW;
@@ skipping 35 matching lines @@
     delegate->ShowOtherNetworkDialog(shill::kTypeCellular);
   } else if (sender == other_wifi_) {
     Shell::GetInstance()->metrics()->RecordUserMetricsAction(
         ash::UMA_STATUS_AREA_NETWORK_JOIN_OTHER_CLICKED);
     delegate->ShowOtherNetworkDialog(shill::kTypeWifi);
   } else {
     NOTREACHED();
   }
 }
 
+bool NetworkStateListDetailedView::ThrobberPressed(views::View* sender,
+                                                   const ui::Event& event) {
+  if (sender != scanning_throbber_)
+    return false;
+  ToggleInfoBubble();
+  return true;
+}
+
 void NetworkStateListDetailedView::OnViewClicked(views::View* sender) {
   // If the info bubble was visible, close it when some other item is clicked.
   ResetInfoBubble();
 
   if (sender == footer()->content()) {
     TransitionToDefaultView();
     return;
   }
 
   if (login_ == user::LOGGED_IN_LOCKED)
@@ skipping 19 matching lines @@
             ? ash::UMA_STATUS_AREA_CONNECT_TO_VPN
             : ash::UMA_STATUS_AREA_CONNECT_TO_CONFIGURED_NETWORK);
     ui::NetworkConnect::Get()->ConnectToNetwork(service_path);
   }
 }
 
 // Create UI components.
 
 void NetworkStateListDetailedView::CreateHeaderEntry() {
   CreateSpecialRow(IDS_ASH_STATUS_TRAY_NETWORK, this);
-}
 
-void NetworkStateListDetailedView::CreateHeaderButtons() {
   if (list_type_ != LIST_TYPE_VPN) {
     button_wifi_ = new TrayPopupHeaderButton(
         this, IDR_AURA_UBER_TRAY_WIFI_ENABLED, IDR_AURA_UBER_TRAY_WIFI_DISABLED,
         IDR_AURA_UBER_TRAY_WIFI_ENABLED_HOVER,
         IDR_AURA_UBER_TRAY_WIFI_DISABLED_HOVER, IDS_ASH_STATUS_TRAY_WIFI);
     button_wifi_->SetTooltipText(
         l10n_util::GetStringUTF16(IDS_ASH_STATUS_TRAY_DISABLE_WIFI));
     button_wifi_->SetToggledTooltipText(
         l10n_util::GetStringUTF16(IDS_ASH_STATUS_TRAY_ENABLE_WIFI));
     footer()->AddButton(button_wifi_);
 
     button_mobile_ =
         new TrayPopupHeaderButton(this, IDR_AURA_UBER_TRAY_CELLULAR_ENABLED,
                                   IDR_AURA_UBER_TRAY_CELLULAR_DISABLED,
                                   IDR_AURA_UBER_TRAY_CELLULAR_ENABLED_HOVER,
                                   IDR_AURA_UBER_TRAY_CELLULAR_DISABLED_HOVER,
                                   IDS_ASH_STATUS_TRAY_CELLULAR);
     button_mobile_->SetTooltipText(
         l10n_util::GetStringUTF16(IDS_ASH_STATUS_TRAY_DISABLE_MOBILE));
     button_mobile_->SetToggledTooltipText(
         l10n_util::GetStringUTF16(IDS_ASH_STATUS_TRAY_ENABLE_MOBILE));
     footer()->AddButton(button_mobile_);
   }
 
-  info_icon_ = new TrayPopupHeaderButton(
-      this, IDR_AURA_UBER_TRAY_NETWORK_INFO, IDR_AURA_UBER_TRAY_NETWORK_INFO,
-      IDR_AURA_UBER_TRAY_NETWORK_INFO_HOVER,
-      IDR_AURA_UBER_TRAY_NETWORK_INFO_HOVER, IDS_ASH_STATUS_TRAY_NETWORK_INFO);
-  info_icon_->SetTooltipText(
+  views::View* info_throbber_container = new views::View();
+  InfoThrobberLayout* info_throbber_layout = new InfoThrobberLayout;
+  info_throbber_container->SetLayoutManager(info_throbber_layout);
+  footer()->AddView(info_throbber_container, true /* add_separator */);
+
+  info_icon_ = new InfoIcon(this);
+  info_throbber_container->AddChildView(info_icon_);
+
+  scanning_throbber_ = new ThrobberButton(this);
+  // Since the throbber is added last, it will be "on top" of the info button,
+  // so it gets the info tooltip.
+  scanning_throbber_->SetTooltipText(
       l10n_util::GetStringUTF16(IDS_ASH_STATUS_TRAY_NETWORK_INFO));
-  footer()->AddButton(info_icon_);
+  info_throbber_container->AddChildView(scanning_throbber_);
 }
 
 void NetworkStateListDetailedView::CreateNetworkExtra() {
   if (login_ == user::LOGGED_IN_LOCKED)
     return;
 
   ui::ResourceBundle& rb = ui::ResourceBundle::GetSharedInstance();
 
   views::View* bottom_row = new views::View();
   views::BoxLayout* layout = new views::BoxLayout(
@@ skipping 11 matching lines @@
         this, rb.GetLocalizedString(IDS_ASH_STATUS_TRAY_TURN_ON_WIFI));
     bottom_row->AddChildView(turn_on_wifi_);
 
     other_mobile_ = new TrayPopupLabelButton(
         this, rb.GetLocalizedString(IDS_ASH_STATUS_TRAY_OTHER_MOBILE));
     bottom_row->AddChildView(other_mobile_);
   }
 
   CreateSettingsEntry();
 
-  // Both settings_ and proxy_settings_ can be NULL. This happens when
+  // Both settings_ and proxy_settings_ can be null. This happens when
   // we're logged in but showing settings page is not enabled.
   // Example: supervised user creation flow where user session is active
   // but all action happens on the login window.
   // Allowing opening proxy settigns dialog will break assumption in
   //  SystemTrayDelegateChromeOS::ChangeProxySettings(), see CHECK.
   if (settings_ || proxy_settings_)
     bottom_row->AddChildView(settings_ ? settings_ : proxy_settings_);
 
   AddChildView(bottom_row);
 }
 
 // Update UI components.
 
 void NetworkStateListDetailedView::UpdateHeaderButtons() {
   NetworkStateHandler* handler = NetworkHandler::Get()->network_state_handler();
   if (button_wifi_)
     UpdateTechnologyButton(button_wifi_, NetworkTypePattern::WiFi());
   if (button_mobile_) {
     UpdateTechnologyButton(button_mobile_, NetworkTypePattern::Mobile());
   }
   if (proxy_settings_)
-    proxy_settings_->SetEnabled(handler->DefaultNetwork() != NULL);
+    proxy_settings_->SetEnabled(handler->DefaultNetwork() != nullptr);
+
+  // Update Wifi Scanning throbber.
+  bool scanning =
+      NetworkHandler::Get()->network_state_handler()->GetScanningByType(
+          NetworkTypePattern::WiFi());
+  if (scanning != wifi_scanning_) {
+    wifi_scanning_ = scanning;
+    if (scanning) {
+      info_icon_->SetVisible(false);
+      scanning_throbber_->Start();
+      scanning_throbber_->SetTooltipText(
+          l10n_util::GetStringUTF16(IDS_ASH_STATUS_TRAY_WIFI_SCANNING_MESSAGE));
+    } else {
+      scanning_throbber_->Stop();
+      scanning_throbber_->SetTooltipText(
+          l10n_util::GetStringUTF16(IDS_ASH_STATUS_TRAY_NETWORK_INFO));
+      info_icon_->SetVisible(true);
+    }
+  }
 
   static_cast<views::View*>(footer())->Layout();
 }
 
 void NetworkStateListDetailedView::UpdateTechnologyButton(
     TrayPopupHeaderButton* button,
     const NetworkTypePattern& technology) {
   NetworkStateHandler::TechnologyState state =
       NetworkHandler::Get()->network_state_handler()->GetTechnologyState(
           technology);
@@ skipping 26 matching lines @@
     scroll_content()->ReorderChildView(view, index);
     return true;
   }
   return false;
 }
 
 void NetworkStateListDetailedView::UpdateNetworkExtra() {
   if (login_ == user::LOGGED_IN_LOCKED)
     return;
 
-  View* layout_parent = NULL;  // All these buttons have the same parent.
+  View* layout_parent = nullptr;  // All these buttons have the same parent.
   NetworkStateHandler* handler = NetworkHandler::Get()->network_state_handler();
   if (other_wifi_) {
     DCHECK(turn_on_wifi_);
     NetworkStateHandler::TechnologyState state =
         handler->GetTechnologyState(NetworkTypePattern::WiFi());
     if (state == NetworkStateHandler::TECHNOLOGY_UNAVAILABLE) {
       turn_on_wifi_->SetVisible(false);
       other_wifi_->SetVisible(false);
     } else {
       if (state == NetworkStateHandler::TECHNOLOGY_AVAILABLE) {
@@ skipping 66 matching lines @@
 
   info_bubble_ = new InfoBubble(info_icon_, CreateNetworkInfoView(), this);
   views::BubbleDelegateView::CreateBubble(info_bubble_)->Show();
   info_bubble_->NotifyAccessibilityEvent(ui::AX_EVENT_ALERT, false);
 }
 
 bool NetworkStateListDetailedView::ResetInfoBubble() {
   if (!info_bubble_)
     return false;
   info_bubble_->GetWidget()->Close();
-  info_bubble_ = NULL;
+  info_bubble_ = nullptr;
   return true;
 }
 
 void NetworkStateListDetailedView::OnInfoBubbleDestroyed() {
-  info_bubble_ = NULL;
+  info_bubble_ = nullptr;
 }
 
 views::View* NetworkStateListDetailedView::CreateNetworkInfoView() {
   ui::ResourceBundle& bundle = ui::ResourceBundle::GetSharedInstance();
   NetworkStateHandler* handler = NetworkHandler::Get()->network_state_handler();
 
   std::string ip_address("0.0.0.0");
   const NetworkState* network = handler->DefaultNetwork();
   if (network)
     ip_address = network->ip_address();
@@ skipping 138 matching lines @@
   label->SetEnabledColor(SkColorSetARGB(192, 0, 0, 0));
   return label;
 }
 
 void NetworkStateListDetailedView::RelayoutScrollList() {
   scroller()->Layout();
 }
 
 }  // namespace tray
 }  // namespace ash