// Copyright (c) 2012 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 "ui/message_center/views/notification_view.h" #include "base/command_line.h" #include "base/strings/string_util.h" #include "base/strings/utf_string_conversions.h" #include "grit/ui_resources.h" #include "grit/ui_strings.h" #include "ui/base/l10n/l10n_util.h" #include "ui/base/layout.h" #include "ui/base/resource/resource_bundle.h" #include "ui/gfx/canvas.h" #include "ui/gfx/size.h" #include "ui/gfx/skia_util.h" #include "ui/gfx/text_elider.h" #include "ui/message_center/message_center.h" #include "ui/message_center/message_center_style.h" #include "ui/message_center/message_center_switches.h" #include "ui/message_center/message_center_util.h" #include "ui/message_center/notification.h" #include "ui/message_center/notification_types.h" #include "ui/message_center/views/bounded_label.h" #include "ui/message_center/views/constants.h" #include "ui/message_center/views/message_center_controller.h" #include "ui/message_center/views/notification_button.h" #include "ui/message_center/views/padded_button.h" #include "ui/message_center/views/proportional_image_view.h" #include "ui/native_theme/native_theme.h" #include "ui/views/background.h" #include "ui/views/border.h" #include "ui/views/controls/button/image_button.h" #include "ui/views/controls/image_view.h" #include "ui/views/controls/label.h" #include "ui/views/controls/progress_bar.h" #include "ui/views/layout/box_layout.h" #include "ui/views/layout/fill_layout.h" #include "ui/views/painter.h" #include "ui/views/widget/widget.h" #if defined(USE_AURA) #include "ui/base/cursor/cursor.h" #endif namespace { // Dimensions. const int kProgressBarWidth = message_center::kNotificationWidth - message_center::kTextLeftPadding - message_center::kTextRightPadding; const int kProgressBarBottomPadding = 0; const int kExpandIconBottomPadding = 8; const int kExpandIconRightPadding = 11; // static views::Background* MakeBackground( SkColor color = message_center::kNotificationBackgroundColor) { return views::Background::CreateSolidBackground(color); } // static views::Border* MakeEmptyBorder(int top, int left, int bottom, int right) { return views::Border::CreateEmptyBorder(top, left, bottom, right); } // static views::Border* MakeTextBorder(int padding, int top, int bottom) { // Split the padding between the top and the bottom, then add the extra space. return MakeEmptyBorder(padding / 2 + top, message_center::kTextLeftPadding, (padding + 1) / 2 + bottom, message_center::kTextRightPadding); } // static views::Border* MakeProgressBarBorder(int top, int bottom) { return MakeEmptyBorder(top, message_center::kTextLeftPadding, bottom, message_center::kTextRightPadding); } // static views::Border* MakeSeparatorBorder(int top, int left, SkColor color) { return views::Border::CreateSolidSidedBorder(top, left, 0, 0, color); } // static // Return true if and only if the image is null or has alpha. bool HasAlpha(gfx::ImageSkia& image, views::Widget* widget) { // Determine which bitmap to use. ui::ScaleFactor factor = ui::SCALE_FACTOR_100P; if (widget) { factor = ui::GetScaleFactorForNativeView(widget->GetNativeView()); if (factor == ui::SCALE_FACTOR_NONE) factor = ui::SCALE_FACTOR_100P; } // Extract that bitmap's alpha and look for a non-opaque pixel there. SkBitmap bitmap = image.GetRepresentation(ui::GetImageScale(factor)).sk_bitmap(); if (!bitmap.isNull()) { SkBitmap alpha; bitmap.extractAlpha(&alpha); for (int y = 0; y < bitmap.height(); ++y) { for (int x = 0; x < bitmap.width(); ++x) { if (alpha.getColor(x, y) != SK_ColorBLACK) { return true; } } } } // If no opaque pixel was found, return false unless the bitmap is empty. return bitmap.isNull(); } // ItemView //////////////////////////////////////////////////////////////////// // ItemViews are responsible for drawing each list notification item's title and // message next to each other within a single column. class ItemView : public views::View { public: ItemView(const message_center::NotificationItem& item); virtual ~ItemView(); // Overridden from views::View: virtual void SetVisible(bool visible) OVERRIDE; private: DISALLOW_COPY_AND_ASSIGN(ItemView); }; ItemView::ItemView(const message_center::NotificationItem& item) { SetLayoutManager(new views::BoxLayout(views::BoxLayout::kHorizontal, 0, 0, message_center::kItemTitleToMessagePadding)); views::Label* title = new views::Label(item.title); title->set_collapse_when_hidden(true); title->SetHorizontalAlignment(gfx::ALIGN_LEFT); title->SetEnabledColor(message_center::kRegularTextColor); title->SetBackgroundColor(message_center::kRegularTextBackgroundColor); AddChildView(title); views::Label* message = new views::Label(item.message); message->set_collapse_when_hidden(true); message->SetHorizontalAlignment(gfx::ALIGN_LEFT); message->SetEnabledColor(message_center::kDimTextColor); message->SetBackgroundColor(message_center::kDimTextBackgroundColor); AddChildView(message); PreferredSizeChanged(); SchedulePaint(); } ItemView::~ItemView() { } void ItemView::SetVisible(bool visible) { views::View::SetVisible(visible); for (int i = 0; i < child_count(); ++i) child_at(i)->SetVisible(visible); } // The NotificationImage is the view representing the area covered by the // notification's image, including background and border. Its size can be // specified in advance and images will be scaled to fit including a border if // necessary. // static views::View* MakeNotificationImage(const gfx::Image& image, gfx::Size size) { views::View* container = new views::View(); container->SetLayoutManager(new views::FillLayout()); container->set_background(views::Background::CreateSolidBackground( message_center::kImageBackgroundColor)); views::View* proportional_image_view = new message_center::ProportionalImageView(image.AsImageSkia()); gfx::Size ideal_size( message_center::kNotificationPreferredImageWidth, message_center::kNotificationPreferredImageHeight); gfx::Size scaled_size = message_center::GetImageSizeForWidth( message_center::kNotificationPreferredImageWidth, image.Size()); // This calculation determines that the new image would have the correct // height for width. if (ideal_size != scaled_size) { proportional_image_view->set_border(views::Border::CreateSolidBorder( message_center::kNotificationImageBorderSize, SK_ColorTRANSPARENT)); } container->AddChildView(proportional_image_view); return container; } // NotificationProgressBar ///////////////////////////////////////////////////// class NotificationProgressBar : public views::ProgressBar { public: NotificationProgressBar(); virtual ~NotificationProgressBar(); private: // Overriden from View virtual gfx::Size GetPreferredSize() OVERRIDE; virtual void OnPaint(gfx::Canvas* canvas) OVERRIDE; DISALLOW_COPY_AND_ASSIGN(NotificationProgressBar); }; NotificationProgressBar::NotificationProgressBar() { } NotificationProgressBar::~NotificationProgressBar() { } gfx::Size NotificationProgressBar::GetPreferredSize() { gfx::Size pref_size(kProgressBarWidth, message_center::kProgressBarThickness); gfx::Insets insets = GetInsets(); pref_size.Enlarge(insets.width(), insets.height()); return pref_size; } void NotificationProgressBar::OnPaint(gfx::Canvas* canvas) { gfx::Rect content_bounds = GetContentsBounds(); // Draw background. SkPath background_path; background_path.addRoundRect(gfx::RectToSkRect(content_bounds), message_center::kProgressBarCornerRadius, message_center::kProgressBarCornerRadius); SkPaint background_paint; background_paint.setStyle(SkPaint::kFill_Style); background_paint.setFlags(SkPaint::kAntiAlias_Flag); background_paint.setColor(message_center::kProgressBarBackgroundColor); canvas->DrawPath(background_path, background_paint); // Draw slice. const int slice_width = static_cast(content_bounds.width() * GetNormalizedValue() + 0.5); if (slice_width < 1) return; gfx::Rect slice_bounds = content_bounds; slice_bounds.set_width(slice_width); SkPath slice_path; slice_path.addRoundRect(gfx::RectToSkRect(slice_bounds), message_center::kProgressBarCornerRadius, message_center::kProgressBarCornerRadius); SkPaint slice_paint; slice_paint.setStyle(SkPaint::kFill_Style); slice_paint.setFlags(SkPaint::kAntiAlias_Flag); slice_paint.setColor(message_center::kProgressBarSliceColor); canvas->DrawPath(slice_path, slice_paint); } } // namespace namespace message_center { // NotificationView //////////////////////////////////////////////////////////// // static NotificationView* NotificationView::Create(MessageCenterController* controller, const Notification& notification, bool expanded, bool top_level) { switch (notification.type()) { case NOTIFICATION_TYPE_BASE_FORMAT: case NOTIFICATION_TYPE_IMAGE: case NOTIFICATION_TYPE_MULTIPLE: case NOTIFICATION_TYPE_SIMPLE: case NOTIFICATION_TYPE_PROGRESS: break; default: // If the caller asks for an unrecognized kind of view (entirely possible // if an application is running on an older version of this code that // doesn't have the requested kind of notification template), we'll fall // back to a notification instance that will provide at least basic // functionality. LOG(WARNING) << "Unable to fulfill request for unrecognized " << "notification type " << notification.type() << ". " << "Falling back to simple notification type."; } // Currently all roads lead to the generic NotificationView. NotificationView* notification_view = new NotificationView(controller, notification, expanded); #if defined(OS_LINUX) && !defined(OS_CHROMEOS) // Don't create shadows for notification toasts on linux wih aura. if (top_level) return notification_view; #endif notification_view->CreateShadowBorder(); return notification_view; } NotificationView::NotificationView(MessageCenterController* controller, const Notification& notification, bool expanded) : MessageView(this, notification.id(), notification.notifier_id(), notification.display_source()), controller_(controller), clickable_(notification.clickable()), is_expanded_(expanded) { std::vector accessible_lines; // Create the opaque background that's above the view's shadow. background_view_ = new views::View(); background_view_->set_background(MakeBackground()); // Create the top_view_, which collects into a vertical box all content // at the top of the notification (to the right of the icon) except for the // close button. top_view_ = new views::View(); top_view_->SetLayoutManager( new views::BoxLayout(views::BoxLayout::kVertical, 0, 0, 0)); top_view_->set_border(MakeEmptyBorder( kTextTopPadding - 8, 0, kTextBottomPadding - 5, 0)); const gfx::FontList default_label_font_list = views::Label().font_list(); // Create the title view if appropriate. title_view_ = NULL; if (!notification.title().empty()) { const gfx::FontList& font_list = default_label_font_list.DeriveFontListWithSizeDelta(2); int padding = kTitleLineHeight - font_list.GetHeight(); title_view_ = new BoundedLabel( gfx::TruncateString(notification.title(), kTitleCharacterLimit), font_list); title_view_->SetLineHeight(kTitleLineHeight); title_view_->SetLineLimit(IsExperimentalNotificationUIEnabled() ? message_center::kExperimentalTitleLineLimit : message_center::kTitleLineLimit); title_view_->SetColors(message_center::kRegularTextColor, kRegularTextBackgroundColor); title_view_->set_border(MakeTextBorder(padding, 3, 0)); top_view_->AddChildView(title_view_); accessible_lines.push_back(notification.title()); } // Create the message view if appropriate. message_view_ = NULL; if (!notification.message().empty()) { int padding = kMessageLineHeight - default_label_font_list.GetHeight(); message_view_ = new BoundedLabel( gfx::TruncateString(notification.message(), kMessageCharacterLimit)); message_view_->SetLineHeight(kMessageLineHeight); message_view_->SetVisible(!is_expanded_ || !notification.items().size()); message_view_->SetColors(message_center::kRegularTextColor, kDimTextBackgroundColor); message_view_->set_border(MakeTextBorder(padding, 4, 0)); top_view_->AddChildView(message_view_); accessible_lines.push_back(notification.message()); } // Create the context message view if appropriate. context_message_view_ = NULL; if (!notification.context_message().empty()) { int padding = kMessageLineHeight - default_label_font_list.GetHeight(); context_message_view_ = new BoundedLabel(gfx::TruncateString(notification.context_message(), kContextMessageCharacterLimit), default_label_font_list); context_message_view_->SetLineLimit( message_center::kContextMessageLineLimit); context_message_view_->SetLineHeight(kMessageLineHeight); context_message_view_->SetColors(message_center::kDimTextColor, kContextTextBackgroundColor); context_message_view_->set_border(MakeTextBorder(padding, 4, 0)); top_view_->AddChildView(context_message_view_); accessible_lines.push_back(notification.context_message()); } // Create the progress bar view. progress_bar_view_ = NULL; if (notification.type() == NOTIFICATION_TYPE_PROGRESS) { progress_bar_view_ = new NotificationProgressBar(); progress_bar_view_->set_border(MakeProgressBarBorder( message_center::kProgressBarTopPadding, kProgressBarBottomPadding)); progress_bar_view_->SetValue(notification.progress() / 100.0); top_view_->AddChildView(progress_bar_view_); } // Create the list item views (up to a maximum). int padding = kMessageLineHeight - default_label_font_list.GetHeight(); std::vector items = notification.items(); for (size_t i = 0; i < items.size() && i < kNotificationMaximumItems; ++i) { ItemView* item_view = new ItemView(items[i]); item_view->SetVisible(is_expanded_); item_view->set_border(MakeTextBorder(padding, i ? 0 : 4, 0)); item_views_.push_back(item_view); top_view_->AddChildView(item_view); accessible_lines.push_back( items[i].title + base::ASCIIToUTF16(" ") + items[i].message); } // Create the notification icon view. gfx::ImageSkia icon = notification.icon().AsImageSkia(); if (notification.type() == NOTIFICATION_TYPE_SIMPLE && (icon.width() != kIconSize || icon.height() != kIconSize || HasAlpha(icon, GetWidget()))) { views::ImageView* icon_view = new views::ImageView(); icon_view->SetImage(icon); icon_view->SetImageSize(gfx::Size(kLegacyIconSize, kLegacyIconSize)); icon_view->SetHorizontalAlignment(views::ImageView::CENTER); icon_view->SetVerticalAlignment(views::ImageView::CENTER); icon_view_ = icon_view; } else { icon_view_ = new ProportionalImageView(icon); } icon_view_->set_background(MakeBackground(kIconBackgroundColor)); // Create the bottom_view_, which collects into a vertical box all content // below the notification icon except for the expand button. bottom_view_ = new views::View(); bottom_view_->SetLayoutManager( new views::BoxLayout(views::BoxLayout::kVertical, 0, 0, 0)); // Create the image view if appropriate. image_view_ = NULL; if (!notification.image().IsEmpty()) { gfx::Size image_size( kNotificationPreferredImageWidth, kNotificationPreferredImageHeight); image_view_ = MakeNotificationImage(notification.image(), image_size); image_view_->SetVisible(is_expanded_); bottom_view_->AddChildView(image_view_); } // Create action buttons if appropriate. std::vector buttons = notification.buttons(); for (size_t i = 0; i < buttons.size(); ++i) { views::View* separator = new views::ImageView(); separator->set_border(MakeSeparatorBorder(1, 0, kButtonSeparatorColor)); bottom_view_->AddChildView(separator); NotificationButton* button = new NotificationButton(this); ButtonInfo button_info = buttons[i]; button->SetTitle(button_info.title); button->SetIcon(button_info.icon.AsImageSkia()); action_buttons_.push_back(button); bottom_view_->AddChildView(button); } // Create expand button expand_button_ = new PaddedButton(this); expand_button_->SetPadding(-kExpandIconRightPadding, -kExpandIconBottomPadding); expand_button_->SetNormalImage(IDR_NOTIFICATION_EXPAND); expand_button_->SetHoveredImage(IDR_NOTIFICATION_EXPAND_HOVER); expand_button_->SetPressedImage(IDR_NOTIFICATION_EXPAND_PRESSED); expand_button_->set_animate_on_state_change(false); expand_button_->SetAccessibleName(l10n_util::GetStringUTF16( IDS_MESSAGE_CENTER_EXPAND_NOTIFICATION_BUTTON_ACCESSIBLE_NAME)); // Put together the different content and control views. Layering those allows // for proper layout logic and it also allows the close and expand buttons to // overlap the content as needed to provide large enough click and touch areas // ( and ). AddChildView(background_view_); AddChildView(top_view_); AddChildView(icon_view_); AddChildView(bottom_view_); AddChildView(close_button()); AddChildView(expand_button_); set_accessible_name(JoinString(accessible_lines, '\n')); } NotificationView::~NotificationView() { } gfx::Size NotificationView::GetPreferredSize() { int top_width = top_view_->GetPreferredSize().width(); int bottom_width = bottom_view_->GetPreferredSize().width(); int preferred_width = std::max(top_width, bottom_width) + GetInsets().width(); return gfx::Size(preferred_width, GetHeightForWidth(preferred_width)); } int NotificationView::GetHeightForWidth(int width) { // Get the height assuming no line limit changes. int content_width = width - GetInsets().width(); int top_height = top_view_->GetHeightForWidth(content_width); int bottom_height = bottom_view_->GetHeightForWidth(content_width); // Fix: Adjust the height when the message_view's // line limit would be different for the specified width than it currently is. // TODO(dharcourt): Avoid BoxLayout and directly compute the correct height. if (message_view_) { int used_limit = message_view_->GetLineLimit(); int correct_limit = GetMessageLineLimit(width); if (used_limit != correct_limit) { top_height -= GetMessageHeight(content_width, used_limit); top_height += GetMessageHeight(content_width, correct_limit); } } int content_height = std::max(top_height, kIconSize) + bottom_height; // Adjust the height to make sure there is at least 16px of space below the // icon if there is any space there (). if (content_height > kIconSize) content_height = std::max(content_height, kIconSize + message_center::kIconBottomPadding); return content_height + GetInsets().height(); } void NotificationView::Layout() { gfx::Insets insets = GetInsets(); int content_width = width() - insets.width(); int content_right = width() - insets.right(); // Before any resizing, set or adjust the number of message lines. if (message_view_) message_view_->SetLineLimit(GetMessageLineLimit(width())); // Background. background_view_->SetBounds(insets.left(), insets.top(), content_width, height() - insets.height()); // Top views. int top_height = top_view_->GetHeightForWidth(content_width); top_view_->SetBounds(insets.left(), insets.top(), content_width, top_height); // Icon. icon_view_->SetBounds(insets.left(), insets.top(), kIconSize, kIconSize); // Bottom views. int bottom_y = insets.top() + std::max(top_height, kIconSize); int bottom_height = bottom_view_->GetHeightForWidth(content_width); bottom_view_->SetBounds(insets.left(), bottom_y, content_width, bottom_height); // Close button. gfx::Size close_size(close_button()->GetPreferredSize()); close_button()->SetBounds(content_right - close_size.width(), insets.top(), close_size.width(), close_size.height()); // Expand button. gfx::Size expand_size(expand_button_->GetPreferredSize()); int expand_y = bottom_y - expand_size.height(); expand_button_->SetVisible(IsExpansionNeeded(width())); expand_button_->SetBounds(content_right - expand_size.width(), expand_y, expand_size.width(), expand_size.height()); } void NotificationView::OnFocus() { MessageView::OnFocus(); ScrollRectToVisible(GetLocalBounds()); } void NotificationView::ScrollRectToVisible(const gfx::Rect& rect) { // Notification want to show the whole notification when a part of it (like // a button) gets focused. views::View::ScrollRectToVisible(GetLocalBounds()); } views::View* NotificationView::GetEventHandlerForRect(const gfx::Rect& rect) { // TODO(tdanderson): Modify this function to support rect-based event // targeting. Using the center point of |rect| preserves this function's // expected behavior for the time being. gfx::Point point = rect.CenterPoint(); // Want to return this for underlying views, otherwise GetCursor is not // called. But buttons are exceptions, they'll have their own event handlings. std::vector buttons(action_buttons_); buttons.push_back(close_button()); buttons.push_back(expand_button_); for (size_t i = 0; i < buttons.size(); ++i) { gfx::Point point_in_child = point; ConvertPointToTarget(this, buttons[i], &point_in_child); if (buttons[i]->HitTestPoint(point_in_child)) return buttons[i]->GetEventHandlerForPoint(point_in_child); } return this; } gfx::NativeCursor NotificationView::GetCursor(const ui::MouseEvent& event) { if (!clickable_ || !controller_->HasClickedListener(notification_id())) return views::View::GetCursor(event); #if defined(USE_AURA) return ui::kCursorHand; #elif defined(OS_WIN) static HCURSOR g_hand_cursor = LoadCursor(NULL, IDC_HAND); return g_hand_cursor; #endif } void NotificationView::ButtonPressed(views::Button* sender, const ui::Event& event) { // See if the button pressed was an action button. for (size_t i = 0; i < action_buttons_.size(); ++i) { if (sender == action_buttons_[i]) { controller_->ClickOnNotificationButton(notification_id(), i); return; } } // Adjust notification subviews for expansion. if (sender == expand_button_) { if (message_view_ && item_views_.size()) message_view_->SetVisible(false); for (size_t i = 0; i < item_views_.size(); ++i) item_views_[i]->SetVisible(true); if (image_view_) image_view_->SetVisible(true); is_expanded_ = true; controller_->ExpandNotification(notification_id()); return; } // Let the superclass handled anything other than action buttons. // Warning: This may cause the NotificationView itself to be deleted, // so don't do anything afterwards. MessageView::ButtonPressed(sender, event); } void NotificationView::ClickOnNotification(const std::string& notification_id) { controller_->ClickOnNotification(notification_id); } void NotificationView::RemoveNotification(const std::string& notification_id, bool by_user) { controller_->RemoveNotification(notification_id, by_user); } void NotificationView::DisableNotificationsFromThisSource( const NotifierId& notifier_id) { controller_->DisableNotificationsFromThisSource(notifier_id); } void NotificationView::ShowNotifierSettingsBubble() { controller_->ShowNotifierSettingsBubble(); } bool NotificationView::IsExpansionNeeded(int width) { return (!is_expanded_ && (image_view_ || item_views_.size() || IsMessageExpansionNeeded(width))); } bool NotificationView::IsMessageExpansionNeeded(int width) { int current = GetMessageLines(width, GetMessageLineLimit(width)); int expanded = GetMessageLines(width, message_center::kMessageExpandedLineLimit); return current < expanded; } int NotificationView::GetMessageLineLimit(int width) { // Expanded notifications get a larger limit, except for image notifications, // whose images must be kept flush against their icons. if (is_expanded_ && !image_view_) return message_center::kMessageExpandedLineLimit; int message_line_limit = message_center::kMessageCollapsedLineLimit; // Subtract any lines taken by the context message. if (context_message_view_) { message_line_limit -= context_message_view_->GetLinesForWidthAndLimit( width, message_center::kContextMessageLineLimit); } DCHECK_GT(message_line_limit, 0); return message_line_limit; } int NotificationView::GetMessageLines(int width, int limit) { return message_view_ ? message_view_->GetLinesForWidthAndLimit(width, limit) : 0; } int NotificationView::GetMessageHeight(int width, int limit) { return message_view_ ? message_view_->GetSizeForWidthAndLines(width, limit).height() : 0; } } // namespace message_center