Support multiple lines for status text on Chooser UI 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"
@@ skipping 28 matching lines @@
 // Separator alpha value.
 const CGFloat kSeparatorAlphaValue = 0.6f;
 
 // Separator height.
 const CGFloat kSeparatorHeight = 1.0f;
 
 }  // namespace
 
 class ChooserContentViewController : public ChooserController::View {
  public:
-  ChooserContentViewController(ChooserController* chooser_controller,
+  ChooserContentViewController(ChooserContentViewCocoa* chooser_content_view,
+                               ChooserController* chooser_controller,
                                NSTableView* table_view,
                                SpinnerView* spinner,
                                NSTextField* status,
                                NSButton* rescan_button);
   ~ChooserContentViewController() override;
 
   // ChooserController::View:
   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:
+  ChooserContentViewCocoa* chooser_content_view_;
   ChooserController* chooser_controller_;
   NSTableView* table_view_;
   SpinnerView* spinner_;
   NSTextField* status_;
   NSButton* rescan_button_;
 
   DISALLOW_COPY_AND_ASSIGN(ChooserContentViewController);
 };
 
 ChooserContentViewController::ChooserContentViewController(
+    ChooserContentViewCocoa* chooser_content_view,
     ChooserController* chooser_controller,
     NSTableView* table_view,
     SpinnerView* spinner,
     NSTextField* status,
     NSButton* rescan_button)
-    : chooser_controller_(chooser_controller),
+    : chooser_content_view_(chooser_content_view),
+      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_view(this);
@@ skipping 37 matching lines @@
   // of a previously selected row.
   [table_view_ deselectAll:nil];
   UpdateTableView();
   [table_view_ setHidden:NO];
 
   [spinner_ setHidden:YES];
 
   [status_ setHidden:YES];
   // When adapter is enabled, show |rescan_button_|; otherwise hide it.
   [rescan_button_ setHidden:enabled ? NO : YES];
+
+  [chooser_content_view_ updateView];
 }
 
 void ChooserContentViewController::OnRefreshStateChanged(bool refreshing) {
   if (refreshing) {
     // No row is selected since the chooser is refreshing.
     // This will also disable the OK button if it was enabled because
     // of a previously selected row.
     [table_view_ deselectAll:nil];
     UpdateTableView();
   }
 
   // When refreshing and no option available yet, hide |table_view_| and show
   // |spinner_|. Otherwise show |table_view_| and hide |spinner_|.
   bool table_view_hidden =
       refreshing && (chooser_controller_->NumOptions() == 0);
   [table_view_ setHidden:table_view_hidden ? YES : NO];
   [spinner_ setHidden:table_view_hidden ? 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];
+
+  [chooser_content_view_ updateView];
 }
 
 void ChooserContentViewController::UpdateTableView() {
   [table_view_ setEnabled:chooser_controller_->NumOptions() > 0];
   [table_view_ reloadData];
 }
 
 @implementation ChooserContentViewCocoa
 
 - (instancetype)initWithChooserTitle:(NSString*)chooserTitle

[Robert Sesek, 2016/08/08 18:53:03]

For follow-up CL, I'd maybe restructure init to be a bunch of smaller methods to
create the pieces for the view, and then you can just keep the calculateX
methods as local computations to those methods, rather than as helper functions
to the larger init.

[juncai, 2016/08/08 19:17:39]

Added TODO.

                    chooserController:
                        (std::unique_ptr<ChooserController>)chooserController {
   // ------------------------------------
   // | Chooser title                    |
   // | -------------------------------- |
   // | | option 0                     | |
   // | | option 1                     | |
   // | | option 2                     | |
   // | |                              | |
   // | |                              | |
   // | |                              | |
   // | -------------------------------- |
   // |           [ Connect ] [ Cancel ] |
   // |----------------------------------|
   // | Not seeing your device? Get help |
   // ------------------------------------
 
   // Determine the dimensions of the chooser.
   // Once the height and width are set, the buttons and permission menus can
   // be laid out correctly.
   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]);
+    titleHeight_ = NSHeight([titleView_ frame]);
 
     // Status.
     status_ = [self createTextField:l10n_util::GetNSString(
                                         IDS_BLUETOOTH_DEVICE_CHOOSER_SCANNING)];
+    CGFloat statusWidth = kChooserWidth / 2 - kMarginX;
+    // The height is arbitrary as it will be adjusted later.
+    [status_ setFrameSize:NSMakeSize(statusWidth, 0.0f)];
+    [GTMUILocalizerAndLayoutTweaker sizeToFitFixedWidthTextField:status_];
+    statusHeight_ = NSHeight([status_ frame]);
 
     // Re-scan button.
     rescanButton_ =
         [self createHyperlinkButtonWithText:
                   l10n_util::GetNSString(IDS_BLUETOOTH_DEVICE_CHOOSER_RE_SCAN)];
+    rescanButtonHeight_ = NSHeight([rescanButton_ frame]);
 
     // Connect button.
     connectButton_ = [self createConnectButton];
