ash/popup_message.cc

   1 // Copyright (c) 2013 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 "ash/popup_message.h"
   6
   7 #include "ash/wm/window_animations.h"
   8 #include "grit/ash_resources.h"
   9 #include "ui/base/resource/resource_bundle.h"
  10 #include "ui/gfx/geometry/insets.h"
  11 #include "ui/views/bubble/bubble_delegate.h"
  12 #include "ui/views/bubble/bubble_frame_view.h"
  13 #include "ui/views/controls/image_view.h"
  14 #include "ui/views/controls/label.h"
  15 #include "ui/views/layout/box_layout.h"
  16 #include "ui/views/widget/widget.h"
  17
  18 namespace ash {
  19 namespace {
  20 const int kMessageTopBottomMargin = 10;
  21 const int kMessageLeftRightMargin = 10;
  22 const int kMessageMinHeight = 29 - 2 * kMessageTopBottomMargin;
  23 const SkColor kMessageTextColor = SkColorSetRGB(0x22, 0x22, 0x22);
  24
  25 // The maximum width of the Message bubble.  Borrowed the value from
  26 // ash/message/message_controller.cc
  27 const int kMessageMaxWidth = 250;
  28
  29 // The offset for the Message bubble - making sure that the bubble is flush
  30 // with the shelf. The offset includes the arrow size in pixels as well as
  31 // the activation bar and other spacing elements.
  32 const int kArrowOffsetLeftRight = 11;
  33 const int kArrowOffsetTopBottom = 7;
  34
  35 // The number of pixels between the icon and the text.
  36 const int kHorizontalPopupPaddingBetweenItems = 10;
  37
  38 // The number of pixels between the text items.
  39 const int kVerticalPopupPaddingBetweenItems = 10;
  40 }  // namespace
  41
  42 // The implementation of Message of the launcher.
  43 class PopupMessage::MessageBubble : public views::BubbleDelegateView {
  44  public:
  45   MessageBubble(const base::string16& caption,
  46                 const base::string16& message,
  47                 IconType message_type,
  48                 views::View* anchor,
  49                 views::BubbleBorder::Arrow arrow_orientation,
  50                 const gfx::Size& size_override,
  51                 int arrow_offset);
  52
  53   void Close();
  54
  55  private:
  56   // views::View overrides:
  57   gfx::Size GetPreferredSize() const override;
  58
  59   // Each component (width/height) can force a size override for that component
  60   // if not 0.
  61   gfx::Size size_override_;
  62
  63   DISALLOW_COPY_AND_ASSIGN(MessageBubble);
  64 };
  65
  66 // static
  67 const int PopupMessage::kCaptionLabelID = 1000;
  68 const int PopupMessage::kMessageLabelID = 1001;
  69
  70 PopupMessage::MessageBubble::MessageBubble(const base::string16& caption,
  71                                            const base::string16& message,
  72                                            IconType message_type,
  73                                            views::View* anchor,
  74                                            views::BubbleBorder::Arrow arrow,
  75                                            const gfx::Size& size_override,
  76                                            int arrow_offset)
  77     : views::BubbleDelegateView(anchor, arrow),
  78       size_override_(size_override) {
  79   gfx::Insets insets = gfx::Insets(kArrowOffsetTopBottom,
  80                                    kArrowOffsetLeftRight,
  81                                    kArrowOffsetTopBottom,
  82                                    kArrowOffsetLeftRight);
  83   // An anchor can have an asymmetrical border for spacing reasons. Adjust the
  84   // anchor location for this.
  85   if (anchor->border())
  86     insets += anchor->border()->GetInsets();
  87
  88   set_anchor_view_insets(insets);
  89   set_close_on_esc(false);
  90   set_close_on_deactivate(false);
  91   set_can_activate(false);
  92   set_accept_events(false);
  93
  94   set_margins(gfx::Insets(kMessageTopBottomMargin, kMessageLeftRightMargin,
  95                           kMessageTopBottomMargin, kMessageLeftRightMargin));
  96   set_shadow(views::BubbleBorder::SMALL_SHADOW);
  97
  98   ui::ResourceBundle& bundle = ui::ResourceBundle::GetSharedInstance();
  99   SetLayoutManager(new views::BoxLayout(views::BoxLayout::kHorizontal, 0, 0,
 100                                         kHorizontalPopupPaddingBetweenItems));
 101
 102   // Here is the layout:
 103   //         arrow_offset (if not 0)
 104   //       |-------------|
 105   //       |             ^
 106   //       +-------------------------------------------------+
 107   //      -|                                                 |-
 108   //  icon |  [!]  Caption in bold which can be multi line   | caption_label
 109   //      -|                                                 |-
 110   //       |       Message text which can be multi line      | message_label
 111   //       |       as well.                                  |
 112   //       |                                                 |-
 113   //       +-------------------------------------------------+
 114   //             |------------details container--------------|
 115   // Note that the icon, caption and message are optional.
 116
 117   // Add the icon to the first column (if there is one).
 118   if (message_type != ICON_NONE) {
 119     views::ImageView* icon = new views::ImageView();
 120     icon->SetImage(
 121         bundle.GetImageNamed(IDR_AURA_WARNING_ICON).ToImageSkia());
 122     icon->SetVerticalAlignment(views::ImageView::LEADING);
 123     AddChildView(icon);
 124   }
 125
 126   // Create a container for the text items and use it as second column.
 127   views::View* details = new views::View();
 128   AddChildView(details);
 129   details->SetLayoutManager(new views::BoxLayout(
 130       views::BoxLayout::kVertical, 0, 0, kVerticalPopupPaddingBetweenItems));
 131
 132   // The caption label.
 133   if (!caption.empty()) {
 134     views::Label* caption_label = new views::Label(caption);
 135     caption_label->set_id(kCaptionLabelID);
 136     caption_label->SetMultiLine(true);
 137     caption_label->SetHorizontalAlignment(gfx::ALIGN_LEFT);
 138     caption_label->SetFontList(
 139         bundle.GetFontList(ui::ResourceBundle::BoldFont));
 140     caption_label->SetEnabledColor(kMessageTextColor);
 141     details->AddChildView(caption_label);
 142   }
 143
 144   // The message label.
 145   if (!message.empty()) {
 146     views::Label* message_label = new views::Label(message);
 147     message_label->set_id(kMessageLabelID);
 148     message_label->SetMultiLine(true);
 149     message_label->SetHorizontalAlignment(gfx::ALIGN_LEFT);
 150     message_label->SetEnabledColor(kMessageTextColor);
 151     details->AddChildView(message_label);
 152   }
 153   views::BubbleDelegateView::CreateBubble(this);
 154
 155   // Change the arrow offset if needed.
 156   if (arrow_offset) {
 157     // With the creation of the bubble, the bubble got already placed (and
 158     // possibly re-oriented to fit on the screen). Since it is not possible to
 159     // set the arrow offset before the creation, we need to set the offset,
 160     // and the orientation variables again and force a re-placement.
 161     GetBubbleFrameView()->bubble_border()->set_arrow_offset(arrow_offset);
 162     GetBubbleFrameView()->bubble_border()->set_arrow(arrow);
 163     SetAlignment(views::BubbleBorder::ALIGN_ARROW_TO_MID_ANCHOR);
 164   }
 165 }
 166
 167 void PopupMessage::MessageBubble::Close() {
 168   if (GetWidget())
 169     GetWidget()->Close();
 170 }
 171
 172 gfx::Size PopupMessage::MessageBubble::GetPreferredSize() const {
 173   gfx::Size pref_size = views::BubbleDelegateView::GetPreferredSize();
 174   // Override the size with either the provided size or adjust it to not
 175   // violate our minimum / maximum sizes.
 176   if (size_override_.height())
 177     pref_size.set_height(size_override_.height());
 178   else if (pref_size.height() < kMessageMinHeight)
 179     pref_size.set_height(kMessageMinHeight);
 180
 181   if (size_override_.width())
 182     pref_size.set_width(size_override_.width());
 183   else if (pref_size.width() > kMessageMaxWidth)
 184     pref_size.set_width(kMessageMaxWidth);
 185
 186   return pref_size;
 187 }
 188
 189 PopupMessage::PopupMessage(const base::string16& caption,
 190                            const base::string16& message,
 191                            IconType message_type,
 192                            views::View* anchor,
 193                            views::BubbleBorder::Arrow arrow,
 194                            const gfx::Size& size_override,
 195                            int arrow_offset)
 196     : view_(NULL) {
 197   view_ = new MessageBubble(
 198       caption, message, message_type, anchor, arrow, size_override,
 199       arrow_offset);
 200   widget_ = view_->GetWidget();
 201
 202   gfx::NativeView native_view = widget_->GetNativeView();
 203   wm::SetWindowVisibilityAnimationType(
 204       native_view, wm::WINDOW_VISIBILITY_ANIMATION_TYPE_VERTICAL);
 205   wm::SetWindowVisibilityAnimationTransition(
 206       native_view, wm::ANIMATE_HIDE);
 207   view_->GetWidget()->Show();
 208 }
 209
 210 PopupMessage::~PopupMessage() {
 211   CancelHidingAnimation();
 212   Close();
 213 }
 214
 215 void PopupMessage::Close() {
 216   if (view_) {
 217     view_->Close();
 218     view_ = NULL;
 219     widget_ = NULL;
 220   }
 221 }
 222
 223 void PopupMessage::CancelHidingAnimation() {
 224   if (!widget_ || !widget_->GetNativeView())
 225     return;
 226
 227   gfx::NativeView native_view = widget_->GetNativeView();
 228   wm::SetWindowVisibilityAnimationTransition(
 229       native_view, wm::ANIMATE_NONE);
 230 }
 231
 232 }  // namespace ash