Add spinner, status text and Re-scan button to Bluetooth chooser on Mac

chrome/browser/ui/cocoa/chooser_content_view_cocoa.mm

 // Copyright 2016 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.
 
 #import "chrome/browser/ui/cocoa/chooser_content_view_cocoa.h"
 
 #include <algorithm>
 
 #include "base/macros.h"
 #include "base/strings/sys_string_conversions.h"
 #include "chrome/browser/chooser_controller/chooser_controller.h"
 #import "chrome/browser/ui/cocoa/constrained_window/constrained_window_button.h"
+#include "chrome/browser/ui/cocoa/spinner_view.h"
 #include "chrome/grit/generated_resources.h"
 #import "third_party/google_toolbox_for_mac/src/AppKit/GTMUILocalizerAndLayoutTweaker.h"
 #import "ui/base/cocoa/controls/hyperlink_button_cell.h"
 #include "ui/base/l10n/l10n_util_mac.h"
 
 namespace {
 
 // Chooser width.
-const CGFloat kChooserWidth = 320.0f;
+const CGFloat kChooserWidth = 350.0f;
 
 // Chooser height.
-const CGFloat kChooserHeight = 280.0f;
+const CGFloat kChooserHeight = 300.0f;
+
+// Spinner size.
+const CGFloat kSpinnerSize = 50.0f;
 
 // Distance between the chooser border and the view that is closest to the
 // border.
 const CGFloat kMarginX = 20.0f;
 const CGFloat kMarginY = 20.0f;
 
 // Distance between two views inside the chooser.
 const CGFloat kHorizontalPadding = 10.0f;
 const CGFloat kVerticalPadding = 10.0f;
 
 // Separator alpha value.
 const CGFloat kSeparatorAlphaValue = 0.6f;
 
 // Separator height.
 const CGFloat kSeparatorHeight = 1.0f;
 
 }  // namespace
 
