[rAC, OSX] Add overlay shield for interstitials/waits.

requestAutocomplete displays a splash screen as well as an
interstitial while communicating with wallet using the overlay shield.

The current dialog is hidden behind the shield for the duration, and
the shield can contain images as well as text messages.

R=sail@chromium.org
BUG=157274, 260951

Review URL: https://chromiumcodereview.appspot.com/23674004

git-svn-id: svn://svn.chromium.org/chrome/trunk/src@221399 0039d316-1c4b-4281-b951-d872f2087c98

chrome/browser/ui/cocoa/autofill/autofill_dialog_cocoa.h

@@ -25,8 +25,9 @@ namespace autofill {
 
 @class AutofillAccountChooser;
 @class AutofillDialogWindowController;
-@class AutofillSignInContainer;
 @class AutofillMainContainer;
+@class AutofillOverlayController;
+@class AutofillSignInContainer;
 
 namespace autofill {
 
@@ -110,6 +111,7 @@ class AutofillDialogCocoa : public AutofillDialogView,
   base::scoped_nsobject<AutofillMainContainer> mainContainer_;
   base::scoped_nsobject<AutofillSignInContainer> signInContainer_;
   base::scoped_nsobject<AutofillAccountChooser> accountChooser_;
+  base::scoped_nsobject<AutofillOverlayController> overlayController_;
   base::scoped_nsobject<NSTextField> loadingShieldTextField_;
 }
 
@@ -128,9 +130,11 @@ class AutofillDialogCocoa : public AutofillDialogView,
 - (IBAction)cancel:(id)sender;
 
 // Forwarding AutofillDialogView calls.
+- (void)show;
 - (void)hide;
 - (void)updateNotificationArea;
 - (void)updateAccountChooser;
+- (void)updateButtonStrip;
 - (void)updateSection:(autofill::DialogSection)section;
 - (void)fillSection:(autofill::DialogSection)section
            forInput:(const autofill::DetailInput&)input;

chrome/browser/ui/cocoa/autofill/autofill_dialog_cocoa.mm

@@ -17,6 +17,7 @@
 #import "chrome/browser/ui/cocoa/autofill/autofill_details_container.h"
 #include "chrome/browser/ui/cocoa/autofill/autofill_dialog_constants.h"
 #import "chrome/browser/ui/cocoa/autofill/autofill_main_container.h"
+#import "chrome/browser/ui/cocoa/autofill/autofill_overlay_controller.h"
 #import "chrome/browser/ui/cocoa/autofill/autofill_section_container.h"
 #import "chrome/browser/ui/cocoa/autofill/autofill_sign_in_container.h"
 #import "chrome/browser/ui/cocoa/constrained_window/constrained_window_custom_sheet.h"
@@ -63,6 +64,7 @@ void AutofillDialogCocoa::Show() {
           initWithCustomWindow:[sheet_delegate_ window]]);
   constrained_window_.reset(
       new ConstrainedWindowMac(this, delegate_->GetWebContents(), sheet));
+  [sheet_delegate_ show];
 }
 
 void AutofillDialogCocoa::Hide() {
@@ -95,6 +97,7 @@ void AutofillDialogCocoa::UpdateAccountChooser() {
 }
 
 void AutofillDialogCocoa::UpdateButtonStrip() {
+  [sheet_delegate_ updateButtonStrip];
 }
 
 void AutofillDialogCocoa::UpdateDetailArea() {
@@ -285,6 +288,11 @@ void AutofillDialogCocoa::OnConstrainedWindowClosed(
     [loadingShieldView setHidden:YES];
     [loadingShieldView addSubview:loadingShieldTextField_];
 
+    overlayController_.reset(
+        [[AutofillOverlayController alloc] initWithDelegate:
+            autofillDialog->delegate()]);
+    [[overlayController_ view] setHidden:YES];
+
     // This needs a flipped content view because otherwise the size
     // animation looks odd. However, replacing the contentView for constrained
     // windows does not work - it does custom rendering.
@@ -294,7 +302,8 @@ void AutofillDialogCocoa::OnConstrainedWindowClosed(
         @[accountChooser_,
           [mainContainer_ view],
           [signInContainer_ view],
-          loadingShieldView]];
+          loadingShieldView,
+          [overlayController_ view]]];
     [flippedContentView setAutoresizingMask:
         (NSViewWidthSizable | NSViewHeightSizable)];
     [[[self window] contentView] addSubview:flippedContentView];
@@ -306,17 +315,6 @@ void AutofillDialogCocoa::OnConstrainedWindowClosed(
     contentRect.size.height += NSHeight(headerRect) +
                                chrome_style::kClientBottomPadding +
                                chrome_style::kTitleTopPadding;
-    [self performLayout];
-
-    // Resizing the browser causes the ConstrainedWindow to move.
-    // Observe that to allow resizes based on browser size.
-    NSView* contentView = [[self window] contentView];
-    [contentView setPostsFrameChangedNotifications:YES];
-    [[NSNotificationCenter defaultCenter]
-        addObserver:self
-           selector:@selector(onContentViewFrameDidChange:)
-               name:NSWindowDidMoveNotification
-             object:[self window]];
   }
   return self;
 }