-    CGFloat connectButtonWidth = NSWidth([connectButton_ frame]);
-    CGFloat connectButtonHeight = NSHeight([connectButton_ frame]);
+    connectButtonWidth_ = NSWidth([connectButton_ frame]);
+    connectButtonHeight_ = NSHeight([connectButton_ frame]);
 
     // Cancel button.
     cancelButton_ = [self createCancelButton];
-    CGFloat cancelButtonWidth = NSWidth([cancelButton_ frame]);
+    cancelButtonWidth_ = NSWidth([cancelButton_ frame]);
+    cancelButtonHeight_ = NSHeight([cancelButton_ frame]);
+
+    CGFloat buttonRowHeight =
+        std::max(connectButtonHeight_, cancelButtonHeight_);
 
     // Separator.
     separator_ = [self createSeparator];
 
     // Message.
     message_ = [self createTextField:l10n_util::GetNSStringF(
                                          IDS_DEVICE_CHOOSER_FOOTNOTE_TEXT,
                                          base::string16())];
     CGFloat messageWidth = NSWidth([message_ frame]);
-    CGFloat messageHeight = NSHeight([message_ frame]);
+    messageHeight_ = NSHeight([message_ frame]);
 
     // Help button.
     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;
-    CGFloat scrollViewOriginX = kMarginX;
-    CGFloat scrollViewOriginY =
-        kMarginY + messageHeight + 3 * kVerticalPadding + connectButtonHeight;
-    NSRect scrollFrame = NSMakeRect(scrollViewOriginX, scrollViewOriginY,
-                                    scrollViewWidth, scrollViewHeight);
-    scrollView_.reset([[NSScrollView alloc] initWithFrame:scrollFrame]);
+    noStatusOrRescanButtonShown_.scroll_view_frame =
+        [self calculateScrollViewFrame:buttonRowHeight];
+    scrollView_.reset([[NSScrollView alloc]
+        initWithFrame:noStatusOrRescanButtonShown_.scroll_view_frame]);
     [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)];
