[ash-md] Makes Wi-Fi header row sticky when network list is scrolled

ash/common/system/tray/tray_details_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_details_view.h"
 
 #include "ash/common/material_design/material_design_controller.h"
 #include "ash/common/system/tray/fixed_sized_scroll_view.h"
 #include "ash/common/system/tray/system_tray.h"
 #include "ash/common/system/tray/system_tray_item.h"
 #include "ash/common/system/tray/tray_constants.h"
 #include "ui/gfx/canvas.h"
 #include "ui/views/background.h"
 #include "ui/views/border.h"
 #include "ui/views/controls/scroll_view.h"
 #include "ui/views/layout/box_layout.h"
 
-namespace ash {
+namespace {
+
+const int kHeaderRowId = 1000;
+const int kHeaderRowSeparatorThickness = 1;
+const SkColor kHeaderRowSeparatorColor = SkColorSetA(SK_ColorBLACK, 0x1F);
+
+// A view that is used as ScrollView contents. It supports designating some of
+// the children as sticky header rows. The sticky header rows are not scrolled
+// above the top of the visible viewport and are painted above other children.
+// To indicate that a child is a sticky header row use set_id(kHeaderRowId).
+class ScrollContentsView : public views::View {
+ public:
+  ScrollContentsView(ash::TrayDetailsView* tray_details_view) {}
+  ~ScrollContentsView() override {}
+
+ protected:
+  // views::View.
+  void OnBoundsChanged(const gfx::Rect& previous_bounds) override {
+    ScrollChildren();
+  }
+
+  void PaintChildren(const ui::PaintContext& context) override {
+    for (int i = 0, count = child_count(); i < count; ++i) {
+      if (child_at(i)->id() != kHeaderRowId && !child_at(i)->layer())
+        child_at(i)->Paint(context);
+    }
+    // Paint header rows above other children in Z-order.
+    for (auto& header : headers_) {
+      if (!header.view->layer())
+        header.view->Paint(context);
+    }
+  }
+
+  void Layout() override {
+    views::View::Layout();
+    headers_.clear();
+    for (int i = 0, count = child_count(); i < count; ++i) {
+      views::View* header = child_at(i);
+      if (header->id() == kHeaderRowId)
+        headers_.push_back(Header(header));
+    }
+    ScrollChildren();
+  }
+
+  void ViewHierarchyChanged(
+      const ViewHierarchyChangedDetails& details) override {
+    if (!details.is_add && details.parent == this) {
+      auto header = std::find(headers_.begin(), headers_.end(), details.child);
+      if (header != headers_.end())
+        headers_.erase(header);
+    }
+  }
+
+ private:
+  class Header {
+   public:
+    Header(views::View* header) : view(header), offset(header->bounds().y()) {}
+    bool operator==(views::View* other) { return view == other; }
+
+    views::View* view;
+    int offset;
+  };
+
+  // Sets decorations on a header row to indicate whether it is sticky.
+  static void ShowHeaderSticky(views::View* header, bool show_sticky) {
+    if (show_sticky) {
+      header->SetBorder(views::Border::CreateSolidSidedBorder(
+          0, 0, kHeaderRowSeparatorThickness, 0, kHeaderRowSeparatorColor));
+    } else {
+      header->SetBorder(views::Border::CreateSolidSidedBorder(
+          kHeaderRowSeparatorThickness, 0, 0, 0, kHeaderRowSeparatorColor));
+    }
+  }
+
+  // Adjusts y-position of header rows allowing one or two rows to stick to the
+  // top of the visible viewport.
+  void ScrollChildren() {
+    const int scroll_offset = -bounds().y();
+    Header* previous_header = nullptr;
+    for (auto& header : headers_) {
+      gfx::Rect header_bounds = header.view->bounds();
+      if (scroll_offset > header.offset) {
+        header_bounds.set_y(scroll_offset);
+        header.view->SetBoundsRect(header_bounds);
+        ShowHeaderSticky(header.view, true);
+        header.view->Layout();
+        header.view->SchedulePaint();
+        if (previous_header) {
+          header_bounds = previous_header->view->bounds();
+          header_bounds.set_y(previous_header->offset);
+          previous_header->view->SetBoundsRect(header_bounds);
+          ShowHeaderSticky(previous_header->view, false);
+        }
+        previous_header = &header;
+      } else if (previous_header &&
+                 header_bounds.y() < previous_header->view->bounds().bottom()) {
+        gfx::Rect previous_header_bounds = previous_header->view->bounds();
+        previous_header_bounds.set_y(header_bounds.y() -
+                                     previous_header->view->bounds().height());
+        previous_header->view->SetBoundsRect(previous_header_bounds);
+        ShowHeaderSticky(previous_header->view, false);
+        ShowHeaderSticky(header.view, false);
+      } else {
+        ShowHeaderSticky(header.view, false);
+      }
+    }
+  }
+
+  // Header child views that stick to the top of visible viewport when scrolled.
+  std::vector<Header> headers_;
+
+  DISALLOW_COPY_AND_ASSIGN(ScrollContentsView);
+};
 
 class ScrollSeparator : public views::View {
  public:
   ScrollSeparator() {}
 
   ~ScrollSeparator() override {}
 
  private:
-  // Overriden from views::View.
+  // views::View.
   void OnPaint(gfx::Canvas* canvas) override {
-    canvas->FillRect(gfx::Rect(0, height() / 2, width(), 1), kBorderLightColor);
+    canvas->FillRect(gfx::Rect(0, height() / 2, width(), 1),
+                     ash::kBorderLightColor);
   }
   gfx::Size GetPreferredSize() const override {
-    return gfx::Size(1, kTrayPopupScrollSeparatorHeight);
+    return gfx::Size(1, ash::kTrayPopupScrollSeparatorHeight);
   }
 
   DISALLOW_COPY_AND_ASSIGN(ScrollSeparator);
 };
 
+}  // namespace
+
+namespace ash {
+
 class ScrollBorder : public views::Border {
  public:
   ScrollBorder() {}
   ~ScrollBorder() override {}
 
   void set_visible(bool visible) { visible_ = visible; }
 
  private:
-  // Overridden from views::Border.
+  // views::Border.
   void Paint(const views::View& view, gfx::Canvas* canvas) override {
     if (!visible_)
       return;
     canvas->FillRect(gfx::Rect(0, view.height() - 1, view.width(), 1),
                      kBorderLightColor);
   }
 
   gfx::Insets GetInsets() const override { return gfx::Insets(0, 0, 1, 0); }
 
   gfx::Size GetMinimumSize() const override { return gfx::Size(0, 1); }
 
-  bool visible_;
+  bool visible_ = false;
 
   DISALLOW_COPY_AND_ASSIGN(ScrollBorder);
 };
 
 TrayDetailsView::TrayDetailsView(SystemTrayItem* owner)
     : owner_(owner),
       title_row_(nullptr),
       scroller_(nullptr),
       scroll_content_(nullptr),
       scroll_border_(nullptr),
@@ skipping 37 matching lines @@
   CreateExtraTitleRowButtons();
 
   if (MaterialDesignController::IsSystemTrayMenuMaterial())
     back_button_ = title_row_->AddBackButton(this);
 
   Layout();
 }
 
 void TrayDetailsView::CreateScrollableList() {
   DCHECK(!scroller_);
-  scroll_content_ = new views::View;
+  scroll_content_ = new ScrollContentsView(this);
   scroll_content_->SetLayoutManager(
       new views::BoxLayout(views::BoxLayout::kVertical, 0, 0, 1));
   scroller_ = new FixedSizedScrollView;
   scroller_->SetContentsView(scroll_content_);
 
   // Note: |scroller_| takes ownership of |scroll_border_|.
   scroll_border_ = new ScrollBorder;
   scroller_->SetBorder(std::unique_ptr<views::Border>(scroll_border_));
 
   AddChildView(scroller_);
@@ skipping 74 matching lines @@
     if (index < child_count() - 1 && child_at(index + 1) != title_row_)
       scroll_border_->set_visible(true);
     else
       scroll_border_->set_visible(false);
   }
 
   views::View::OnPaintBorder(canvas);
 }
 
 }  // namespace ash