@@ -358,6 +356,16 @@ void AutofillDialogCocoa::OnConstrainedWindowClosed(
   dialogFrameRect = [[self window] contentRectForFrameRect:dialogFrameRect];
   size.height = std::min(NSHeight(dialogFrameRect), size.height);
 
+  if (![[overlayController_ view] isHidden]) {
+    CGFloat height = [overlayController_ heightForWidth:size.width];
+    // TODO(groby): This currently reserves size on top of the overlay image
+    // equivalent to the height of the header. Clarify with UX what the final
+    // padding will be.
+    if (height != 0.0) {
+      size.height = height + headerSize.height + kDetailTopPadding;
+    }
+  }
+
   return size;
 }
 
@@ -393,6 +401,9 @@ void AutofillDialogCocoa::OnConstrainedWindowClosed(
   [loadingShieldTextField_ setFrame:textFrame];
   [[loadingShieldTextField_ superview] setFrame:contentRect];
 
+  [[overlayController_ view] setFrame:contentRect];
+  [overlayController_ performLayout];
+
   NSRect frameRect = [[self window] frameRectForContentRect:contentRect];
   [[self window] setFrame:frameRect display:YES];
 }
@@ -407,6 +418,29 @@ void AutofillDialogCocoa::OnConstrainedWindowClosed(
   autofillDialog_->PerformClose();
 }
 
+- (void)show {
+  gfx::Image splashImage = autofillDialog_->delegate()->SplashPageImage();
+  if (!splashImage.IsEmpty()) {
+    autofill::DialogOverlayState state;
+    state.image = splashImage;
+    [overlayController_ setState:state];
+    [overlayController_ beginFadeOut];
+  }
+
+  // Resizing the browser causes the ConstrainedWindow to move.
+  // Observe that to allow resizes based on browser size.
+  // NOTE: This MUST come last after all initial setup is done, because there
+  // is an immediate notification post registration.
+  DCHECK([self window]);
+  [[NSNotificationCenter defaultCenter]
+      addObserver:self
+         selector:@selector(onContentViewFrameDidChange:)
+             name:NSWindowDidMoveNotification
+           object:[self window]];
+
+  [self requestRelayout];
+}
+
 - (void)hide {
   autofillDialog_->delegate()->OnCancel();
   autofillDialog_->PerformClose();
@@ -434,6 +468,10 @@ void AutofillDialogCocoa::OnConstrainedWindowClosed(
   }
 }
 
+- (void)updateButtonStrip {
+  [overlayController_ updateState];
+}
+
 - (void)updateSection:(autofill::DialogSection)section {
   [[mainContainer_ sectionForId:section] update];
 }

chrome/browser/ui/cocoa/autofill/autofill_overlay_controller.h

