[Chrome OS MD] Draw a 1px separator between 2 tray items

ash/common/system/tray/tray_background_view.cc

 // 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 "ash/common/system/tray/tray_background_view.h"
 
 #include "ash/common/material_design/material_design_controller.h"
 #include "ash/common/shelf/shelf_constants.h"
 #include "ash/common/shelf/wm_shelf.h"
 #include "ash/common/shelf/wm_shelf_util.h"
 #include "ash/common/shell_window_ids.h"
+#include "ash/common/system/status_area_widget.h"
 #include "ash/common/system/tray/system_tray.h"
 #include "ash/common/system/tray/tray_constants.h"
 #include "ash/common/system/tray/tray_event_filter.h"
 #include "ash/common/wm_lookup.h"
 #include "ash/common/wm_shell.h"
 #include "ash/common/wm_window.h"
 #include "grit/ash_resources.h"
 #include "ui/accessibility/ax_view_state.h"
 #include "ui/base/nine_image_painter_factory.h"
 #include "ui/compositor/layer.h"
 #include "ui/compositor/layer_animation_element.h"
 #include "ui/compositor/scoped_layer_animation_settings.h"
 #include "ui/events/event_constants.h"
 #include "ui/gfx/animation/tween.h"
 #include "ui/gfx/canvas.h"
 #include "ui/gfx/geometry/rect.h"
 #include "ui/gfx/image/image_skia.h"
 #include "ui/gfx/image/image_skia_operations.h"
 #include "ui/gfx/nine_image_painter.h"
