ash/common/system/toast/toast_overlay.cc - chromium/src - Git at Google

 // 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.

 #include "ash/common/system/toast/toast_overlay.h"

 #include "ash/common/shelf/wm_shelf.h"
 #include "ash/common/wm_lookup.h"
 #include "ash/common/wm_root_window_controller.h"
 #include "ash/common/wm_shell.h"
 #include "ash/common/wm_window.h"
 #include "ash/public/cpp/shell_window_ids.h"
 #include "base/strings/string_util.h"
 #include "base/strings/utf_string_conversions.h"
 #include "base/threading/thread_task_runner_handle.h"
 #include "grit/ash_strings.h"
 #include "third_party/skia/include/core/SkColor.h"
 #include "ui/base/l10n/l10n_util.h"
 #include "ui/base/resource/resource_bundle.h"
 #include "ui/gfx/canvas.h"
 #include "ui/gfx/font_list.h"
 #include "ui/views/border.h"
 #include "ui/views/controls/button/label_button.h"
 #include "ui/views/controls/label.h"
 #include "ui/views/layout/box_layout.h"
 #include "ui/views/view.h"
 #include "ui/views/widget/widget.h"
 #include "ui/views/widget/widget_delegate.h"
 #include "ui/wm/core/window_animations.h"

 namespace ash {

 namespace {

 // Offset of the overlay from the edge of the work area.
 const int kOffset = 5;

 // Font style used for modifier key labels.
 const ui::ResourceBundle::FontStyle kTextFontStyle =
     ui::ResourceBundle::MediumFont;

 // Duration of slide animation when overlay is shown or hidden.
 const int kSlideAnimationDurationMs = 100;

 // Colors for the dismiss button.
 const SkColor kButtonBackgroundColor = SkColorSetARGB(0xFF, 0x32, 0x32, 0x32);
 const SkColor kButtonTextColor = SkColorSetARGB(0xFF, 0x7B, 0xAA, 0xF7);

 // These values are in DIP.
 const int kToastHorizontalSpacing = 16;
 const int kToastVerticalSpacing = 16;
 const int kToastMaximumWidth = 568;
 const int kToastMinimumWidth = 288;

 // Returns the work area bounds for the root window where new windows are added
 // (including new toasts).
 gfx::Rect GetUserWorkAreaBounds() {
   return WmShelf::ForWindow(WmShell::Get()->GetRootWindowForNewWindows())
       ->GetUserWorkAreaBounds();
 }

 }  // anonymous namespace

 ///////////////////////////////////////////////////////////////////////////////
 //  ToastOverlayLabel
 class ToastOverlayLabel : public views::Label {
  public:
   explicit ToastOverlayLabel(const base::string16& label);
   ~ToastOverlayLabel() override;

  private:
   DISALLOW_COPY_AND_ASSIGN(ToastOverlayLabel);
 };

 ToastOverlayLabel::ToastOverlayLabel(const base::string16& label) {
   ui::ResourceBundle* rb = &ui::ResourceBundle::GetSharedInstance();

   SetText(label);
   SetHorizontalAlignment(gfx::ALIGN_LEFT);
   SetFontList(rb->GetFontList(kTextFontStyle));
   SetAutoColorReadabilityEnabled(false);
   SetMultiLine(true);
   SetEnabledColor(SK_ColorWHITE);
   SetDisabledColor(SK_ColorWHITE);
   SetSubpixelRenderingEnabled(false);

   int verticalSpacing =
       kToastVerticalSpacing - (GetPreferredSize().height() - GetBaseline());
   SetBorder(views::CreateEmptyBorder(verticalSpacing, kToastHorizontalSpacing,
                                      verticalSpacing, kToastHorizontalSpacing));
 }

 ToastOverlayLabel::~ToastOverlayLabel() {}

 ///////////////////////////////////////////////////////////////////////////////
 //  ToastOverlayButton
 class ToastOverlayButton : public views::LabelButton {
  public:
   explicit ToastOverlayButton(views::ButtonListener* listener,
                               const base::string16& label);
   ~ToastOverlayButton() override {}

  private:
   friend class ToastOverlay;  // for ToastOverlay::ClickDismissButtonForTesting.

   DISALLOW_COPY_AND_ASSIGN(ToastOverlayButton);
 };

 ToastOverlayButton::ToastOverlayButton(views::ButtonListener* listener,
                                        const base::string16& text)
     : views::LabelButton(listener, text) {
   SetInkDropMode(InkDropMode::ON);
   set_has_ink_drop_action_on_click(true);
   set_ink_drop_base_color(SK_ColorWHITE);

   ui::ResourceBundle* rb = &ui::ResourceBundle::GetSharedInstance();

   SetEnabledTextColors(kButtonTextColor);
   SetFontList(rb->GetFontList(kTextFontStyle));

   // Treat the space below the baseline as a margin.
   int verticalSpacing = kToastVerticalSpacing -
                         (GetPreferredSize().height() - label()->GetBaseline());
   SetBorder(views::CreateEmptyBorder(verticalSpacing, kToastHorizontalSpacing,
                                      verticalSpacing, kToastHorizontalSpacing));
 }

 ///////////////////////////////////////////////////////////////////////////////
 //  ToastOverlayView
 class ToastOverlayView : public views::View, public views::ButtonListener {
  public:
   // This object is not owned by the views hiearchy or by the widget.
   ToastOverlayView(ToastOverlay* overlay,
                    const base::string16& text,
                    const base::string16& dismiss_text);
   ~ToastOverlayView() override;

   // views::View overrides:
   void OnPaint(gfx::Canvas* canvas) override;

   ToastOverlayButton* button() { return button_; }

  private:
   ToastOverlay* overlay_;       // weak
   ToastOverlayButton* button_;  // weak

   gfx::Size GetMaximumSize() const override;
   gfx::Size GetMinimumSize() const override;

   void ButtonPressed(views::Button* sender, const ui::Event& event) override;

   DISALLOW_COPY_AND_ASSIGN(ToastOverlayView);
 };

 ToastOverlayView::ToastOverlayView(ToastOverlay* overlay,
                                    const base::string16& text,
                                    const base::string16& dismiss_text)
     : overlay_(overlay),
       button_(new ToastOverlayButton(
           this,
           dismiss_text.empty()
               ? l10n_util::GetStringUTF16(IDS_ASH_TOAST_DISMISS_BUTTON)
               : dismiss_text)) {
   ToastOverlayLabel* label = new ToastOverlayLabel(text);
   label->SetMaximumWidth(
       GetMaximumSize().width() - button_->GetPreferredSize().width() -
       kToastHorizontalSpacing * 2 - kToastHorizontalSpacing * 2);
   AddChildView(label);

   AddChildView(button_);

   auto* layout = new views::BoxLayout(views::BoxLayout::kHorizontal, 0, 0, 0);
   SetLayoutManager(layout);
   layout->SetFlexForView(label, 1);
   layout->SetFlexForView(button_, 0);
 }

 ToastOverlayView::~ToastOverlayView() {}

 void ToastOverlayView::OnPaint(gfx::Canvas* canvas) {
   SkPaint paint;
   paint.setStyle(SkPaint::kFill_Style);
   paint.setColor(kButtonBackgroundColor);
   canvas->DrawRoundRect(GetLocalBounds(), 2, paint);
   views::View::OnPaint(canvas);
 }

 gfx::Size ToastOverlayView::GetMinimumSize() const {
   return gfx::Size(kToastMinimumWidth, 0);
 }

 gfx::Size ToastOverlayView::GetMaximumSize() const {
   gfx::Rect work_area_bounds = GetUserWorkAreaBounds();
   return gfx::Size(kToastMaximumWidth, work_area_bounds.height() - kOffset * 2);
 }

 void ToastOverlayView::ButtonPressed(views::Button* sender,
                                      const ui::Event& event) {
   overlay_->Show(false);
 }

 ///////////////////////////////////////////////////////////////////////////////
 //  ToastOverlay
 ToastOverlay::ToastOverlay(Delegate* delegate,
                            const base::string16& text,
                            const base::string16& dismiss_text)
     : delegate_(delegate),
       text_(text),
       dismiss_text_(dismiss_text),
       overlay_widget_(new views::Widget),
       overlay_view_(new ToastOverlayView(this, text, dismiss_text)),
       widget_size_(overlay_view_->GetPreferredSize()) {
   views::Widget::InitParams params;
   params.type = views::Widget::InitParams::TYPE_POPUP;
   params.name = "ToastOverlay";
   params.opacity = views::Widget::InitParams::TRANSLUCENT_WINDOW;
   params.ownership = views::Widget::InitParams::WIDGET_OWNS_NATIVE_WIDGET;
   params.accept_events = true;
   params.keep_on_top = true;
   params.remove_standard_frame = true;
   params.bounds = CalculateOverlayBounds();
   // Show toasts above the app list and below the lock screen.
   WmShell::Get()
       ->GetRootWindowForNewWindows()
       ->GetRootWindowController()
       ->ConfigureWidgetInitParamsForContainer(
           overlay_widget_.get(), kShellWindowId_SystemModalContainer, &params);
   overlay_widget_->Init(params);
   overlay_widget_->SetVisibilityChangedAnimationsEnabled(true);
   overlay_widget_->SetContentsView(overlay_view_.get());
   overlay_widget_->SetBounds(CalculateOverlayBounds());

   WmWindow* overlay_window =
       WmLookup::Get()->GetWindowForWidget(overlay_widget_.get());
   overlay_window->SetVisibilityAnimationType(
       ::wm::WINDOW_VISIBILITY_ANIMATION_TYPE_VERTICAL);
   overlay_window->SetVisibilityAnimationDuration(
       base::TimeDelta::FromMilliseconds(kSlideAnimationDurationMs));
 }

 ToastOverlay::~ToastOverlay() {
   overlay_widget_->Close();
 }

 void ToastOverlay::Show(bool visible) {
   if (overlay_widget_->GetLayer()->GetTargetVisibility() == visible)
     return;

   ui::LayerAnimator* animator = overlay_widget_->GetLayer()->GetAnimator();
   DCHECK(animator);
   if (animator->is_animating()) {
     // Showing during hiding animation doesn't happen since, ToastOverlay should
     // be one-time-use and not be reused.
     DCHECK(!visible);

     return;
   }

   base::TimeDelta original_duration = animator->GetTransitionDuration();
   ui::ScopedLayerAnimationSettings animation_settings(animator);
   // ScopedLayerAnimationSettings ctor chanes the transition duration, so change
   // back it to the original value (should be zero).
   animation_settings.SetTransitionDuration(original_duration);

   animation_settings.AddObserver(this);

   if (visible) {
     overlay_widget_->Show();

     // Notify accessibility about the overlay.
     overlay_view_->NotifyAccessibilityEvent(ui::AX_EVENT_ALERT, false);
   } else {
     overlay_widget_->Hide();
   }
 }

 gfx::Rect ToastOverlay::CalculateOverlayBounds() {
   gfx::Rect bounds = GetUserWorkAreaBounds();
   int target_y = bounds.bottom() - widget_size_.height() - kOffset;
   bounds.ClampToCenteredSize(widget_size_);
   bounds.set_y(target_y);
   return bounds;
 }

 void ToastOverlay::OnImplicitAnimationsScheduled() {}

 void ToastOverlay::OnImplicitAnimationsCompleted() {
   if (!overlay_widget_->GetLayer()->GetTargetVisibility())
     delegate_->OnClosed();
 }

 views::Widget* ToastOverlay::widget_for_testing() {
   return overlay_widget_.get();
 }

 void ToastOverlay::ClickDismissButtonForTesting(const ui::Event& event) {
   overlay_view_->button()->NotifyClick(event);
 }

 }  // namespace ash
	// 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.

	#include "ash/common/system/toast/toast_overlay.h"

	#include "ash/common/shelf/wm_shelf.h"
	#include "ash/common/wm_lookup.h"
	#include "ash/common/wm_root_window_controller.h"
	#include "ash/common/wm_shell.h"
	#include "ash/common/wm_window.h"
	#include "ash/public/cpp/shell_window_ids.h"
	#include "base/strings/string_util.h"
	#include "base/strings/utf_string_conversions.h"
	#include "base/threading/thread_task_runner_handle.h"
	#include "grit/ash_strings.h"
	#include "third_party/skia/include/core/SkColor.h"
	#include "ui/base/l10n/l10n_util.h"
	#include "ui/base/resource/resource_bundle.h"
	#include "ui/gfx/canvas.h"
	#include "ui/gfx/font_list.h"
	#include "ui/views/border.h"
	#include "ui/views/controls/button/label_button.h"
	#include "ui/views/controls/label.h"
	#include "ui/views/layout/box_layout.h"
	#include "ui/views/view.h"
	#include "ui/views/widget/widget.h"
	#include "ui/views/widget/widget_delegate.h"
	#include "ui/wm/core/window_animations.h"

	namespace ash {

	namespace {

	// Offset of the overlay from the edge of the work area.
	const int kOffset = 5;

	// Font style used for modifier key labels.
	const ui::ResourceBundle::FontStyle kTextFontStyle =
	ui::ResourceBundle::MediumFont;

	// Duration of slide animation when overlay is shown or hidden.
	const int kSlideAnimationDurationMs = 100;

	// Colors for the dismiss button.
	const SkColor kButtonBackgroundColor = SkColorSetARGB(0xFF, 0x32, 0x32, 0x32);
	const SkColor kButtonTextColor = SkColorSetARGB(0xFF, 0x7B, 0xAA, 0xF7);

	// These values are in DIP.
	const int kToastHorizontalSpacing = 16;
	const int kToastVerticalSpacing = 16;
	const int kToastMaximumWidth = 568;
	const int kToastMinimumWidth = 288;

	// Returns the work area bounds for the root window where new windows are added
	// (including new toasts).
	gfx::Rect GetUserWorkAreaBounds() {
	return WmShelf::ForWindow(WmShell::Get()->GetRootWindowForNewWindows())
	->GetUserWorkAreaBounds();
	}

	} // anonymous namespace

	///////////////////////////////////////////////////////////////////////////////
	// ToastOverlayLabel
	class ToastOverlayLabel : public views::Label {
	public:
	explicit ToastOverlayLabel(const base::string16& label);
	~ToastOverlayLabel() override;

	private:
	DISALLOW_COPY_AND_ASSIGN(ToastOverlayLabel);
	};

	ToastOverlayLabel::ToastOverlayLabel(const base::string16& label) {
	ui::ResourceBundle* rb = &ui::ResourceBundle::GetSharedInstance();

	SetText(label);
	SetHorizontalAlignment(gfx::ALIGN_LEFT);
	SetFontList(rb->GetFontList(kTextFontStyle));
	SetAutoColorReadabilityEnabled(false);
	SetMultiLine(true);
	SetEnabledColor(SK_ColorWHITE);
	SetDisabledColor(SK_ColorWHITE);
	SetSubpixelRenderingEnabled(false);

	int verticalSpacing =
	kToastVerticalSpacing - (GetPreferredSize().height() - GetBaseline());
	SetBorder(views::CreateEmptyBorder(verticalSpacing, kToastHorizontalSpacing,
	verticalSpacing, kToastHorizontalSpacing));
	}

	ToastOverlayLabel::~ToastOverlayLabel() {}

	///////////////////////////////////////////////////////////////////////////////
	// ToastOverlayButton
	class ToastOverlayButton : public views::LabelButton {
	public:
	explicit ToastOverlayButton(views::ButtonListener* listener,
	const base::string16& label);
	~ToastOverlayButton() override {}

	private:
	friend class ToastOverlay; // for ToastOverlay::ClickDismissButtonForTesting.

	DISALLOW_COPY_AND_ASSIGN(ToastOverlayButton);
	};

	ToastOverlayButton::ToastOverlayButton(views::ButtonListener* listener,
	const base::string16& text)
	: views::LabelButton(listener, text) {
	SetInkDropMode(InkDropMode::ON);
	set_has_ink_drop_action_on_click(true);
	set_ink_drop_base_color(SK_ColorWHITE);

	ui::ResourceBundle* rb = &ui::ResourceBundle::GetSharedInstance();

	SetEnabledTextColors(kButtonTextColor);
	SetFontList(rb->GetFontList(kTextFontStyle));

	// Treat the space below the baseline as a margin.
	int verticalSpacing = kToastVerticalSpacing -
	(GetPreferredSize().height() - label()->GetBaseline());
	SetBorder(views::CreateEmptyBorder(verticalSpacing, kToastHorizontalSpacing,
	verticalSpacing, kToastHorizontalSpacing));
	}

	///////////////////////////////////////////////////////////////////////////////
	// ToastOverlayView
	class ToastOverlayView : public views::View, public views::ButtonListener {
	public:
	// This object is not owned by the views hiearchy or by the widget.
	ToastOverlayView(ToastOverlay* overlay,
	const base::string16& text,
	const base::string16& dismiss_text);
	~ToastOverlayView() override;

	// views::View overrides:
	void OnPaint(gfx::Canvas* canvas) override;

	ToastOverlayButton* button() { return button_; }

	private:
	ToastOverlay* overlay_; // weak
	ToastOverlayButton* button_; // weak

	gfx::Size GetMaximumSize() const override;
	gfx::Size GetMinimumSize() const override;

	void ButtonPressed(views::Button* sender, const ui::Event& event) override;

	DISALLOW_COPY_AND_ASSIGN(ToastOverlayView);
	};

	ToastOverlayView::ToastOverlayView(ToastOverlay* overlay,
	const base::string16& text,
	const base::string16& dismiss_text)
	: overlay_(overlay),
	button_(new ToastOverlayButton(
	this,
	dismiss_text.empty()
	? l10n_util::GetStringUTF16(IDS_ASH_TOAST_DISMISS_BUTTON)
	: dismiss_text)) {
	ToastOverlayLabel* label = new ToastOverlayLabel(text);
	label->SetMaximumWidth(
	GetMaximumSize().width() - button_->GetPreferredSize().width() -
	kToastHorizontalSpacing * 2 - kToastHorizontalSpacing * 2);
	AddChildView(label);

	AddChildView(button_);

	auto* layout = new views::BoxLayout(views::BoxLayout::kHorizontal, 0, 0, 0);
	SetLayoutManager(layout);
	layout->SetFlexForView(label, 1);
	layout->SetFlexForView(button_, 0);
	}

	ToastOverlayView::~ToastOverlayView() {}

	void ToastOverlayView::OnPaint(gfx::Canvas* canvas) {
	SkPaint paint;
	paint.setStyle(SkPaint::kFill_Style);
	paint.setColor(kButtonBackgroundColor);
	canvas->DrawRoundRect(GetLocalBounds(), 2, paint);
	views::View::OnPaint(canvas);
	}

	gfx::Size ToastOverlayView::GetMinimumSize() const {
	return gfx::Size(kToastMinimumWidth, 0);
	}

	gfx::Size ToastOverlayView::GetMaximumSize() const {
	gfx::Rect work_area_bounds = GetUserWorkAreaBounds();
	return gfx::Size(kToastMaximumWidth, work_area_bounds.height() - kOffset * 2);
	}

	void ToastOverlayView::ButtonPressed(views::Button* sender,
	const ui::Event& event) {
	overlay_->Show(false);
	}

	///////////////////////////////////////////////////////////////////////////////
	// ToastOverlay
	ToastOverlay::ToastOverlay(Delegate* delegate,
	const base::string16& text,
	const base::string16& dismiss_text)
	: delegate_(delegate),
	text_(text),
	dismiss_text_(dismiss_text),
	overlay_widget_(new views::Widget),
	overlay_view_(new ToastOverlayView(this, text, dismiss_text)),
	widget_size_(overlay_view_->GetPreferredSize()) {
	views::Widget::InitParams params;
	params.type = views::Widget::InitParams::TYPE_POPUP;
	params.name = "ToastOverlay";
	params.opacity = views::Widget::InitParams::TRANSLUCENT_WINDOW;
	params.ownership = views::Widget::InitParams::WIDGET_OWNS_NATIVE_WIDGET;
	params.accept_events = true;
	params.keep_on_top = true;
	params.remove_standard_frame = true;
	params.bounds = CalculateOverlayBounds();
	// Show toasts above the app list and below the lock screen.
	WmShell::Get()
	->GetRootWindowForNewWindows()
	->GetRootWindowController()
	->ConfigureWidgetInitParamsForContainer(
	overlay_widget_.get(), kShellWindowId_SystemModalContainer, &params);
	overlay_widget_->Init(params);
	overlay_widget_->SetVisibilityChangedAnimationsEnabled(true);
	overlay_widget_->SetContentsView(overlay_view_.get());
	overlay_widget_->SetBounds(CalculateOverlayBounds());

	WmWindow* overlay_window =
	WmLookup::Get()->GetWindowForWidget(overlay_widget_.get());
	overlay_window->SetVisibilityAnimationType(
	::wm::WINDOW_VISIBILITY_ANIMATION_TYPE_VERTICAL);
	overlay_window->SetVisibilityAnimationDuration(
	base::TimeDelta::FromMilliseconds(kSlideAnimationDurationMs));
	}

	ToastOverlay::~ToastOverlay() {
	overlay_widget_->Close();
	}

	void ToastOverlay::Show(bool visible) {
	if (overlay_widget_->GetLayer()->GetTargetVisibility() == visible)
	return;

	ui::LayerAnimator* animator = overlay_widget_->GetLayer()->GetAnimator();
	DCHECK(animator);
	if (animator->is_animating()) {
	// Showing during hiding animation doesn't happen since, ToastOverlay should
	// be one-time-use and not be reused.
	DCHECK(!visible);

	return;
	}

	base::TimeDelta original_duration = animator->GetTransitionDuration();
	ui::ScopedLayerAnimationSettings animation_settings(animator);
	// ScopedLayerAnimationSettings ctor chanes the transition duration, so change
	// back it to the original value (should be zero).
	animation_settings.SetTransitionDuration(original_duration);

	animation_settings.AddObserver(this);

	if (visible) {
	overlay_widget_->Show();

	// Notify accessibility about the overlay.
	overlay_view_->NotifyAccessibilityEvent(ui::AX_EVENT_ALERT, false);
	} else {
	overlay_widget_->Hide();
	}
	}

	gfx::Rect ToastOverlay::CalculateOverlayBounds() {
	gfx::Rect bounds = GetUserWorkAreaBounds();
	int target_y = bounds.bottom() - widget_size_.height() - kOffset;
	bounds.ClampToCenteredSize(widget_size_);
	bounds.set_y(target_y);
	return bounds;
	}

	void ToastOverlay::OnImplicitAnimationsScheduled() {}

	void ToastOverlay::OnImplicitAnimationsCompleted() {
	if (!overlay_widget_->GetLayer()->GetTargetVisibility())
	delegate_->OnClosed();
	}

	views::Widget* ToastOverlay::widget_for_testing() {
	return overlay_widget_.get();
	}

	void ToastOverlay::ClickDismissButtonForTesting(const ui::Event& event) {
	overlay_view_->button()->NotifyClick(event);
	}

	} // namespace ash