+    [tableColumn_
+        setWidth:(noStatusOrRescanButtonShown_.scroll_view_frame.size.width -
+                  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.
+    // When |status_| is shown, it may affect the frame origin and size of the
+    // |scrollView_|, and since the |spinner_| is shown with the |status_|,
+    // its frame origin needs to be calculated according to the frame origin
+    // of |scrollView_| with |status_| shown.
+    NSRect scrollViewFrameWithStatusText = [self
+        calculateScrollViewFrame:std::max(statusHeight_, buttonRowHeight)];
     CGFloat spinnerOriginX =
-        scrollViewOriginX + (scrollViewWidth - kSpinnerSize) / 2;
+        scrollViewFrameWithStatusText.origin.x +
+        (scrollViewFrameWithStatusText.size.width - kSpinnerSize) / 2;
     CGFloat spinnerOriginY =
-        scrollViewOriginY + (scrollViewHeight - kSpinnerSize) / 2;
+        scrollViewFrameWithStatusText.origin.y +
+        (scrollViewFrameWithStatusText.size.height - 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;
+    CGFloat titleOriginY = kChooserHeight - kMarginY - titleHeight_;
     [titleView_ setFrameOrigin:NSMakePoint(titleOriginX, titleOriginY)];
     [self addSubview:titleView_];
 
     // 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;
-    // Bottom-align with the text on the buttons.
-    CGFloat statusOriginY = kMarginY + messageHeight + 2 * kVerticalPadding +
-                            (connectButtonHeight - [NSFont systemFontSize]) / 2;
-    [status_ setFrameOrigin:NSMakePoint(statusOriginX, statusOriginY)];
+    // Status text field and Re-scan button. At most one of them is shown.
     [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;
+    noStatusOrRescanButtonShown_.connect_button_origin =
+        [self calculateConnectButtonOrigin:buttonRowHeight];
     [connectButton_
-        setFrameOrigin:NSMakePoint(connectButtonOriginX, connectButtonOriginY)];
+        setFrameOrigin:noStatusOrRescanButtonShown_.connect_button_origin];
     [connectButton_ setEnabled:NO];
     [self addSubview:connectButton_];
 
     // Cancel button.
-    CGFloat cancelButtonOriginX = kChooserWidth - kMarginX - cancelButtonWidth;
-    CGFloat cancelButtonOriginY = connectButtonOriginY;
+    noStatusOrRescanButtonShown_.cancel_button_origin =
+        [self calculateCancelButtonOrigin:buttonRowHeight];
     [cancelButton_
-        setFrameOrigin:NSMakePoint(cancelButtonOriginX, cancelButtonOriginY)];
+        setFrameOrigin:noStatusOrRescanButtonShown_.cancel_button_origin];
     [self addSubview:cancelButton_];
 
     // Separator.
     CGFloat separatorOriginX = 0.0f;
-    CGFloat separatorOriginY = kMarginY + messageHeight + kVerticalPadding;
+    CGFloat separatorOriginY = kMarginY + messageHeight_ + kVerticalPadding;
     [separator_ setFrameOrigin:NSMakePoint(separatorOriginX, separatorOriginY)];
     [self addSubview:separator_];
 
     // Message.
     CGFloat messageOriginX = kMarginX;
     CGFloat messageOriginY = kMarginY;
     [message_ setFrameOrigin:NSMakePoint(messageOriginX, messageOriginY)];
     [self addSubview:message_];
 
     // 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_];
 
+    // Calculate and cache the frame and origins values.
+    buttonRowHeight = std::max(
+        statusHeight_, std::max(connectButtonHeight_, cancelButtonHeight_));
+    statusShown_ = {[self calculateScrollViewFrame:buttonRowHeight],
+                    [self calculateConnectButtonOrigin:buttonRowHeight],
+                    [self calculateCancelButtonOrigin:buttonRowHeight]};
+    statusOrigin_ = [self calculateStatusOrigin:buttonRowHeight];
+
+    buttonRowHeight =
+        std::max(rescanButtonHeight_,
+                 std::max(connectButtonHeight_, cancelButtonHeight_));
+    rescanButtonShown_ = {[self calculateScrollViewFrame:buttonRowHeight],
+                          [self calculateConnectButtonOrigin:buttonRowHeight],
+                          [self calculateCancelButtonOrigin:buttonRowHeight]};
+    rescanButtonOrigin_ = [self calculateRescanButtonOrigin:buttonRowHeight];
+
     chooserContentViewController_.reset(new ChooserContentViewController(
-        chooserController_.get(), tableView_.get(), spinner_.get(),
+        self, 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];
@@ skipping 55 matching lines @@
     (NSString*)text {
   base::scoped_nsobject<NSButton> button(
       [[NSButton alloc] initWithFrame:NSZeroRect]);
   base::scoped_nsobject<HyperlinkButtonCell> cell(
       [[HyperlinkButtonCell alloc] initTextCell:text]);
   [button setCell:cell.get()];
   [button sizeToFit];
   return button;
 }
 
+- (NSRect)calculateScrollViewFrame:(CGFloat)buttonRowHeight {
+  CGFloat originX = kMarginX;
+  CGFloat originY =
+      kMarginY + messageHeight_ + 3 * kVerticalPadding + buttonRowHeight;
+  CGFloat width = kChooserWidth - 2 * kMarginX;
+  CGFloat height = kChooserHeight - 2 * kMarginY - 4 * kVerticalPadding -
+                   titleHeight_ - buttonRowHeight - messageHeight_;
+  return NSMakeRect(originX, originY, width, height);
+}
+
+- (NSPoint)calculateStatusOrigin:(CGFloat)buttonRowHeight {
+  return NSMakePoint(kMarginX, kMarginY + messageHeight_ +
+                                   2 * kVerticalPadding +
+                                   (buttonRowHeight - statusHeight_) / 2);
+}
+
+- (NSPoint)calculateRescanButtonOrigin:(CGFloat)buttonRowHeight {
+  return NSMakePoint(kMarginX, kMarginY + messageHeight_ +
+                                   2 * kVerticalPadding +
+                                   (buttonRowHeight - rescanButtonHeight_) / 2);
+}
+
+- (NSPoint)calculateConnectButtonOrigin:(CGFloat)buttonRowHeight {
+  return NSMakePoint(kChooserWidth - kMarginX - kHorizontalPadding -
+                         connectButtonWidth_ - cancelButtonWidth_,
+                     kMarginY + messageHeight_ + 2 * kVerticalPadding +
+                         (buttonRowHeight - connectButtonHeight_) / 2);
+}
+
+- (NSPoint)calculateCancelButtonOrigin:(CGFloat)buttonRowHeight {
+  return NSMakePoint(kChooserWidth - kMarginX - cancelButtonWidth_,
+                     kMarginY + messageHeight_ + 2 * kVerticalPadding +
+                         (buttonRowHeight - cancelButtonHeight_) / 2);
+}
+
+- (void)updateView {
+  FrameAndOrigin frameAndOrigin;
+  if (![status_ isHidden]) {
+    [status_ setFrameOrigin:statusOrigin_];
+    frameAndOrigin = statusShown_;
+  } else if (![rescanButton_ isHidden]) {
+    [rescanButton_ setFrameOrigin:rescanButtonOrigin_];
+    frameAndOrigin = rescanButtonShown_;
+  } else {
+    frameAndOrigin = noStatusOrRescanButtonShown_;
+  }
+
+  [scrollView_ setFrame:frameAndOrigin.scroll_view_frame];
+  [connectButton_ setFrameOrigin:frameAndOrigin.connect_button_origin];
+  [cancelButton_ setFrameOrigin:frameAndOrigin.cancel_button_origin];
+}
+
 - (NSTableView*)tableView {
   return tableView_.get();
 }
 
 - (SpinnerView*)spinner {
   return spinner_.get();
 }
 
 - (NSTextField*)status {
   return status_.get();
@@ skipping 55 matching lines @@
 
 - (void)onRescan:(id)sender {
   chooserController_->RefreshOptions();
 }
 
 - (void)onHelpPressed:(id)sender {
   chooserController_->OpenHelpCenterUrl();
 }
 
 @end