+// Copyright 2013 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.
+
+#ifndef CHROME_BROWSER_UI_COCOA_AUTOFILL_AUTOFILL_OVERLAY_CONTROLLER_H_
+#define CHROME_BROWSER_UI_COCOA_AUTOFILL_AUTOFILL_OVERLAY_CONTROLLER_H_
+
+#import <Cocoa/Cocoa.h>
+
+#include "base/mac/scoped_nsobject.h"
+#include "base/memory/scoped_ptr.h"
+#import "chrome/browser/ui/cocoa/autofill/autofill_layout.h"
+
+namespace autofill {
+class AutofillDialogViewDelegate;
+struct DialogOverlayState;
+}  // autofill
+
+namespace ui {
+class Animation;
+class MultiAnimation;
+}  // ui
+
+class AnimationDelegateBridge;
+class OverlayTimerBridge;
+
+@class AutofillMessageStackView;
+
+// Protocol that allows Cocoa objects to act as a delegate for a ui::Animation.
+@protocol AnimationDelegate
+- (void)animationProgressed:(const ui::Animation*)animation;
+- (void)animationEnded:(const ui::Animation*)animation;
+@end
+
+
+@interface AutofillOverlayController :
+    NSViewController<AnimationDelegate, AutofillLayout> {
+ @private
+  // |childView_| contains all overlay UI elements. This is used to fade out
+  // UI elements first, before making the main view transparent to fade out the
+  // overlay shield.
+  base::scoped_nsobject<NSView> childView_;
+  base::scoped_nsobject<NSImageView> imageView_;
+  base::scoped_nsobject<AutofillMessageStackView> messageStackView_;
+
+  scoped_ptr<ui::MultiAnimation> fadeOutAnimation_;  // Animation rules.
+  scoped_ptr<AnimationDelegateBridge> animationDelegate_;
+
+  // Timer to control refresh rate of the overlay's state.
+  scoped_ptr<OverlayTimerBridge> refreshTimer_;
+
+  autofill::AutofillDialogViewDelegate* delegate_;  // not owned, owns dialog.
+}
+
+// Designated initializer.
+- (id)initWithDelegate:(autofill::AutofillDialogViewDelegate*)delegate;
+
+// Updates the state from the dialog controller.
+- (void)updateState;
+
+// Sets a specific state for the overlay.
+- (void)setState:(const autofill::DialogOverlayState&)state;
+
+// Start the animation sequence. At its end, the dialog will hide itself.
+- (void)beginFadeOut;
+
+// Get the preferred view height for a given width.
+- (CGFloat)heightForWidth:(int)width;
+
+@end
+
+#endif  // CHROME_BROWSER_UI_COCOA_AUTOFILL_AUTOFILL_OVERLAY_CONTROLLER_H_
+

chrome/browser/ui/cocoa/autofill/autofill_overlay_controller_unittest.mm

+// Copyright 2013 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/autofill/autofill_overlay_controller.h"
+
+#include "base/mac/scoped_nsobject.h"
+#include "chrome/browser/ui/autofill/mock_autofill_dialog_view_delegate.h"
+#include "testing/gmock/include/gmock/gmock.h"
+#include "testing/gtest/include/gtest/gtest.h"
+#include "testing/gtest_mac.h"
+#import "ui/base/test/ui_cocoa_test_helper.h"
+
+namespace {
+
+class AutofillOverlayControllerTest : public ui::CocoaTest {
+ public:
+  virtual void SetUp() {
+    CocoaTest::SetUp();
+    controller_.reset(
+        [[AutofillOverlayController alloc] initWithDelegate:&delegate_]);
+    [[test_window() contentView] addSubview:[controller_ view]];
+  }
+
+ protected:
+  base::scoped_nsobject<AutofillOverlayController> controller_;
+  testing::NiceMock<autofill::MockAutofillDialogViewDelegate> delegate_;
+};
+
+}  // namespace
+
+TEST_VIEW(AutofillOverlayControllerTest, [controller_ view])
+
+TEST_F(AutofillOverlayControllerTest, Subviews) {
+  NSView* view = [controller_ view];
+  ASSERT_EQ(1U, [[view subviews] count]);
+
+  EXPECT_TRUE([view isKindOfClass:[NSBox class]]);
+  EXPECT_TRUE([[[view subviews] objectAtIndex:0] isMemberOfClass:
+          [NSView class]]);
+}

chrome/chrome_browser_ui.gypi

@@ -456,6 +456,8 @@
         'browser/ui/cocoa/autofill/autofill_notification_controller.mm',
         'browser/ui/cocoa/autofill/autofill_main_container.h',
         'browser/ui/cocoa/autofill/autofill_main_container.mm',
+        'browser/ui/cocoa/autofill/autofill_overlay_controller.h',
+        'browser/ui/cocoa/autofill/autofill_overlay_controller.mm',
         'browser/ui/cocoa/autofill/autofill_popup_view_bridge.h',
         'browser/ui/cocoa/autofill/autofill_popup_view_bridge.mm',
         'browser/ui/cocoa/autofill/autofill_popup_view_cocoa.h',

chrome/chrome_tests_unit.gypi

@@ -1408,6 +1408,7 @@
         'browser/ui/cocoa/autofill/autofill_main_container_unittest.mm',
         'browser/ui/cocoa/autofill/autofill_notification_container_unittest.mm',
         'browser/ui/cocoa/autofill/autofill_notification_controller_unittest.mm',
+        'browser/ui/cocoa/autofill/autofill_overlay_controller_unittest.mm',
         'browser/ui/cocoa/autofill/autofill_pop_up_button_unittest.mm',
         'browser/ui/cocoa/autofill/autofill_textfield_unittest.mm',
         'browser/ui/cocoa/autofill/autofill_section_container_unittest.mm',