chrome/browser/ui/views/exclusive_access_bubble_views.cc

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #include "chrome/browser/ui/views/exclusive_access_bubble_views.h"
   6
   7 #include "base/message_loop/message_loop.h"
   8 #include "base/strings/utf_string_conversions.h"
   9 #include "chrome/app/chrome_command_ids.h"
  10 #include "chrome/browser/chrome_notification_types.h"
  11 #include "chrome/browser/ui/exclusive_access/exclusive_access_manager.h"
  12 #include "chrome/browser/ui/exclusive_access/fullscreen_controller.h"
  13 #include "chrome/browser/ui/views/frame/browser_view.h"
  14 #include "chrome/browser/ui/views/frame/immersive_mode_controller.h"
  15 #include "chrome/browser/ui/views/frame/top_container_view.h"
  16 #include "chrome/grit/generated_resources.h"
  17 #include "content/public/browser/notification_service.h"
  18 #include "ui/base/l10n/l10n_util.h"
  19 #include "ui/base/resource/resource_bundle.h"
  20 #include "ui/events/keycodes/keyboard_codes.h"
  21 #include "ui/gfx/animation/slide_animation.h"
  22 #include "ui/gfx/canvas.h"
  23 #include "ui/gfx/screen.h"
  24 #include "ui/strings/grit/ui_strings.h"
  25 #include "ui/views/bubble/bubble_border.h"
  26 #include "ui/views/controls/button/label_button.h"
  27 #include "ui/views/controls/link.h"
  28 #include "ui/views/controls/link_listener.h"
  29 #include "ui/views/layout/box_layout.h"
  30 #include "ui/views/layout/grid_layout.h"
  31 #include "ui/views/view.h"
  32 #include "ui/views/widget/widget.h"
  33 #include "url/gurl.h"
  34
  35 #if defined(OS_WIN)
  36 #include "ui/base/l10n/l10n_util_win.h"
  37 #endif
  38
  39 // ExclusiveAccessView ---------------------------------------------------------
  40
  41 namespace {
  42
  43 // Space between the site info label and the buttons / link.
  44 const int kMiddlePaddingPx = 30;
  45
  46 class ButtonView : public views::View {
  47  public:
  48   ButtonView(views::ButtonListener* listener, int between_button_spacing);
  49   ~ButtonView() override;
  50
  51   // Returns an empty size when the view is not visible.
  52   gfx::Size GetPreferredSize() const override;
  53
  54   views::LabelButton* accept_button() const { return accept_button_; }
  55   views::LabelButton* deny_button() const { return deny_button_; }
  56
  57  private:
  58   views::LabelButton* accept_button_;
  59   views::LabelButton* deny_button_;
  60
  61   DISALLOW_COPY_AND_ASSIGN(ButtonView);
  62 };
  63
  64 ButtonView::ButtonView(views::ButtonListener* listener,
  65                        int between_button_spacing)
  66     : accept_button_(NULL), deny_button_(NULL) {
  67   accept_button_ = new views::LabelButton(listener, base::string16());
  68   accept_button_->SetStyle(views::Button::STYLE_BUTTON);
  69   accept_button_->SetFocusable(false);
  70   AddChildView(accept_button_);
  71
  72   deny_button_ = new views::LabelButton(listener, base::string16());
  73   deny_button_->SetStyle(views::Button::STYLE_BUTTON);
  74   deny_button_->SetFocusable(false);
  75   AddChildView(deny_button_);
  76
  77   SetLayoutManager(new views::BoxLayout(views::BoxLayout::kHorizontal, 0, 0,
  78                                         between_button_spacing));
  79 }
  80
  81 ButtonView::~ButtonView() {
  82 }
  83
  84 gfx::Size ButtonView::GetPreferredSize() const {
  85   return visible() ? views::View::GetPreferredSize() : gfx::Size();
  86 }
  87
  88 }  // namespace
  89
  90 class ExclusiveAccessBubbleViews::ExclusiveAccessView
  91     : public views::View,
  92       public views::ButtonListener,
  93       public views::LinkListener {
  94  public:
  95   ExclusiveAccessView(ExclusiveAccessBubbleViews* bubble,
  96                       const base::string16& accelerator,
  97                       const GURL& url,
  98                       ExclusiveAccessBubbleType bubble_type);
  99   ~ExclusiveAccessView() override;
 100
 101   // views::ButtonListener
 102   void ButtonPressed(views::Button* sender, const ui::Event& event) override;
 103
 104   // views::LinkListener
 105   void LinkClicked(views::Link* source, int event_flags) override;
 106
 107   void UpdateContent(const GURL& url, ExclusiveAccessBubbleType bubble_type);
 108
 109  private:
 110   ExclusiveAccessBubbleViews* bubble_;
 111
 112   // Clickable hint text for exiting fullscreen mode.
 113   views::Link* link_;
 114   // Instruction for exiting mouse lock.
 115   views::Label* mouse_lock_exit_instruction_;
 116   // Informational label: 'www.foo.com has gone fullscreen'.
 117   views::Label* message_label_;
 118   ButtonView* button_view_;
 119   const base::string16 browser_fullscreen_exit_accelerator_;
 120
 121   DISALLOW_COPY_AND_ASSIGN(ExclusiveAccessView);
 122 };
 123
 124 ExclusiveAccessBubbleViews::ExclusiveAccessView::ExclusiveAccessView(
 125     ExclusiveAccessBubbleViews* bubble,
 126     const base::string16& accelerator,
 127     const GURL& url,
 128     ExclusiveAccessBubbleType bubble_type)
 129     : bubble_(bubble),
 130       link_(NULL),
 131       mouse_lock_exit_instruction_(NULL),
 132       message_label_(NULL),
 133       button_view_(NULL),
 134       browser_fullscreen_exit_accelerator_(accelerator) {
 135   scoped_ptr<views::BubbleBorder> bubble_border(
 136       new views::BubbleBorder(views::BubbleBorder::NONE,
 137                               views::BubbleBorder::BIG_SHADOW, SK_ColorWHITE));
 138   set_background(new views::BubbleBackground(bubble_border.get()));
 139   SetBorder(bubble_border.Pass());
 140   SetFocusable(false);
 141
 142   ui::ResourceBundle& rb = ui::ResourceBundle::GetSharedInstance();
 143   const gfx::FontList& medium_font_list =
 144       rb.GetFontList(ui::ResourceBundle::MediumFont);
 145   message_label_ = new views::Label(base::string16(), medium_font_list);
 146
 147   mouse_lock_exit_instruction_ =
 148       new views::Label(bubble_->GetInstructionText(), medium_font_list);
 149   mouse_lock_exit_instruction_->set_collapse_when_hidden(true);
 150
 151   link_ = new views::Link();
 152   link_->set_collapse_when_hidden(true);
 153   link_->SetFocusable(false);
 154 #if defined(OS_CHROMEOS)
 155   // On CrOS, the link text doesn't change, since it doesn't show the shortcut.
 156   link_->SetText(l10n_util::GetStringUTF16(IDS_EXIT_FULLSCREEN_MODE));
 157 #endif
 158   link_->set_listener(this);
 159   link_->SetFontList(medium_font_list);
 160   link_->SetPressedColor(message_label_->enabled_color());
 161   link_->SetEnabledColor(message_label_->enabled_color());
 162   link_->SetVisible(false);
 163
 164   link_->SetBackgroundColor(background()->get_color());
 165   message_label_->SetBackgroundColor(background()->get_color());
 166   mouse_lock_exit_instruction_->SetBackgroundColor(background()->get_color());
 167
 168   button_view_ = new ButtonView(this, kPaddingPx);
 169
 170   views::GridLayout* layout = new views::GridLayout(this);
 171   views::ColumnSet* columns = layout->AddColumnSet(0);
 172   columns->AddColumn(views::GridLayout::LEADING, views::GridLayout::CENTER, 0,
 173                      views::GridLayout::USE_PREF, 0, 0);
 174   columns->AddPaddingColumn(1, kMiddlePaddingPx);
 175   columns->AddColumn(views::GridLayout::LEADING, views::GridLayout::CENTER, 0,
 176                      views::GridLayout::USE_PREF, 0, 0);
 177   columns->AddColumn(views::GridLayout::LEADING, views::GridLayout::CENTER, 0,
 178                      views::GridLayout::USE_PREF, 0, 0);
 179   columns->AddColumn(views::GridLayout::LEADING, views::GridLayout::CENTER, 0,
 180                      views::GridLayout::USE_PREF, 0, 0);
 181
 182   layout->StartRow(0, 0);
 183   layout->AddView(message_label_);
 184   layout->AddView(button_view_);
 185   layout->AddView(mouse_lock_exit_instruction_);
 186   layout->AddView(link_);
 187
 188   gfx::Insets padding(kPaddingPx, kPaddingPx, kPaddingPx, kPaddingPx);
 189   padding += GetInsets();
 190   layout->SetInsets(padding);
 191   SetLayoutManager(layout);
 192
 193   UpdateContent(url, bubble_type);
 194 }
 195
 196 ExclusiveAccessBubbleViews::ExclusiveAccessView::~ExclusiveAccessView() {
 197 }
 198
 199 void ExclusiveAccessBubbleViews::ExclusiveAccessView::ButtonPressed(
 200     views::Button* sender,
 201     const ui::Event& event) {
 202   if (sender == button_view_->accept_button())
 203     bubble_->Accept();
 204   else
 205     bubble_->Cancel();
 206 }
 207
 208 void ExclusiveAccessBubbleViews::ExclusiveAccessView::LinkClicked(
 209     views::Link* link,
 210     int event_flags) {
 211   bubble_->ToggleFullscreen();
 212 }
 213
 214 void ExclusiveAccessBubbleViews::ExclusiveAccessView::UpdateContent(
 215     const GURL& url,
 216     ExclusiveAccessBubbleType bubble_type) {
 217   DCHECK_NE(EXCLUSIVE_ACCESS_BUBBLE_TYPE_NONE, bubble_type);
 218
 219   message_label_->SetText(bubble_->GetCurrentMessageText());
 220   if (exclusive_access_bubble::ShowButtonsForType(bubble_type)) {
 221     link_->SetVisible(false);
 222     mouse_lock_exit_instruction_->SetVisible(false);
 223     button_view_->SetVisible(true);
 224     button_view_->deny_button()->SetText(bubble_->GetCurrentDenyButtonText());
 225     button_view_->deny_button()->SetMinSize(gfx::Size());
 226     button_view_->accept_button()->SetText(
 227         bubble_->GetCurrentAllowButtonText());
 228     button_view_->accept_button()->SetMinSize(gfx::Size());
 229   } else {
 230     bool link_visible = true;
 231     base::string16 accelerator;
 232     if (bubble_type ==
 233             EXCLUSIVE_ACCESS_BUBBLE_TYPE_BROWSER_FULLSCREEN_EXIT_INSTRUCTION ||
 234         bubble_type ==
 235             EXCLUSIVE_ACCESS_BUBBLE_TYPE_EXTENSION_FULLSCREEN_EXIT_INSTRUCTION) {
 236       accelerator = browser_fullscreen_exit_accelerator_;
 237     } else if (bubble_type ==
 238                EXCLUSIVE_ACCESS_BUBBLE_TYPE_FULLSCREEN_EXIT_INSTRUCTION) {
 239       accelerator = l10n_util::GetStringUTF16(IDS_APP_ESC_KEY);
 240     } else {
 241       link_visible = false;
 242     }
 243 #if !defined(OS_CHROMEOS)
 244     if (link_visible) {
 245       link_->SetText(l10n_util::GetStringUTF16(IDS_EXIT_FULLSCREEN_MODE) +
 246                      base::UTF8ToUTF16(" ") +
 247                      l10n_util::GetStringFUTF16(
 248                          IDS_EXIT_FULLSCREEN_MODE_ACCELERATOR, accelerator));
 249     }
 250 #endif
 251     link_->SetVisible(link_visible);
 252     mouse_lock_exit_instruction_->SetVisible(!link_visible);
 253     button_view_->SetVisible(false);
 254   }
 255 }
 256
 257 // ExclusiveAccessBubbleViews --------------------------------------------------
 258
 259 ExclusiveAccessBubbleViews::ExclusiveAccessBubbleViews(
 260     BrowserView* browser_view,
 261     const GURL& url,
 262     ExclusiveAccessBubbleType bubble_type)
 263     : ExclusiveAccessBubble(browser_view->browser(), url, bubble_type),
 264       browser_view_(browser_view),
 265       popup_(NULL),
 266       animation_(new gfx::SlideAnimation(this)),
 267       animated_attribute_(ANIMATED_ATTRIBUTE_BOUNDS) {
 268   animation_->Reset(1);
 269
 270   // Create the contents view.
 271   ui::Accelerator accelerator(ui::VKEY_UNKNOWN, ui::EF_NONE);
 272   bool got_accelerator =
 273       browser_view_->GetWidget()->GetAccelerator(IDC_FULLSCREEN, &accelerator);
 274   DCHECK(got_accelerator);
 275   view_ = new ExclusiveAccessView(this, accelerator.GetShortcutText(), url,
 276                                   bubble_type_);
 277
 278   // TODO(yzshen): Change to use the new views bubble, BubbleDelegateView.
 279   // TODO(pkotwicz): When this becomes a views bubble, make sure that this
 280   // bubble is ignored by ImmersiveModeControllerAsh::BubbleManager.
 281   // Initialize the popup.
 282   popup_ = new views::Widget;
 283   views::Widget::InitParams params(views::Widget::InitParams::TYPE_POPUP);
 284   params.opacity = views::Widget::InitParams::TRANSLUCENT_WINDOW;
 285   params.ownership = views::Widget::InitParams::WIDGET_OWNS_NATIVE_WIDGET;
 286   params.parent = browser_view_->GetWidget()->GetNativeView();
 287   params.bounds = GetPopupRect(false);
 288   popup_->Init(params);
 289   gfx::Size size = GetPopupRect(true).size();
 290   popup_->SetContentsView(view_);
 291   // We set layout manager to NULL to prevent the widget from sizing its
 292   // contents to the same size as itself. This prevents the widget contents from
 293   // shrinking while we animate the height of the popup to give the impression
 294   // that it is sliding off the top of the screen.
 295   popup_->GetRootView()->SetLayoutManager(NULL);
 296   view_->SetBounds(0, 0, size.width(), size.height());
 297   popup_->ShowInactive();  // This does not activate the popup.
 298
 299   popup_->AddObserver(this);
 300
 301   registrar_.Add(
 302       this, chrome::NOTIFICATION_FULLSCREEN_CHANGED,
 303       content::Source<FullscreenController>(browser_view_->browser()
 304                                                 ->exclusive_access_manager()
 305                                                 ->fullscreen_controller()));
 306
 307   UpdateForImmersiveState();
 308 }
 309
 310 ExclusiveAccessBubbleViews::~ExclusiveAccessBubbleViews() {
 311   popup_->RemoveObserver(this);
 312
 313   // This is tricky.  We may be in an ATL message handler stack, in which case
 314   // the popup cannot be deleted yet.  We also can't set the popup's ownership
 315   // model to NATIVE_WIDGET_OWNS_WIDGET because if the user closed the last tab
 316   // while in fullscreen mode, Windows has already destroyed the popup HWND by
 317   // the time we get here, and thus either the popup will already have been
 318   // deleted (if we set this in our constructor) or the popup will never get
 319   // another OnFinalMessage() call (if not, as currently).  So instead, we tell
 320   // the popup to synchronously hide, and then asynchronously close and delete
 321   // itself.
 322   popup_->Close();
 323   base::MessageLoop::current()->DeleteSoon(FROM_HERE, popup_);
 324 }
 325
 326 void ExclusiveAccessBubbleViews::UpdateContent(
 327     const GURL& url,
 328     ExclusiveAccessBubbleType bubble_type) {
 329   DCHECK_NE(EXCLUSIVE_ACCESS_BUBBLE_TYPE_NONE, bubble_type);
 330   if (bubble_type_ == bubble_type && url_ == url)
 331     return;
 332
 333   url_ = url;
 334   bubble_type_ = bubble_type;
 335   view_->UpdateContent(url_, bubble_type_);
 336
 337   gfx::Size size = GetPopupRect(true).size();
 338   view_->SetSize(size);
 339   popup_->SetBounds(GetPopupRect(false));
 340   Show();
 341
 342   // Stop watching the mouse even if UpdateMouseWatcher() will start watching
 343   // it again so that the popup with the new content is visible for at least
 344   // |kInitialDelayMs|.
 345   StopWatchingMouse();
 346
 347   UpdateMouseWatcher();
 348 }
 349
 350 void ExclusiveAccessBubbleViews::RepositionIfVisible() {
 351   if (popup_->IsVisible())
 352     UpdateBounds();
 353 }
 354
 355 void ExclusiveAccessBubbleViews::UpdateMouseWatcher() {
 356   bool should_watch_mouse = false;
 357   if (popup_->IsVisible())
 358     should_watch_mouse =
 359         !exclusive_access_bubble::ShowButtonsForType(bubble_type_);
 360   else
 361     should_watch_mouse = CanMouseTriggerSlideIn();
 362
 363   if (should_watch_mouse == IsWatchingMouse())
 364     return;
 365
 366   if (should_watch_mouse)
 367     StartWatchingMouse();
 368   else
 369     StopWatchingMouse();
 370 }
 371
 372 void ExclusiveAccessBubbleViews::UpdateForImmersiveState() {
 373   AnimatedAttribute expected_animated_attribute =
 374       browser_view_->immersive_mode_controller()->IsEnabled()
 375           ? ANIMATED_ATTRIBUTE_OPACITY
 376           : ANIMATED_ATTRIBUTE_BOUNDS;
 377   if (animated_attribute_ != expected_animated_attribute) {
 378     // If an animation is currently in progress, skip to the end because
 379     // switching the animated attribute midway through the animation looks
 380     // weird.
 381     animation_->End();
 382
 383     animated_attribute_ = expected_animated_attribute;
 384
 385     // We may have finished hiding |popup_|. However, the bounds animation
 386     // assumes |popup_| has the opacity when it is fully shown and the opacity
 387     // animation assumes |popup_| has the bounds when |popup_| is fully shown.
 388     if (animated_attribute_ == ANIMATED_ATTRIBUTE_BOUNDS)
 389       popup_->SetOpacity(255);
 390     else
 391       UpdateBounds();
 392   }
 393
 394   UpdateMouseWatcher();
 395 }
 396
 397 void ExclusiveAccessBubbleViews::UpdateBounds() {
 398   gfx::Rect popup_rect(GetPopupRect(false));
 399   if (!popup_rect.IsEmpty()) {
 400     popup_->SetBounds(popup_rect);
 401     view_->SetY(popup_rect.height() - view_->height());
 402   }
 403 }
 404
 405 views::View* ExclusiveAccessBubbleViews::GetBrowserRootView() const {
 406   return browser_view_->GetWidget()->GetRootView();
 407 }
 408
 409 void ExclusiveAccessBubbleViews::AnimationProgressed(
 410     const gfx::Animation* animation) {
 411   if (animated_attribute_ == ANIMATED_ATTRIBUTE_OPACITY) {
 412     int opacity = animation_->CurrentValueBetween(0, 255);
 413     if (opacity == 0) {
 414       popup_->Hide();
 415     } else {
 416       popup_->Show();
 417       popup_->SetOpacity(opacity);
 418     }
 419   } else {
 420     if (GetPopupRect(false).IsEmpty()) {
 421       popup_->Hide();
 422     } else {
 423       UpdateBounds();
 424       popup_->Show();
 425     }
 426   }
 427 }
 428
 429 void ExclusiveAccessBubbleViews::AnimationEnded(
 430     const gfx::Animation* animation) {
 431   AnimationProgressed(animation);
 432 }
 433
 434 gfx::Rect ExclusiveAccessBubbleViews::GetPopupRect(
 435     bool ignore_animation_state) const {
 436   gfx::Size size(view_->GetPreferredSize());
 437   // NOTE: don't use the bounds of the root_view_. On linux GTK changing window
 438   // size is async. Instead we use the size of the screen.
 439   gfx::Screen* screen =
 440       gfx::Screen::GetScreenFor(browser_view_->GetWidget()->GetNativeView());
 441   gfx::Rect screen_bounds =
 442       screen->GetDisplayNearestWindow(
 443                   browser_view_->GetWidget()->GetNativeView()).bounds();
 444   int x = screen_bounds.x() + (screen_bounds.width() - size.width()) / 2;
 445
 446   int top_container_bottom = screen_bounds.y();
 447   if (browser_view_->immersive_mode_controller()->IsEnabled()) {
 448     // Skip querying the top container height in non-immersive fullscreen
 449     // because:
 450     // - The top container height is always zero in non-immersive fullscreen.
 451     // - Querying the top container height may return the height before entering
 452     //   fullscreen because layout is disabled while entering fullscreen.
 453     // A visual glitch due to the delayed layout is avoided in immersive
 454     // fullscreen because entering fullscreen starts with the top container
 455     // revealed. When revealed, the top container has the same height as before
 456     // entering fullscreen.
 457     top_container_bottom =
 458         browser_view_->top_container()->GetBoundsInScreen().bottom();
 459   }
 460   int y = top_container_bottom + kPopupTopPx;
 461
 462   if (!ignore_animation_state &&
 463       animated_attribute_ == ANIMATED_ATTRIBUTE_BOUNDS) {
 464     int total_height = size.height() + kPopupTopPx;
 465     int popup_bottom = animation_->CurrentValueBetween(total_height, 0);
 466     int y_offset = std::min(popup_bottom, kPopupTopPx);
 467     size.set_height(size.height() - popup_bottom + y_offset);
 468     y -= y_offset;
 469   }
 470   return gfx::Rect(gfx::Point(x, y), size);
 471 }
 472
 473 gfx::Point ExclusiveAccessBubbleViews::GetCursorScreenPoint() {
 474   gfx::Point cursor_pos =
 475       gfx::Screen::GetScreenFor(browser_view_->GetWidget()->GetNativeView())
 476           ->GetCursorScreenPoint();
 477   views::View::ConvertPointFromScreen(GetBrowserRootView(), &cursor_pos);
 478   return cursor_pos;
 479 }
 480
 481 bool ExclusiveAccessBubbleViews::WindowContainsPoint(gfx::Point pos) {
 482   return GetBrowserRootView()->HitTestPoint(pos);
 483 }
 484
 485 bool ExclusiveAccessBubbleViews::IsWindowActive() {
 486   return browser_view_->GetWidget()->IsActive();
 487 }
 488
 489 void ExclusiveAccessBubbleViews::Hide() {
 490   animation_->SetSlideDuration(kSlideOutDurationMs);
 491   animation_->Hide();
 492 }
 493
 494 void ExclusiveAccessBubbleViews::Show() {
 495   animation_->SetSlideDuration(kSlideInDurationMs);
 496   animation_->Show();
 497 }
 498
 499 bool ExclusiveAccessBubbleViews::IsAnimating() {
 500   return animation_->is_animating();
 501 }
 502
 503 bool ExclusiveAccessBubbleViews::CanMouseTriggerSlideIn() const {
 504   return !browser_view_->immersive_mode_controller()->IsEnabled();
 505 }
 506
 507 void ExclusiveAccessBubbleViews::Observe(
 508     int type,
 509     const content::NotificationSource& source,
 510     const content::NotificationDetails& details) {
 511   DCHECK_EQ(chrome::NOTIFICATION_FULLSCREEN_CHANGED, type);
 512   UpdateForImmersiveState();
 513 }
 514
 515 void ExclusiveAccessBubbleViews::OnWidgetVisibilityChanged(
 516     views::Widget* widget,
 517     bool visible) {
 518   UpdateMouseWatcher();
 519 }