[ash-md] Adds support for Z-order iteration in views::View

ui/views/view_unittest.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 "ui/views/view.h"
 
 #include <stddef.h>
 
 #include <map>
 #include <memory>
@@ skipping 4651 matching lines @@
   EXPECT_FALSE(view.layer());
   // Ensure the layer went away via VisibilityChanged().
   EXPECT_TRUE(view.was_hidden());
 
   // Not removed from Widget until Close() completes.
   EXPECT_TRUE(view.GetWidget());
   base::RunLoop().RunUntilIdle();  // Let the Close() complete.
   EXPECT_FALSE(view.GetWidget());
 }
 
+// A View that keeps the children with a special ID above other children.
+class OrderableView : public View {
+ public:
+  static const int VIEW_ID_RAISED = 1000;

[sky, 2017/01/03 21:46:36]

constexpr and a description.

[varkha, 2017/01/03 22:21:35]

Done.

+
+  OrderableView() : View() {}
+  ~OrderableView() override {}
+
+  View::Views GetChildrenInZOrder() override {
+    View::Views children;
+    // Iterate over regular children and later over the raised children to
+    // create a custom Z-order.
+    for (int i = 0; i < child_count(); ++i) {
+      if (child_at(i)->id() != VIEW_ID_RAISED)
+        children.push_back(child_at(i));
+    }
+    for (int i = 0; i < child_count(); ++i) {
+      if (child_at(i)->id() == VIEW_ID_RAISED)
+        children.push_back(child_at(i));
+    }
+    DCHECK_EQ(child_count(), static_cast<int>(children.size()));
+    return children;
+  }
+
+ private:
+  DISALLOW_COPY_AND_ASSIGN(OrderableView);
+};
+
+TEST_F(ViewTest, ChildViewZOrderChanged) {
+  const int kChildrenCount = 4;
+  std::unique_ptr<View> view(new OrderableView());
+  view->SetPaintToLayer(true);
+  for (int i = 0; i < kChildrenCount; ++i)
+    AddViewWithChildLayer(view.get());
+  View::Views children = view->GetChildrenInZOrder();
+  const std::vector<ui::Layer*>& layers = view->layer()->children();
+  EXPECT_EQ(kChildrenCount, static_cast<int>(layers.size()));
+  EXPECT_EQ(kChildrenCount, static_cast<int>(children.size()));
+  for (int i = 0; i < kChildrenCount; ++i) {
+    EXPECT_EQ(view->child_at(i)->layer(), layers[i]);
+    EXPECT_EQ(view->child_at(i), children[i]);
+  }
+
+  // Raise one of the children in z-order and add another child to reorder.
+  view->child_at(2)->set_id(OrderableView::VIEW_ID_RAISED);
+  AddViewWithChildLayer(view.get());
+
+  // 2nd child should be now on top, i.e. the last element in the array returned
+  // by GetChildrenInZOrder(). Its layer should also be above the others.
+  // The rest of the children and layers order should be unchanged.
+  const int expected_order[] = {0, 1, 3, 4, 2};
+  children = view->GetChildrenInZOrder();
+  EXPECT_EQ(kChildrenCount + 1, static_cast<int>(children.size()));
+  EXPECT_EQ(kChildrenCount + 1, static_cast<int>(layers.size()));
+  for (size_t i = 0; i < kChildrenCount + 1; ++i) {
+    EXPECT_EQ(view->child_at(expected_order[i]), children[i]);
+    EXPECT_EQ(view->child_at(expected_order[i])->layer(), layers[i]);
+  }
+}
+
 ////////////////////////////////////////////////////////////////////////////////
 // Observer tests.
 ////////////////////////////////////////////////////////////////////////////////
 
 class ViewObserverTest : public ViewTest, public ViewObserver {
  public:
   ViewObserverTest()
       : child_view_added_times_(0),
         child_view_removed_times_(0),
         child_view_added_(nullptr),
@@ skipping 139 matching lines @@
   std::unique_ptr<View> view = NewView();
   std::unique_ptr<View> child_view = NewView();
   std::unique_ptr<View> child_view2 = NewView();
   view->AddChildView(child_view.get());
   view->AddChildView(child_view2.get());
   view->ReorderChildView(child_view2.get(), 0);
   EXPECT_EQ(child_view2.get(), view_reordered());
 }
 
 }  // namespace views