-class TableViewController : public ChooserController::Observer {
+class ChooserContentViewController : public ChooserController::Observer {
  public:
-  TableViewController(ChooserController* chooser_controller,
-                      NSTableView* table_view);
-  ~TableViewController() override;
+  ChooserContentViewController(ChooserController* chooser_controller,
+                               NSTableView* table_view,
+                               SpinnerView* spinner,
+                               NSTextField* status,
+                               NSButton* rescan_button);
+  ~ChooserContentViewController() override;
 
   // ChooserController::Observer:
   void OnOptionsInitialized() override;
   void OnOptionAdded(size_t index) override;
   void OnOptionRemoved(size_t index) override;
   void OnAdapterEnabledChanged(bool enabled) override;
   void OnRefreshStateChanged(bool refreshing) override;
 
   void UpdateTableView();
 
  private:
   ChooserController* chooser_controller_;
   NSTableView* table_view_;
+  SpinnerView* spinner_;
+  NSTextField* status_;
+  NSButton* rescan_button_;
 
-  DISALLOW_COPY_AND_ASSIGN(TableViewController);
+  DISALLOW_COPY_AND_ASSIGN(ChooserContentViewController);
 };
 
-TableViewController::TableViewController(ChooserController* chooser_controller,
-                                         NSTableView* table_view)
-    : chooser_controller_(chooser_controller), table_view_(table_view) {
+ChooserContentViewController::ChooserContentViewController(
+    ChooserController* chooser_controller,
+    NSTableView* table_view,
+    SpinnerView* spinner,
+    NSTextField* status,
+    NSButton* rescan_button)
+    : chooser_controller_(chooser_controller),
+      table_view_(table_view),
+      spinner_(spinner),
+      status_(status),
+      rescan_button_(rescan_button) {
   DCHECK(chooser_controller_);
   DCHECK(table_view_);
+  DCHECK(spinner_);
+  DCHECK(status_);
+  DCHECK(rescan_button_);
   chooser_controller_->set_observer(this);
 }
 
-TableViewController::~TableViewController() {
+ChooserContentViewController::~ChooserContentViewController() {
   chooser_controller_->set_observer(nullptr);
 }
 
-void TableViewController::OnOptionsInitialized() {
+void ChooserContentViewController::OnOptionsInitialized() {
   UpdateTableView();
 }
 
-void TableViewController::OnOptionAdded(size_t index) {
+void ChooserContentViewController::OnOptionAdded(size_t index) {
   UpdateTableView();
 }
 
-void TableViewController::OnOptionRemoved(size_t index) {
+void ChooserContentViewController::OnOptionRemoved(size_t index) {
   // |table_view_| will automatically select the removed item's next item.
   // So here it tracks if the removed item is the item that was currently
   // selected, if so, deselect it. Also if the removed item is before the
   // currently selected item, the currently selected item's index needs to
   // be adjusted by one.
   NSInteger idx = static_cast<NSInteger>(index);
   NSInteger selected_row = [table_view_ selectedRow];
   if (selected_row == idx)
     [table_view_ deselectRow:idx];
   else if (selected_row > idx)
     [table_view_
             selectRowIndexes:[NSIndexSet indexSetWithIndex:selected_row - 1]
         byExtendingSelection:NO];
 
   UpdateTableView();
 }
 
-void TableViewController::OnAdapterEnabledChanged(bool enabled) {}
+void ChooserContentViewController::OnAdapterEnabledChanged(bool enabled) {
+  // No row is selected since the adapter status has changed.
+  // This will also disable the OK button if it was enabled because
+  // of a previously selected row.
+  [table_view_ deselectAll:nil];
+  UpdateTableView();
+  [table_view_ setHidden:NO];
 
-void TableViewController::OnRefreshStateChanged(bool refreshing) {}
+  [spinner_ setHidden:YES];
 
-void TableViewController::UpdateTableView() {
+  [status_ setHidden:YES];
+  // When adapter is enabled, show |rescan_button_|; otherwise hide it.
+  [rescan_button_ setHidden:enabled ? NO : YES];
+}
+
+void ChooserContentViewController::OnRefreshStateChanged(bool refreshing) {

[Robert Sesek, 2016/07/21 14:56:32]

Should there be unit tests for these methods?

[juncai, 2016/07/21 22:08:14]

Yes. It needs to modify MockChooserController, I am working on a follow-up patch
to first add tests to non-Mac version, then add tests to Mac version.

+  // No row is selected since the chooser is refreshing or just refreshed.
+  // This will also disable the OK button if it was enabled because
+  // of a previously selected row.
+  [table_view_ deselectAll:nil];
+  UpdateTableView();
+  // When refreshing, hide |table_view_|. When complete, show |table_view_|.
+  [table_view_ setHidden:refreshing ? YES : NO];
+
+  // When refreshing, show |spinner_|. When complete, hide |spinner_|.
+  [spinner_ setHidden:refreshing ? NO : YES];
+
+  // When refreshing, show |status_| and hide |rescan_button_|.
+  // When complete, show |rescan_button_| and hide |status_|.
+  [status_ setHidden:refreshing ? NO : YES];
+  [rescan_button_ setHidden:refreshing ? YES : NO];
+}
+
+void ChooserContentViewController::UpdateTableView() {
   [table_view_ setEnabled:chooser_controller_->NumOptions() > 0];
   [table_view_ reloadData];
 }
 
 @implementation ChooserContentViewCocoa
 
 - (instancetype)initWithChooserTitle:(NSString*)chooserTitle
                    chooserController:
                        (std::unique_ptr<ChooserController>)chooserController {
   // ------------------------------------
@@ skipping 17 matching lines @@
   NSRect chooserFrame = NSMakeRect(0, 0, kChooserWidth, kChooserHeight);
 
   if ((self = [super initWithFrame:chooserFrame])) {
     chooserController_ = std::move(chooserController);
 
     // Create the views.
     // Title.
     titleView_ = [self createChooserTitle:chooserTitle];
     CGFloat titleHeight = NSHeight([titleView_ frame]);
 
+    // Status.
+    status_ = [self createTextField:l10n_util::GetNSString(
+                                        IDS_BLUETOOTH_DEVICE_CHOOSER_SCANNING)];
+
+    // Re-scan button.
+    rescanButton_ =
+        [self createHyperlinkButtonWithText:
+                  l10n_util::GetNSString(IDS_BLUETOOTH_DEVICE_CHOOSER_RE_SCAN)];
+
     // Connect button.
     connectButton_ = [self createConnectButton];
     CGFloat connectButtonWidth = NSWidth([connectButton_ frame]);
     CGFloat connectButtonHeight = NSHeight([connectButton_ frame]);
 
     // Cancel button.
     cancelButton_ = [self createCancelButton];
     CGFloat cancelButtonWidth = NSWidth([cancelButton_ frame]);
 
     // Separator.
     separator_ = [self createSeparator];
 
     // Message.
-    message_ = [self createMessage];
+    message_ = [self createTextField:l10n_util::GetNSStringF(
+                                         IDS_DEVICE_CHOOSER_FOOTNOTE_TEXT,
+                                         base::string16())];
     CGFloat messageWidth = NSWidth([message_ frame]);
     CGFloat messageHeight = NSHeight([message_ frame]);
 
     // Help button.
-    helpButton_ = [self createHelpButton];
+    helpButton_ = [self
+        createHyperlinkButtonWithText:
+            l10n_util::GetNSString(IDS_DEVICE_CHOOSER_GET_HELP_LINK_TEXT)];
 
     // ScollView embedding with TableView.
     CGFloat scrollViewWidth = kChooserWidth - 2 * kMarginX;
     CGFloat scrollViewHeight = kChooserHeight - 2 * kMarginY -
                                4 * kVerticalPadding - titleHeight -
                                connectButtonHeight - messageHeight;
-    NSRect scrollFrame = NSMakeRect(
-        kMarginX,
-        kMarginY + messageHeight + 3 * kVerticalPadding + connectButtonHeight,
-        scrollViewWidth, scrollViewHeight);
+    CGFloat scrollViewOriginX = kMarginX;
+    CGFloat scrollViewOriginY =
+        kMarginY + messageHeight + 3 * kVerticalPadding + connectButtonHeight;
+    NSRect scrollFrame = NSMakeRect(scrollViewOriginX, scrollViewOriginY,
+                                    scrollViewWidth, scrollViewHeight);
     scrollView_.reset([[NSScrollView alloc] initWithFrame:scrollFrame]);
     [scrollView_ setBorderType:NSBezelBorder];
     [scrollView_ setHasVerticalScroller:YES];
     [scrollView_ setHasHorizontalScroller:YES];
     [scrollView_ setAutohidesScrollers:YES];
 
     // TableView.
     tableView_.reset([[NSTableView alloc] initWithFrame:NSZeroRect]);
     tableColumn_.reset([[NSTableColumn alloc] initWithIdentifier:@""]);
     [tableColumn_ setWidth:(scrollViewWidth - kMarginX)];
     [tableView_ addTableColumn:tableColumn_];
     // Make the column title invisible.
     [tableView_ setHeaderView:nil];
     [tableView_ setFocusRingType:NSFocusRingTypeNone];
 
+    // Spinner.
+    // Set the spinner in the center of the scroll view.
+    CGFloat spinnerOriginX =
+        scrollViewOriginX + (scrollViewWidth - kSpinnerSize) / 2;
+    CGFloat spinnerOriginY =
+        scrollViewOriginY + (scrollViewHeight - kSpinnerSize) / 2;
+    spinner_.reset([[SpinnerView alloc]
+        initWithFrame:NSMakeRect(spinnerOriginX, spinnerOriginY, kSpinnerSize,
+                                 kSpinnerSize)]);
+
     // Lay out the views.
     // Title.
     CGFloat titleOriginX = kMarginX;
     CGFloat titleOriginY = kChooserHeight - kMarginY - titleHeight;
     [titleView_ setFrameOrigin:NSMakePoint(titleOriginX, titleOriginY)];
     [self addSubview:titleView_];
 
-    // ScollView.
+    // ScollView and Spinner. Only one of them is shown.
     [scrollView_ setDocumentView:tableView_];
     [self addSubview:scrollView_];
+    [spinner_ setHidden:YES];
+    [self addSubview:spinner_];
+
+    // Status text field and Re-scan button. Only one of them is shown.
+    CGFloat statusOriginX = kMarginX;
+    CGFloat statusOriginY = kMarginY + messageHeight + 2 * kVerticalPadding;
+    [status_ setFrameOrigin:NSMakePoint(statusOriginX, statusOriginY)];
+    [self addSubview:status_];
+    [status_ setHidden:YES];
+    [rescanButton_ setFrameOrigin:NSMakePoint(statusOriginX, statusOriginY)];
+    [rescanButton_ setTarget:self];
+    [rescanButton_ setAction:@selector(onRescan:)];
+    [self addSubview:rescanButton_];
+    [rescanButton_ setHidden:YES];
 
     // Connect button.
     CGFloat connectButtonOriginX = kChooserWidth - kMarginX -
                                    kHorizontalPadding - connectButtonWidth -
                                    cancelButtonWidth;
-    CGFloat connectButtonOriginY =
-        kMarginY + messageHeight + 2 * kVerticalPadding;
+    CGFloat connectButtonOriginY = statusOriginY;
     [connectButton_
         setFrameOrigin:NSMakePoint(connectButtonOriginX, connectButtonOriginY)];
     [connectButton_ setEnabled:NO];
     [self addSubview:connectButton_];
 
     // Cancel button.
     CGFloat cancelButtonOriginX = kChooserWidth - kMarginX - cancelButtonWidth;
     CGFloat cancelButtonOriginY = connectButtonOriginY;
     [cancelButton_
         setFrameOrigin:NSMakePoint(cancelButtonOriginX, cancelButtonOriginY)];
@@ skipping 14 matching lines @@
     // Help button.
     CGFloat helpButtonOriginX =
         kMarginX + messageWidth - kHorizontalPadding / 2;
     CGFloat helpButtonOriginY = kMarginY;
     [helpButton_
         setFrameOrigin:NSMakePoint(helpButtonOriginX, helpButtonOriginY)];
     [helpButton_ setTarget:self];
     [helpButton_ setAction:@selector(onHelpPressed:)];
     [self addSubview:helpButton_];
 
-    tableViewController_.reset(
-        new TableViewController(chooserController_.get(), tableView_.get()));
+    chooserContentViewController_.reset(new ChooserContentViewController(
+        chooserController_.get(), tableView_.get(), spinner_.get(),
+        status_.get(), rescanButton_.get()));
   }
 
   return self;
 }
 
 - (base::scoped_nsobject<NSTextField>)createChooserTitle:(NSString*)title {
   base::scoped_nsobject<NSTextField> titleView(
       [[NSTextField alloc] initWithFrame:NSZeroRect]);
   [titleView setDrawsBackground:NO];
   [titleView setBezeled:NO];
@@ skipping 30 matching lines @@
 
 - (base::scoped_nsobject<NSBox>)createSeparator {
   base::scoped_nsobject<NSBox> spacer([[NSBox alloc] initWithFrame:NSZeroRect]);
   [spacer setBoxType:NSBoxSeparator];
   [spacer setBorderType:NSLineBorder];
   [spacer setAlphaValue:kSeparatorAlphaValue];
   [spacer setFrameSize:NSMakeSize(kChooserWidth, kSeparatorHeight)];
   return spacer;
 }
 
-- (base::scoped_nsobject<NSTextField>)createMessage {
-  base::scoped_nsobject<NSTextField> messageView(
+- (base::scoped_nsobject<NSTextField>)createTextField:(NSString*)text {
+  base::scoped_nsobject<NSTextField> textField(
       [[NSTextField alloc] initWithFrame:NSZeroRect]);
-  [messageView setDrawsBackground:NO];
-  [messageView setBezeled:NO];
-  [messageView setEditable:NO];
-  [messageView setSelectable:NO];
-  [messageView
-      setStringValue:l10n_util::GetNSStringF(IDS_DEVICE_CHOOSER_FOOTNOTE_TEXT,
-                                             base::string16())];
-  [messageView setFont:[NSFont systemFontOfSize:[NSFont systemFontSize]]];
-  [messageView sizeToFit];
-  return messageView;
+  [textField setDrawsBackground:NO];
+  [textField setBezeled:NO];
+  [textField setEditable:NO];
+  [textField setSelectable:NO];
+  [textField setStringValue:text];
+  [textField setFont:[NSFont systemFontOfSize:[NSFont systemFontSize]]];
+  [textField sizeToFit];
+  return textField;
 }
 
-- (base::scoped_nsobject<NSButton>)createHelpButton {
+- (base::scoped_nsobject<NSButton>)createHyperlinkButtonWithText:
+    (NSString*)text {
   base::scoped_nsobject<NSButton> button(
       [[NSButton alloc] initWithFrame:NSZeroRect]);
-  base::scoped_nsobject<HyperlinkButtonCell> cell([[HyperlinkButtonCell alloc]
-      initTextCell:l10n_util::GetNSString(
-                       IDS_DEVICE_CHOOSER_GET_HELP_LINK_TEXT)]);
+  base::scoped_nsobject<HyperlinkButtonCell> cell(
+      [[HyperlinkButtonCell alloc] initTextCell:text]);
   [button setCell:cell.get()];
   [button sizeToFit];
   return button;
 }
 
 - (NSTableView*)tableView {
   return tableView_.get();
 }
 
 - (NSButton*)connectButton {
@@ skipping 13 matching lines @@
   // no devices, so the number of rows is always at least 1.
   return std::max(static_cast<NSInteger>(chooserController_->NumOptions()),
                   static_cast<NSInteger>(1));
 }
 
 - (NSString*)optionAtIndex:(NSInteger)index {
   NSInteger numOptions =
       static_cast<NSInteger>(chooserController_->NumOptions());
   if (numOptions == 0) {
     DCHECK_EQ(0, index);
-    return l10n_util::GetNSString(IDS_DEVICE_CHOOSER_NO_DEVICES_FOUND_PROMPT);
+    return base::SysUTF16ToNSString(chooserController_->GetNoOptionsText());
   }
 
   DCHECK_GE(index, 0);
   DCHECK_LT(index, numOptions);
 
   return base::SysUTF16ToNSString(
       chooserController_->GetOption(static_cast<size_t>(index)));
 }
 
 - (void)updateTableView {
-  tableViewController_->UpdateTableView();
+  chooserContentViewController_->UpdateTableView();
 }
 
 - (void)accept {
   chooserController_->Select([tableView_ selectedRow]);
 }
 
 - (void)cancel {
   chooserController_->Cancel();
 }
 
 - (void)close {
   chooserController_->Close();
 }
 
+- (void)onRescan:(id)sender {
+  chooserController_->RefreshOptions();
+}
+
 - (void)onHelpPressed:(id)sender {
   chooserController_->OpenHelpCenterUrl();
 }
 
 @end