+#include "ui/gfx/scoped_canvas.h"
 #include "ui/gfx/skia_util.h"
 #include "ui/gfx/transform.h"
 #include "ui/views/background.h"
 #include "ui/views/layout/box_layout.h"
 #include "ui/wm/core/window_animations.h"
 
 namespace {
 
 const int kAnimationDurationForPopupMs = 200;
 
@@ skipping 53 matching lines @@
 
   void set_alpha(int alpha) { alpha_ = alpha; }
 
  private:
   WmShelf* GetShelf() const { return tray_background_view_->shelf(); }
 
   void PaintMaterial(gfx::Canvas* canvas, views::View* view) const {
     SkPaint background_paint;
     background_paint.setFlags(SkPaint::kAntiAlias_Flag);
     background_paint.setColor(SkColorSetA(kShelfBaseColor, alpha_));
-    canvas->DrawRoundRect(view->GetLocalBounds(), kTrayRoundedBorderRadius,
+    canvas->DrawRoundRect(view->GetContentsBounds(), kTrayRoundedBorderRadius,
                           background_paint);
 
     if (tray_background_view_->draw_background_as_active()) {
       SkPaint highlight_paint;
       highlight_paint.setFlags(SkPaint::kAntiAlias_Flag);
       highlight_paint.setColor(kShelfButtonActivatedHighlightColor);
-      canvas->DrawRoundRect(view->GetLocalBounds(), kTrayRoundedBorderRadius,
+      canvas->DrawRoundRect(view->GetContentsBounds(), kTrayRoundedBorderRadius,
                             highlight_paint);
     }
   }
 
   void PaintNonMaterial(gfx::Canvas* canvas, views::View* view) const {
     const int kGridSizeForPainter = 9;
     const int kImages[kNumOrientations][kNumStates][kGridSizeForPainter] = {
         {
             // Horizontal
             IMAGE_GRID_HORIZONTAL(IDR_AURA_TRAY_BG_HORIZ),
@@ skipping 73 matching lines @@
     PreferredSizeChanged();
 }
 
 void TrayBackgroundView::TrayContainer::UpdateLayout() {
   // Adjust the size of status tray dark background by adding additional
   // empty border.
   views::BoxLayout::Orientation orientation =
       IsHorizontalAlignment(alignment_) ? views::BoxLayout::kHorizontal
                                         : views::BoxLayout::kVertical;
 
-  if (!ash::MaterialDesignController::IsShelfMaterial()) {
-    // Additional padding used to adjust the user-visible size of status tray
-    // dark background.
-    const int padding = 3;
-    SetBorder(
-        views::Border::CreateEmptyBorder(padding, padding, padding, padding));
-  }
-
   views::BoxLayout* layout = new views::BoxLayout(orientation, 0, 0, 0);
   layout->SetDefaultFlex(1);
   views::View::SetLayoutManager(layout);
   PreferredSizeChanged();
 }
 
 ////////////////////////////////////////////////////////////////////////////////
 // TrayBackgroundView
 
 TrayBackgroundView::TrayBackgroundView(WmShelf* wm_shelf)
     : wm_shelf_(wm_shelf),
       tray_container_(NULL),
       shelf_alignment_(SHELF_ALIGNMENT_BOTTOM),
       background_(NULL),
       draw_background_as_active_(false),
       widget_observer_(new TrayWidgetObserver(this)) {
   DCHECK(wm_shelf_);
   set_notify_enter_exit_on_child(true);
 
   tray_container_ = new TrayContainer(shelf_alignment_);
   SetContents(tray_container_);
   tray_event_filter_.reset(new TrayEventFilter);
+  is_separator_visible_ = false;

[James Cook, 2016/08/11 20:36:55]

can this be initialized in the member list above?

[yiyix, 2016/08/18 00:43:00]

Done.

 
   SetPaintToLayer(true);
   layer()->SetFillsBoundsOpaquely(false);
   // Start the tray items not visible, because visibility changes are animated.
   views::View::SetVisible(false);
+  CalculateAndSetTrayContainerBorder();
 }
 
 TrayBackgroundView::~TrayBackgroundView() {
   if (GetWidget())
     GetWidget()->RemoveObserver(widget_observer_.get());
   StopObservingImplicitAnimations();
 }
 
 void TrayBackgroundView::Initialize() {
   GetWidget()->AddObserver(widget_observer_.get());
@@ skipping 51 matching lines @@
     layer()->SetTransform(transform);
   } else {
     // Listen only to the hide animation. As we cannot turn off visibility
     // until the animation is over.
     animation.AddObserver(this);
     animation.SetTweenType(gfx::Tween::EASE_IN);
     layer()->SetOpacity(0.0f);
     layer()->SetVisible(false);
     HideTransformation();
   }
+  // OnTrayVisibilityChanged will only be called if the visibility of the tray

[James Cook, 2016/08/11 20:36:55]

Is this still true? I don't understand what you're saying here.

[yiyix, 2016/08/18 00:43:00]

If the visibility is the same as before, then if statement in front of the
function returns true (if (visible == layer()->GetTargetVisibility())) so my
function will be called if the visibility is changed.

+  // item is changed.
+  wm_shelf_->GetStatusAreaWidget()->OnTrayVisibilityChanged(this);
 }
 
 const char* TrayBackgroundView::GetClassName() const {
   return kViewClassName;
 }
 
 void TrayBackgroundView::ChildPreferredSizeChanged(views::View* child) {
   PreferredSizeChanged();
 }
 
@@ skipping 34 matching lines @@
   SetLayoutManager(new views::BoxLayout(views::BoxLayout::kVertical, 0, 0, 0));
   AddChildView(contents);
 }
 void TrayBackgroundView::SetContentsBackground() {
   background_ = new TrayBackground(this);
   tray_container_->set_background(background_);
 }
 
 void TrayBackgroundView::SetShelfAlignment(ShelfAlignment alignment) {
   shelf_alignment_ = alignment;
+  CalculateAndSetTrayContainerBorder();
   tray_container_->SetAlignment(alignment);
 }
 
+void TrayBackgroundView::CalculateAndSetTrayContainerBorder() {
+  if (!MaterialDesignController::IsShelfMaterial()) {
+    tray_container()->SetBorder(views::Border::NullBorder());
+    return;
+  }
+  // Extend hit region horizontally or vertically depending on shelf alignment.
+  const gfx::Insets insets(
+      IsHorizontalAlignment(shelf()->GetAlignment())
+          ? gfx::Insets(0, kHitRegionPadding, 0,
+                        kHitRegionPadding + kSeparatorWidth)
+          : gfx::Insets(kHitRegionPadding, 0,
+                        kHitRegionPadding + kSeparatorWidth, 0));
+  tray_container()->SetBorder(views::Border::CreateEmptyBorder(insets));
+}
+
 void TrayBackgroundView::OnImplicitAnimationsCompleted() {
   // If there is another animation in the queue, the reverse animation was
   // triggered before the completion of animating to invisible. Do not turn off
   // the visibility so that the next animation may render. The value of
   // layer()->GetTargetVisibility() can be incorrect if the hide animation was
   // aborted to schedule an animation to become visible. As the new animation
   // is not yet added to the queue. crbug.com/374236
   if (layer()->GetAnimator()->is_animating() || layer()->GetTargetVisibility())
     return;
   views::View::SetVisible(false);
@@ skipping 117 matching lines @@
   // Nothing to do here.
 }
 
 void TrayBackgroundView::UpdateShelfItemBackground(int alpha) {
   if (background_) {
     background_->set_alpha(alpha);
     SchedulePaint();
   }
 }
 
+void TrayBackgroundView::SetSeparatorVisibility(bool is_shown) {
+  is_separator_visible_ = is_shown;
+}
+
+void TrayBackgroundView::OnPaint(gfx::Canvas* canvas) {
+  if (!MaterialDesignController::IsShelfMaterial() ||
+      shelf()->GetBackgroundType() ==
+          ShelfBackgroundType::SHELF_BACKGROUND_DEFAULT ||
+      !is_separator_visible_) {
+    return;
+  }
+
+  const int height = kTrayItemSize;
+  const int width = kSeparatorWidth;
+  const int x = kTrayItemSize + kHitRegionPadding + kHitRegionPadding;
+  const int y = (GetShelfConstant(SHELF_SIZE) - kTrayItemSize) / 2;
+  const float scale = canvas->UndoDeviceScaleFactor();

[James Cook, 2016/08/11 22:39:13]

Also, I still think this should go inside the scoped_canvas below. It affects
the scaling of the canvas, which should affect its matrix. Per SkCanvas.h, the
canvas->save() call inside ScopedCanvas should preserve the matrix.

https://cs.chromium.org/chromium/src/third_party/skia/include/core/SkCanvas.h...

Also, the example you cite puts the UndoDeviceScaleFactor inside the
ScopedCanvas.

https://cs.chromium.org/chromium/src/ui/views/painter.cc?sq=package:chromium&...

Maybe I'm wrong? I'm not super-familiar with SkCanvas.

[yiyix, 2016/08/18 00:43:00]

Do you mean change the order of const float scale =
canvas->UndoDeviceScaleFactor(); and gfx::ScopedCanvas scoped_canvas(canvas); so
everything happens in the saved canvas? I can do that. I am not familiar with
this part of code too.

+  SkPaint paint;
+  paint.setColor(kSeparatorColor);
+  paint.setAntiAlias(true);
+  const bool horizontal_shelf = IsHorizontalAlignment(shelf()->GetAlignment());
+  const gfx::Rect bounds = horizontal_shelf ? gfx::Rect(x, y, width, height)
+                                            : gfx::Rect(y, x, height, width);
+  gfx::ScopedCanvas scoped_canvas(canvas);
+  gfx::RectF rect(gfx::ScaleRect(gfx::RectF(bounds), scale));
+  canvas->DrawLine(horizontal_shelf ? rect.top_right() : rect.bottom_left(),
+                   rect.bottom_right(), paint);
+}
+
 }  // namespace ash