forked from chromium/chromium
-
Notifications
You must be signed in to change notification settings - Fork 0
/
scroll_view_unittest.cc
2404 lines (1984 loc) · 97.1 KB
/
scroll_view_unittest.cc
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// 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/controls/scroll_view.h"
#include <algorithm>
#include <memory>
#include <string>
#include <utility>
#include "base/memory/raw_ptr.h"
#include "base/run_loop.h"
#include "base/scoped_observation.h"
#include "base/test/icu_test_util.h"
#include "base/test/scoped_feature_list.h"
#include "base/test/test_timeouts.h"
#include "base/threading/thread_task_runner_handle.h"
#include "base/timer/timer.h"
#include "build/build_config.h"
#include "testing/gtest/include/gtest/gtest.h"
#include "third_party/abseil-cpp/absl/types/optional.h"
#include "ui/base/ui_base_features.h"
#include "ui/compositor/compositor.h"
#include "ui/compositor/layer.h"
#include "ui/compositor/scoped_animation_duration_scale_mode.h"
#include "ui/events/keycodes/keyboard_codes.h"
#include "ui/events/test/event_generator.h"
#include "ui/events/types/event_type.h"
#include "ui/gfx/geometry/point_f.h"
#include "ui/views/border.h"
#include "ui/views/controls/scrollbar/base_scroll_bar_thumb.h"
#include "ui/views/controls/scrollbar/overlay_scroll_bar.h"
#include "ui/views/controls/scrollbar/scroll_bar_views.h"
#include "ui/views/test/test_views.h"
#include "ui/views/test/views_test_base.h"
#include "ui/views/test/widget_test.h"
#include "ui/views/view_observer.h"
#include "ui/views/view_test_api.h"
#if BUILDFLAG(IS_MAC)
#include "ui/base/test/scoped_preferred_scroller_style_mac.h"
#endif
enum ScrollBarOrientation { HORIZONTAL, VERTICAL };
namespace views {
namespace test {
class ScrollViewTestApi {
public:
explicit ScrollViewTestApi(ScrollView* scroll_view)
: scroll_view_(scroll_view) {}
ScrollViewTestApi(const ScrollViewTestApi&) = delete;
ScrollViewTestApi& operator=(const ScrollViewTestApi&) = delete;
~ScrollViewTestApi() = default;
ScrollBar* GetScrollBar(ScrollBarOrientation orientation) {
ScrollBar* scroll_bar = orientation == VERTICAL
? scroll_view_->vertical_scroll_bar()
: scroll_view_->horizontal_scroll_bar();
return scroll_bar;
}
const base::OneShotTimer& GetScrollBarTimer(
ScrollBarOrientation orientation) {
return GetScrollBar(orientation)->repeater_.timer_for_testing();
}
BaseScrollBarThumb* GetScrollBarThumb(ScrollBarOrientation orientation) {
return GetScrollBar(orientation)->thumb_;
}
gfx::Vector2d IntegralViewOffset() {
return gfx::Point() - gfx::ToFlooredPoint(CurrentOffset());
}
gfx::PointF CurrentOffset() const { return scroll_view_->CurrentOffset(); }
base::RetainingOneShotTimer* GetScrollBarHideTimer(
ScrollBarOrientation orientation) {
return ScrollBar::GetHideTimerForTesting(GetScrollBar(orientation));
}
View* corner_view() { return scroll_view_->corner_view_.get(); }
View* contents_viewport() { return scroll_view_->contents_viewport_; }
View* more_content_left() { return scroll_view_->more_content_left_.get(); }
View* more_content_top() { return scroll_view_->more_content_top_.get(); }
View* more_content_right() { return scroll_view_->more_content_right_.get(); }
View* more_content_bottom() {
return scroll_view_->more_content_bottom_.get();
}
private:
raw_ptr<ScrollView> scroll_view_;
};
class ObserveViewDeletion : public ViewObserver {
public:
explicit ObserveViewDeletion(View* view) { observer_.Observe(view); }
void OnViewIsDeleting(View* observed_view) override {
deleted_view_ = observed_view;
observer_.Reset();
}
View* deleted_view() { return deleted_view_; }
private:
base::ScopedObservation<View, ViewObserver> observer_{this};
raw_ptr<View> deleted_view_ = nullptr;
};
} // namespace test
namespace {
const int kWidth = 100;
const int kMinHeight = 50;
const int kMaxHeight = 100;
class FixedView : public View {
public:
FixedView() = default;
FixedView(const FixedView&) = delete;
FixedView& operator=(const FixedView&) = delete;
~FixedView() override = default;
void Layout() override {
gfx::Size pref = GetPreferredSize();
SetBounds(x(), y(), pref.width(), pref.height());
}
void SetFocus() { Focus(); }
};
class CustomView : public View {
public:
CustomView() = default;
CustomView(const CustomView&) = delete;
CustomView& operator=(const CustomView&) = delete;
~CustomView() override = default;
const gfx::Point last_location() const { return last_location_; }
void Layout() override {
gfx::Size pref = GetPreferredSize();
int width = pref.width();
int height = pref.height();
if (parent()) {
width = std::max(parent()->width(), width);
height = std::max(parent()->height(), height);
}
SetBounds(x(), y(), width, height);
}
bool OnMousePressed(const ui::MouseEvent& event) override {
last_location_ = event.location();
return true;
}
private:
gfx::Point last_location_;
};
void CheckScrollbarVisibility(const ScrollView* scroll_view,
ScrollBarOrientation orientation,
bool should_be_visible) {
const ScrollBar* scrollbar = orientation == HORIZONTAL
? scroll_view->horizontal_scroll_bar()
: scroll_view->vertical_scroll_bar();
if (should_be_visible) {
ASSERT_TRUE(scrollbar);
EXPECT_TRUE(scrollbar->GetVisible());
} else {
EXPECT_TRUE(!scrollbar || !scrollbar->GetVisible());
}
}
ui::MouseEvent TestLeftMouseAt(const gfx::Point& location, ui::EventType type) {
return ui::MouseEvent(type, location, location, base::TimeTicks(),
ui::EF_LEFT_MOUSE_BUTTON, ui::EF_LEFT_MOUSE_BUTTON);
}
// This view has a large width, but the height always matches the parent's
// height. This is similar to a TableView that has many columns showing, but
// very few rows.
class VerticalResizingView : public View {
public:
VerticalResizingView() = default;
VerticalResizingView(const VerticalResizingView&) = delete;
VerticalResizingView& operator=(const VerticalResizingView&) = delete;
~VerticalResizingView() override = default;
void Layout() override {
int width = 10000;
int height = parent()->height();
SetBounds(x(), y(), width, height);
}
};
// Same as VerticalResizingView, but horizontal instead.
class HorizontalResizingView : public View {
public:
HorizontalResizingView() = default;
HorizontalResizingView(const HorizontalResizingView&) = delete;
HorizontalResizingView& operator=(const HorizontalResizingView&) = delete;
~HorizontalResizingView() override = default;
void Layout() override {
int height = 10000;
int width = parent()->width();
SetBounds(x(), y(), width, height);
}
};
class TestScrollBarThumb : public BaseScrollBarThumb {
public:
using BaseScrollBarThumb::BaseScrollBarThumb;
// BaseScrollBarThumb:
gfx::Size CalculatePreferredSize() const override { return gfx::Size(1, 1); }
void OnPaint(gfx::Canvas* canvas) override {}
};
class TestScrollBar : public ScrollBar {
public:
TestScrollBar(bool horizontal, bool overlaps_content, int thickness)
: ScrollBar(horizontal),
overlaps_content_(overlaps_content),
thickness_(thickness) {
SetThumb(new TestScrollBarThumb(this));
}
// ScrollBar:
int GetThickness() const override { return thickness_; }
bool OverlapsContent() const override { return overlaps_content_; }
gfx::Rect GetTrackBounds() const override {
gfx::Rect bounds = GetLocalBounds();
bounds.set_width(GetThickness());
return bounds;
}
private:
const bool overlaps_content_ = false;
const int thickness_ = 0;
};
} // namespace
using test::ScrollViewTestApi;
// Simple test harness for testing a ScrollView directly.
class ScrollViewTest : public ViewsTestBase {
public:
ScrollViewTest() = default;
ScrollViewTest(const ScrollViewTest&) = delete;
ScrollViewTest& operator=(const ScrollViewTest&) = delete;
void SetUp() override {
ViewsTestBase::SetUp();
scroll_view_ = std::make_unique<ScrollView>();
}
View* InstallContents() {
const gfx::Rect default_outer_bounds(0, 0, 100, 100);
auto* view = scroll_view_->SetContents(std::make_unique<View>());
scroll_view_->SetBoundsRect(default_outer_bounds);
return view;
}
protected:
#if BUILDFLAG(IS_MAC)
void SetOverlayScrollersEnabled(bool enabled) {
// Ensure the old scroller override is destroyed before creating a new one.
// Otherwise, the swizzlers are interleaved and restore incorrect methods.
scroller_style_.reset();
scroller_style_ =
std::make_unique<ui::test::ScopedPreferredScrollerStyle>(enabled);
}
private:
// Disable overlay scrollers by default. This needs to be set before
// |scroll_view_| is initialized, otherwise scrollers will try to animate to
// change modes, which requires a MessageLoop to exist. Tests should only
// modify this via SetOverlayScrollersEnabled().
std::unique_ptr<ui::test::ScopedPreferredScrollerStyle> scroller_style_ =
std::make_unique<ui::test::ScopedPreferredScrollerStyle>(false);
protected:
#endif
int VerticalScrollBarWidth() {
return scroll_view_->vertical_scroll_bar()->GetThickness();
}
int HorizontalScrollBarHeight() {
return scroll_view_->horizontal_scroll_bar()->GetThickness();
}
std::unique_ptr<ScrollView> scroll_view_;
};
// Test harness that includes a Widget to help test ui::Event handling.
class WidgetScrollViewTest : public test::WidgetTest,
public ui::CompositorObserver {
public:
static constexpr int kDefaultHeight = 100;
static constexpr int kDefaultWidth = 100;
WidgetScrollViewTest() = default;
WidgetScrollViewTest(const WidgetScrollViewTest&) = delete;
WidgetScrollViewTest& operator=(const WidgetScrollViewTest&) = delete;
// Call this before adding the ScrollView to test with overlay scrollbars.
void SetUseOverlayScrollers() { use_overlay_scrollers_ = true; }
// Adds a ScrollView with the given |contents_view| and does layout.
ScrollView* AddScrollViewWithContents(std::unique_ptr<View> contents,
bool commit_layers = true) {
#if BUILDFLAG(IS_MAC)
scroller_style_ = std::make_unique<ui::test::ScopedPreferredScrollerStyle>(
use_overlay_scrollers_);
#endif
const gfx::Rect default_bounds(50, 50, kDefaultWidth, kDefaultHeight);
widget_ = CreateTopLevelFramelessPlatformWidget();
widget_->SetBounds(default_bounds);
widget_->Show();
ScrollView* scroll_view =
widget_->SetContentsView(std::make_unique<ScrollView>());
scroll_view->SetContents(std::move(contents));
scroll_view->Layout();
widget_->GetCompositor()->AddObserver(this);
// Ensure the Compositor has committed layer changes before attempting to
// use them for impl-side scrolling. Note that simply RunUntilIdle() works
// when tests are run in isolation, but compositor scheduling can interact
// between test runs in the general case.
if (commit_layers)
WaitForCommit();
return scroll_view;
}
// Adds a ScrollView with a contents view of the given |size| and does layout.
ScrollView* AddScrollViewWithContentSize(const gfx::Size& contents_size,
bool commit_layers = true) {
auto contents = std::make_unique<View>();
contents->SetSize(contents_size);
return AddScrollViewWithContents(std::move(contents), commit_layers);
}
// Wait for a commit to be observed on the compositor.
void WaitForCommit() {
base::RunLoop run_loop;
quit_closure_ = run_loop.QuitClosure();
base::ThreadTaskRunnerHandle::Get()->PostDelayedTask(
FROM_HERE, quit_closure_, TestTimeouts::action_timeout());
run_loop.Run();
EXPECT_TRUE(quit_closure_.is_null()) << "Timed out waiting for a commit.";
}
void TestClickAt(const gfx::Point& location) {
ui::MouseEvent press(TestLeftMouseAt(location, ui::ET_MOUSE_PRESSED));
ui::MouseEvent release(TestLeftMouseAt(location, ui::ET_MOUSE_RELEASED));
widget_->OnMouseEvent(&press);
widget_->OnMouseEvent(&release);
}
// testing::Test:
void TearDown() override {
widget_->GetCompositor()->RemoveObserver(this);
if (widget_)
widget_->CloseNow();
WidgetTest::TearDown();
}
protected:
Widget* widget() const { return widget_; }
private:
// ui::CompositorObserver:
void OnCompositingDidCommit(ui::Compositor* compositor) override {
quit_closure_.Run();
quit_closure_.Reset();
}
raw_ptr<Widget> widget_ = nullptr;
// Disable scrollbar hiding (i.e. disable overlay scrollbars) by default.
bool use_overlay_scrollers_ = false;
base::RepeatingClosure quit_closure_;
#if BUILDFLAG(IS_MAC)
std::unique_ptr<ui::test::ScopedPreferredScrollerStyle> scroller_style_;
#endif
};
constexpr int WidgetScrollViewTest::kDefaultHeight;
constexpr int WidgetScrollViewTest::kDefaultWidth;
// A gtest parameter to permute over whether ScrollView uses a left-to-right or
// right-to-left locale, or whether it uses ui::Layers or View bounds offsets to
// position contents (i.e. ::features::kUiCompositorScrollWithLayers).
enum class UiConfig { kLtr, kLtrWithLayers, kRtl, kRtlWithLayers };
class WidgetScrollViewTestRTLAndLayers
: public WidgetScrollViewTest,
public ::testing::WithParamInterface<UiConfig> {
public:
WidgetScrollViewTestRTLAndLayers() : locale_(IsTestingRtl() ? "he" : "en") {
if (IsTestingLayers()) {
layer_config_.InitAndEnableFeature(
::features::kUiCompositorScrollWithLayers);
} else {
layer_config_.InitAndDisableFeature(
::features::kUiCompositorScrollWithLayers);
}
}
WidgetScrollViewTestRTLAndLayers(const WidgetScrollViewTestRTLAndLayers&) =
delete;
WidgetScrollViewTestRTLAndLayers& operator=(
const WidgetScrollViewTestRTLAndLayers&) = delete;
bool IsTestingRtl() const {
return GetParam() == UiConfig::kRtl ||
GetParam() == UiConfig::kRtlWithLayers;
}
bool IsTestingLayers() const {
return GetParam() == UiConfig::kLtrWithLayers ||
GetParam() == UiConfig::kRtlWithLayers;
}
// Returns a point in the coordinate space of |target| by translating a point
// inset one pixel from the top of the Widget and one pixel on the leading
// side of the Widget. There should be no scroll bar on this side. If
// |flip_result| is true, automatically account for flipped coordinates in
// RTL.
gfx::Point HitTestInCorner(View* target, bool flip_result = true) const {
const gfx::Point test_mouse_point_in_root =
IsTestingRtl() ? gfx::Point(kDefaultWidth - 1, 1) : gfx::Point(1, 1);
gfx::Point point = test_mouse_point_in_root;
View::ConvertPointToTarget(widget()->GetRootView(), target, &point);
if (flip_result)
return gfx::Point(target->GetMirroredXInView(point.x()), point.y());
return point;
}
private:
base::test::ScopedRestoreICUDefaultLocale locale_;
base::test::ScopedFeatureList layer_config_;
};
std::string UiConfigToString(const testing::TestParamInfo<UiConfig>& info) {
switch (info.param) {
case UiConfig::kLtr:
return "LTR";
case UiConfig::kLtrWithLayers:
return "LTR_LAYERS";
case UiConfig::kRtl:
return "RTL";
case UiConfig::kRtlWithLayers:
return "RTL_LAYERS";
}
NOTREACHED();
return std::string();
}
// Verifies the viewport is sized to fit the available space.
TEST_F(ScrollViewTest, ViewportSizedToFit) {
View* contents = InstallContents();
scroll_view_->Layout();
EXPECT_EQ("0,0 100x100", contents->parent()->bounds().ToString());
}
// Verifies the viewport and content is sized to fit the available space for
// bounded scroll view.
TEST_F(ScrollViewTest, BoundedViewportSizedToFit) {
View* contents = InstallContents();
scroll_view_->ClipHeightTo(100, 200);
scroll_view_->SetBorder(CreateSolidBorder(2, 0));
scroll_view_->Layout();
EXPECT_EQ("2,2 96x96", contents->parent()->bounds().ToString());
// Make sure the width of |contents| is set properly not to overflow the
// viewport.
EXPECT_EQ(96, contents->width());
}
// Verifies that the vertical scrollbar does not unnecessarily appear for a
// contents whose height always matches the height of the viewport.
TEST_F(ScrollViewTest, VerticalScrollbarDoesNotAppearUnnecessarily) {
const gfx::Rect default_outer_bounds(0, 0, 100, 100);
scroll_view_->SetContents(std::make_unique<VerticalResizingView>());
scroll_view_->SetBoundsRect(default_outer_bounds);
scroll_view_->Layout();
EXPECT_FALSE(scroll_view_->vertical_scroll_bar()->GetVisible());
EXPECT_TRUE(scroll_view_->horizontal_scroll_bar()->GetVisible());
}
// Same as above, but setting horizontal scroll bar to hidden.
TEST_F(ScrollViewTest, HorizontalScrollbarDoesNotAppearIfHidden) {
const gfx::Rect default_outer_bounds(0, 0, 100, 100);
scroll_view_->SetHorizontalScrollBarMode(
ScrollView::ScrollBarMode::kHiddenButEnabled);
scroll_view_->SetContents(std::make_unique<VerticalResizingView>());
scroll_view_->SetBoundsRect(default_outer_bounds);
scroll_view_->Layout();
EXPECT_FALSE(scroll_view_->vertical_scroll_bar()->GetVisible());
EXPECT_FALSE(scroll_view_->horizontal_scroll_bar()->GetVisible());
}
// Same as above, but setting vertical scrollbar instead.
TEST_F(ScrollViewTest, VerticalScrollbarDoesNotAppearIfHidden) {
const gfx::Rect default_outer_bounds(0, 0, 100, 100);
scroll_view_->SetVerticalScrollBarMode(
ScrollView::ScrollBarMode::kHiddenButEnabled);
scroll_view_->SetContents(std::make_unique<HorizontalResizingView>());
scroll_view_->SetBoundsRect(default_outer_bounds);
scroll_view_->Layout();
EXPECT_FALSE(scroll_view_->vertical_scroll_bar()->GetVisible());
EXPECT_FALSE(scroll_view_->horizontal_scroll_bar()->GetVisible());
}
// Same as above, but setting horizontal scroll bar to disabled.
TEST_F(ScrollViewTest, HorizontalScrollbarDoesNotAppearIfDisabled) {
const gfx::Rect default_outer_bounds(0, 0, 100, 100);
scroll_view_->SetHorizontalScrollBarMode(
ScrollView::ScrollBarMode::kDisabled);
scroll_view_->SetContents(std::make_unique<VerticalResizingView>());
scroll_view_->SetBoundsRect(default_outer_bounds);
scroll_view_->Layout();
EXPECT_FALSE(scroll_view_->vertical_scroll_bar()->GetVisible());
EXPECT_FALSE(scroll_view_->horizontal_scroll_bar()->GetVisible());
}
// Same as above, but setting vertical scrollbar instead.
TEST_F(ScrollViewTest, VerticallScrollbarDoesNotAppearIfDisabled) {
const gfx::Rect default_outer_bounds(0, 0, 100, 100);
scroll_view_->SetVerticalScrollBarMode(ScrollView::ScrollBarMode::kDisabled);
scroll_view_->SetContents(std::make_unique<HorizontalResizingView>());
scroll_view_->SetBoundsRect(default_outer_bounds);
scroll_view_->Layout();
EXPECT_FALSE(scroll_view_->vertical_scroll_bar()->GetVisible());
EXPECT_FALSE(scroll_view_->horizontal_scroll_bar()->GetVisible());
}
// Verifies the scrollbars are added as necessary.
// If on Mac, test the non-overlay scrollbars.
TEST_F(ScrollViewTest, ScrollBars) {
View* contents = InstallContents();
// Size the contents such that vertical scrollbar is needed.
contents->SetBounds(0, 0, 50, 400);
scroll_view_->Layout();
EXPECT_EQ(100 - scroll_view_->GetScrollBarLayoutWidth(),
contents->parent()->width());
EXPECT_EQ(100, contents->parent()->height());
CheckScrollbarVisibility(scroll_view_.get(), VERTICAL, true);
CheckScrollbarVisibility(scroll_view_.get(), HORIZONTAL, false);
EXPECT_TRUE(!scroll_view_->horizontal_scroll_bar() ||
!scroll_view_->horizontal_scroll_bar()->GetVisible());
ASSERT_TRUE(scroll_view_->vertical_scroll_bar() != nullptr);
EXPECT_TRUE(scroll_view_->vertical_scroll_bar()->GetVisible());
// Size the contents such that horizontal scrollbar is needed.
contents->SetBounds(0, 0, 400, 50);
scroll_view_->Layout();
EXPECT_EQ(100, contents->parent()->width());
EXPECT_EQ(100 - scroll_view_->GetScrollBarLayoutHeight(),
contents->parent()->height());
CheckScrollbarVisibility(scroll_view_.get(), VERTICAL, false);
CheckScrollbarVisibility(scroll_view_.get(), HORIZONTAL, true);
// Both horizontal and vertical.
contents->SetBounds(0, 0, 300, 400);
scroll_view_->Layout();
EXPECT_EQ(100 - scroll_view_->GetScrollBarLayoutWidth(),
contents->parent()->width());
EXPECT_EQ(100 - scroll_view_->GetScrollBarLayoutHeight(),
contents->parent()->height());
CheckScrollbarVisibility(scroll_view_.get(), VERTICAL, true);
CheckScrollbarVisibility(scroll_view_.get(), HORIZONTAL, true);
// Add a border, test vertical scrollbar.
const int kTopPadding = 1;
const int kLeftPadding = 2;
const int kBottomPadding = 3;
const int kRightPadding = 4;
scroll_view_->SetBorder(CreateEmptyBorder(gfx::Insets::TLBR(
kTopPadding, kLeftPadding, kBottomPadding, kRightPadding)));
contents->SetBounds(0, 0, 50, 400);
scroll_view_->Layout();
EXPECT_EQ(100 - scroll_view_->GetScrollBarLayoutWidth() - kLeftPadding -
kRightPadding,
contents->parent()->width());
EXPECT_EQ(100 - kTopPadding - kBottomPadding, contents->parent()->height());
EXPECT_TRUE(!scroll_view_->horizontal_scroll_bar() ||
!scroll_view_->horizontal_scroll_bar()->GetVisible());
ASSERT_TRUE(scroll_view_->vertical_scroll_bar() != nullptr);
EXPECT_TRUE(scroll_view_->vertical_scroll_bar()->GetVisible());
gfx::Rect bounds = scroll_view_->vertical_scroll_bar()->bounds();
EXPECT_EQ(100 - VerticalScrollBarWidth() - kRightPadding, bounds.x());
EXPECT_EQ(100 - kRightPadding, bounds.right());
EXPECT_EQ(kTopPadding, bounds.y());
EXPECT_EQ(100 - kBottomPadding, bounds.bottom());
// Horizontal with border.
contents->SetBounds(0, 0, 400, 50);
scroll_view_->Layout();
EXPECT_EQ(100 - kLeftPadding - kRightPadding, contents->parent()->width());
EXPECT_EQ(100 - scroll_view_->GetScrollBarLayoutHeight() - kTopPadding -
kBottomPadding,
contents->parent()->height());
ASSERT_TRUE(scroll_view_->horizontal_scroll_bar() != nullptr);
EXPECT_TRUE(scroll_view_->horizontal_scroll_bar()->GetVisible());
EXPECT_TRUE(!scroll_view_->vertical_scroll_bar() ||
!scroll_view_->vertical_scroll_bar()->GetVisible());
bounds = scroll_view_->horizontal_scroll_bar()->bounds();
EXPECT_EQ(kLeftPadding, bounds.x());
EXPECT_EQ(100 - kRightPadding, bounds.right());
EXPECT_EQ(100 - kBottomPadding - HorizontalScrollBarHeight(), bounds.y());
EXPECT_EQ(100 - kBottomPadding, bounds.bottom());
// Both horizontal and vertical with border.
contents->SetBounds(0, 0, 300, 400);
scroll_view_->Layout();
EXPECT_EQ(100 - scroll_view_->GetScrollBarLayoutWidth() - kLeftPadding -
kRightPadding,
contents->parent()->width());
EXPECT_EQ(100 - scroll_view_->GetScrollBarLayoutHeight() - kTopPadding -
kBottomPadding,
contents->parent()->height());
bounds = scroll_view_->horizontal_scroll_bar()->bounds();
// Check horiz.
ASSERT_TRUE(scroll_view_->horizontal_scroll_bar() != nullptr);
EXPECT_TRUE(scroll_view_->horizontal_scroll_bar()->GetVisible());
bounds = scroll_view_->horizontal_scroll_bar()->bounds();
EXPECT_EQ(kLeftPadding, bounds.x());
EXPECT_EQ(100 - kRightPadding - VerticalScrollBarWidth(), bounds.right());
EXPECT_EQ(100 - kBottomPadding - HorizontalScrollBarHeight(), bounds.y());
EXPECT_EQ(100 - kBottomPadding, bounds.bottom());
// Check vert.
ASSERT_TRUE(scroll_view_->vertical_scroll_bar() != nullptr);
EXPECT_TRUE(scroll_view_->vertical_scroll_bar()->GetVisible());
bounds = scroll_view_->vertical_scroll_bar()->bounds();
EXPECT_EQ(100 - VerticalScrollBarWidth() - kRightPadding, bounds.x());
EXPECT_EQ(100 - kRightPadding, bounds.right());
EXPECT_EQ(kTopPadding, bounds.y());
EXPECT_EQ(100 - kBottomPadding - HorizontalScrollBarHeight(),
bounds.bottom());
}
// Assertions around adding a header.
TEST_F(WidgetScrollViewTest, Header) {
auto contents_ptr = std::make_unique<View>();
auto* contents = contents_ptr.get();
ScrollView* scroll_view = AddScrollViewWithContents(std::move(contents_ptr));
auto* header = scroll_view->SetHeader(std::make_unique<CustomView>());
View* header_parent = header->parent();
widget()->LayoutRootViewIfNecessary();
// |header|s preferred size is empty, which should result in all space going
// to contents.
EXPECT_EQ("0,0 100x0", header->parent()->bounds().ToString());
EXPECT_EQ("0,0 100x100", contents->parent()->bounds().ToString());
// With layered scrolling, ScrollView::Layout() will impose a size on the
// contents that fills the viewport. Since the test view doesn't have its own
// Layout, reset it in this case so that adding a header doesn't shift the
// contents down and require scrollbars.
if (contents->layer()) {
EXPECT_EQ("0,0 100x100", contents->bounds().ToString());
contents->SetBoundsRect(gfx::Rect());
}
EXPECT_EQ("0,0 0x0", contents->bounds().ToString());
// Get the header a height of 20.
header->SetPreferredSize(gfx::Size(10, 20));
EXPECT_TRUE(ViewTestApi(scroll_view).needs_layout());
widget()->LayoutRootViewIfNecessary();
EXPECT_EQ("0,0 100x20", header->parent()->bounds().ToString());
EXPECT_EQ("0,20 100x80", contents->parent()->bounds().ToString());
if (contents->layer()) {
EXPECT_EQ("0,0 100x80", contents->bounds().ToString());
contents->SetBoundsRect(gfx::Rect());
}
EXPECT_EQ("0,0 0x0", contents->bounds().ToString());
// Remove the header.
scroll_view->SetHeader(nullptr);
// SetHeader(nullptr) deletes header.
header = nullptr;
widget()->LayoutRootViewIfNecessary();
EXPECT_EQ("0,0 100x0", header_parent->bounds().ToString());
EXPECT_EQ("0,0 100x100", contents->parent()->bounds().ToString());
}
// Verifies the scrollbars are added as necessary when a header is present.
TEST_F(ScrollViewTest, ScrollBarsWithHeader) {
auto* header = scroll_view_->SetHeader(std::make_unique<CustomView>());
View* contents = InstallContents();
header->SetPreferredSize(gfx::Size(10, 20));
// Size the contents such that vertical scrollbar is needed.
contents->SetBounds(0, 0, 50, 400);
scroll_view_->Layout();
EXPECT_EQ(0, contents->parent()->x());
EXPECT_EQ(20, contents->parent()->y());
EXPECT_EQ(100 - scroll_view_->GetScrollBarLayoutWidth(),
contents->parent()->width());
EXPECT_EQ(80, contents->parent()->height());
EXPECT_EQ(0, header->parent()->x());
EXPECT_EQ(0, header->parent()->y());
EXPECT_EQ(100 - scroll_view_->GetScrollBarLayoutWidth(),
header->parent()->width());
EXPECT_EQ(20, header->parent()->height());
EXPECT_TRUE(!scroll_view_->horizontal_scroll_bar() ||
!scroll_view_->horizontal_scroll_bar()->GetVisible());
ASSERT_TRUE(scroll_view_->vertical_scroll_bar() != nullptr);
EXPECT_TRUE(scroll_view_->vertical_scroll_bar()->GetVisible());
// Make sure the vertical scrollbar overlaps the header for traditional
// scrollbars and doesn't overlap the header for overlay scrollbars.
const int expected_scrollbar_y =
scroll_view_->vertical_scroll_bar()->OverlapsContent()
? header->bounds().bottom()
: header->y();
EXPECT_EQ(expected_scrollbar_y, scroll_view_->vertical_scroll_bar()->y());
EXPECT_EQ(header->y(), contents->y());
// Size the contents such that horizontal scrollbar is needed.
contents->SetBounds(0, 0, 400, 50);
scroll_view_->Layout();
EXPECT_EQ(0, contents->parent()->x());
EXPECT_EQ(20, contents->parent()->y());
EXPECT_EQ(100, contents->parent()->width());
EXPECT_EQ(100 - scroll_view_->GetScrollBarLayoutHeight() - 20,
contents->parent()->height());
EXPECT_EQ(0, header->parent()->x());
EXPECT_EQ(0, header->parent()->y());
EXPECT_EQ(100, header->parent()->width());
EXPECT_EQ(20, header->parent()->height());
ASSERT_TRUE(scroll_view_->horizontal_scroll_bar() != nullptr);
EXPECT_TRUE(scroll_view_->horizontal_scroll_bar()->GetVisible());
EXPECT_TRUE(!scroll_view_->vertical_scroll_bar() ||
!scroll_view_->vertical_scroll_bar()->GetVisible());
// Both horizontal and vertical.
contents->SetBounds(0, 0, 300, 400);
scroll_view_->Layout();
EXPECT_EQ(0, contents->parent()->x());
EXPECT_EQ(20, contents->parent()->y());
EXPECT_EQ(100 - scroll_view_->GetScrollBarLayoutWidth(),
contents->parent()->width());
EXPECT_EQ(100 - scroll_view_->GetScrollBarLayoutHeight() - 20,
contents->parent()->height());
EXPECT_EQ(0, header->parent()->x());
EXPECT_EQ(0, header->parent()->y());
EXPECT_EQ(100 - scroll_view_->GetScrollBarLayoutWidth(),
header->parent()->width());
EXPECT_EQ(20, header->parent()->height());
ASSERT_TRUE(scroll_view_->horizontal_scroll_bar() != nullptr);
EXPECT_TRUE(scroll_view_->horizontal_scroll_bar()->GetVisible());
ASSERT_TRUE(scroll_view_->vertical_scroll_bar() != nullptr);
EXPECT_TRUE(scroll_view_->vertical_scroll_bar()->GetVisible());
}
// Verifies the header scrolls horizontally with the content.
TEST_F(ScrollViewTest, HeaderScrollsWithContent) {
ScrollViewTestApi test_api(scroll_view_.get());
auto contents = std::make_unique<CustomView>();
contents->SetPreferredSize(gfx::Size(500, 500));
scroll_view_->SetContents(std::move(contents));
auto* header = scroll_view_->SetHeader(std::make_unique<CustomView>());
header->SetPreferredSize(gfx::Size(500, 20));
scroll_view_->SetBoundsRect(gfx::Rect(0, 0, 100, 100));
EXPECT_EQ(gfx::Vector2d(0, 0), test_api.IntegralViewOffset());
EXPECT_EQ(gfx::Point(0, 0), header->origin());
// Scroll the horizontal scrollbar.
ASSERT_TRUE(scroll_view_->horizontal_scroll_bar());
scroll_view_->ScrollToPosition(test_api.GetScrollBar(HORIZONTAL), 1);
EXPECT_EQ(gfx::Vector2d(-1, 0), test_api.IntegralViewOffset());
EXPECT_EQ(gfx::Point(-1, 0), header->origin());
// Scrolling the vertical scrollbar shouldn't effect the header.
ASSERT_TRUE(scroll_view_->vertical_scroll_bar());
scroll_view_->ScrollToPosition(test_api.GetScrollBar(VERTICAL), 1);
EXPECT_EQ(gfx::Vector2d(-1, -1), test_api.IntegralViewOffset());
EXPECT_EQ(gfx::Point(-1, 0), header->origin());
}
// Test that calling ScrollToPosition() also updates the position of the
// corresponding ScrollBar.
TEST_F(ScrollViewTest, ScrollToPositionUpdatesScrollBar) {
ScrollViewTestApi test_api(scroll_view_.get());
View* contents = InstallContents();
// Scroll the horizontal scrollbar, after which, the scroll bar thumb position
// should be updated (i.e. it should be non-zero).
contents->SetBounds(0, 0, 400, 50);
scroll_view_->Layout();
auto* scroll_bar = test_api.GetScrollBar(HORIZONTAL);
ASSERT_TRUE(scroll_bar);
EXPECT_TRUE(scroll_bar->GetVisible());
EXPECT_EQ(0, scroll_bar->GetPosition());
scroll_view_->ScrollToPosition(scroll_bar, 20);
EXPECT_GT(scroll_bar->GetPosition(), 0);
// Scroll the vertical scrollbar.
contents->SetBounds(0, 0, 50, 400);
scroll_view_->Layout();
scroll_bar = test_api.GetScrollBar(VERTICAL);
ASSERT_TRUE(scroll_bar);
EXPECT_TRUE(scroll_bar->GetVisible());
EXPECT_EQ(0, scroll_bar->GetPosition());
scroll_view_->ScrollToPosition(scroll_bar, 20);
EXPECT_GT(scroll_bar->GetPosition(), 0);
}
// Test that calling ScrollToPosition() also updates the position of the
// child view even when the horizontal scrollbar is hidden.
TEST_F(ScrollViewTest, ScrollToPositionUpdatesWithHiddenHorizontalScrollBar) {
scroll_view_->SetHorizontalScrollBarMode(
ScrollView::ScrollBarMode::kHiddenButEnabled);
ScrollViewTestApi test_api(scroll_view_.get());
View* contents = InstallContents();
contents->SetBounds(0, 0, 400, 50);
scroll_view_->Layout();
auto* scroll_bar = test_api.GetScrollBar(HORIZONTAL);
ASSERT_TRUE(scroll_bar);
EXPECT_FALSE(scroll_bar->GetVisible());
// We can't rely on the scrollbar, which may not be updated as it's not
// visible, but we can check the scroll offset itself.
EXPECT_EQ(0, test_api.CurrentOffset().x());
scroll_view_->ScrollToPosition(scroll_bar, 20);
EXPECT_GT(test_api.CurrentOffset().x(), 0);
}
// Test that calling ScrollToPosition() also updates the position of the
// child view even when the horizontal scrollbar is hidden.
TEST_F(ScrollViewTest, ScrollToPositionUpdatesWithHiddenVerticalScrollBar) {
scroll_view_->SetVerticalScrollBarMode(
ScrollView::ScrollBarMode::kHiddenButEnabled);
ScrollViewTestApi test_api(scroll_view_.get());
View* contents = InstallContents();
contents->SetBounds(0, 0, 50, 400);
scroll_view_->Layout();
auto* scroll_bar = test_api.GetScrollBar(VERTICAL);
ASSERT_TRUE(scroll_bar);
EXPECT_FALSE(scroll_bar->GetVisible());
// We can't rely on the scrollbar, which may not be updated as it's not
// visible, but we can check the scroll offset itself.
EXPECT_EQ(0, test_api.CurrentOffset().y());
scroll_view_->ScrollToPosition(scroll_bar, 20);
EXPECT_GT(test_api.CurrentOffset().y(), 0);
}
// Verifies ScrollRectToVisible() on the child works.
TEST_F(ScrollViewTest, ScrollRectToVisible) {
ScrollViewTestApi test_api(scroll_view_.get());
auto contents = std::make_unique<CustomView>();
contents->SetPreferredSize(gfx::Size(500, 1000));
auto* contents_ptr = scroll_view_->SetContents(std::move(contents));
scroll_view_->SetBoundsRect(gfx::Rect(0, 0, 100, 100));
scroll_view_->Layout();
EXPECT_EQ(gfx::Vector2d(0, 0), test_api.IntegralViewOffset());
// Scroll to y=405 height=10, this should make the y position of the content
// at (405 + 10) - viewport_height (scroll region bottom aligned).
contents_ptr->ScrollRectToVisible(gfx::Rect(0, 405, 10, 10));
const int viewport_height = test_api.contents_viewport()->height();
// Expect there to be a horizontal scrollbar, making the viewport shorter.
EXPECT_EQ(100 - scroll_view_->GetScrollBarLayoutHeight(), viewport_height);
gfx::PointF offset = test_api.CurrentOffset();
EXPECT_EQ(415 - viewport_height, offset.y());
// Scroll to the current y-location and 10x10; should do nothing.
contents_ptr->ScrollRectToVisible(gfx::Rect(0, offset.y(), 10, 10));
EXPECT_EQ(415 - viewport_height, test_api.CurrentOffset().y());
}
// Verifies ScrollRectToVisible() scrolls the view horizontally even if the
// horizontal scrollbar is hidden (but not disabled).
TEST_F(ScrollViewTest, ScrollRectToVisibleWithHiddenHorizontalScrollbar) {
scroll_view_->SetHorizontalScrollBarMode(
ScrollView::ScrollBarMode::kHiddenButEnabled);
ScrollViewTestApi test_api(scroll_view_.get());
auto contents = std::make_unique<CustomView>();
contents->SetPreferredSize(gfx::Size(500, 1000));
auto* contents_ptr = scroll_view_->SetContents(std::move(contents));
scroll_view_->SetBoundsRect(gfx::Rect(0, 0, 100, 100));
scroll_view_->Layout();
EXPECT_EQ(gfx::Vector2d(0, 0), test_api.IntegralViewOffset());
// Scroll to x=305 width=10, this should make the x position of the content
// at (305 + 10) - viewport_width (scroll region right aligned).
contents_ptr->ScrollRectToVisible(gfx::Rect(305, 0, 10, 10));
const int viewport_width = test_api.contents_viewport()->width();
// Expect there to be a vertical scrollbar, making the viewport shorter.
EXPECT_EQ(100 - scroll_view_->GetScrollBarLayoutWidth(), viewport_width);
gfx::PointF offset = test_api.CurrentOffset();
EXPECT_EQ(315 - viewport_width, offset.x());
// Scroll to the current x-location and 10x10; should do nothing.
contents_ptr->ScrollRectToVisible(gfx::Rect(offset.x(), 0, 10, 10));
EXPECT_EQ(315 - viewport_width, test_api.CurrentOffset().x());
}
// Verifies ScrollRectToVisible() scrolls the view horizontally even if the
// horizontal scrollbar is hidden (but not disabled).
TEST_F(ScrollViewTest, ScrollRectToVisibleWithHiddenVerticalScrollbar) {
scroll_view_->SetVerticalScrollBarMode(
ScrollView::ScrollBarMode::kHiddenButEnabled);
ScrollViewTestApi test_api(scroll_view_.get());
auto contents = std::make_unique<CustomView>();
contents->SetPreferredSize(gfx::Size(1000, 500));
auto* contents_ptr = scroll_view_->SetContents(std::move(contents));
scroll_view_->SetBoundsRect(gfx::Rect(0, 0, 100, 100));
scroll_view_->Layout();
EXPECT_EQ(gfx::Vector2d(0, 0), test_api.IntegralViewOffset());
// Scroll to y=305 height=10, this should make the y position of the content
// at (305 + 10) - viewport_height (scroll region bottom aligned).
contents_ptr->ScrollRectToVisible(gfx::Rect(0, 305, 10, 10));
const int viewport_height = test_api.contents_viewport()->height();
// Expect there to be a vertical scrollbar, making the viewport shorter.
EXPECT_EQ(100 - scroll_view_->GetScrollBarLayoutHeight(), viewport_height);
gfx::PointF offset = test_api.CurrentOffset();
EXPECT_EQ(315 - viewport_height, offset.y());
// Scroll to the current x-location and 10x10; should do nothing.
contents_ptr->ScrollRectToVisible(gfx::Rect(0, offset.y(), 10, 10));
EXPECT_EQ(315 - viewport_height, test_api.CurrentOffset().y());
}
// Verifies that child scrolls into view when it's focused.
TEST_F(ScrollViewTest, ScrollChildToVisibleOnFocus) {
ScrollViewTestApi test_api(scroll_view_.get());
auto contents = std::make_unique<CustomView>();
contents->SetPreferredSize(gfx::Size(500, 1000));
auto* contents_ptr = scroll_view_->SetContents(std::move(contents));
auto child = std::make_unique<FixedView>();
child->SetPreferredSize(gfx::Size(10, 10));
child->SetPosition(gfx::Point(0, 405));
auto* child_ptr = contents_ptr->AddChildView(std::move(child));
scroll_view_->SetBoundsRect(gfx::Rect(0, 0, 100, 100));
scroll_view_->Layout();
EXPECT_EQ(gfx::Vector2d(), test_api.IntegralViewOffset());
// Set focus to the child control. This should cause the control to scroll to
// y=405 height=10. Like the above test, this should make the y position of
// the content at (405 + 10) - viewport_height (scroll region bottom aligned).
child_ptr->SetFocus();
const int viewport_height = test_api.contents_viewport()->height();
// Expect there to be a horizontal scrollbar, making the viewport shorter.
EXPECT_EQ(100 - scroll_view_->GetScrollBarLayoutHeight(), viewport_height);
gfx::PointF offset = test_api.CurrentOffset();
EXPECT_EQ(415 - viewport_height, offset.y());
}
// Verifies that ScrollView scrolls into view when its contents root is focused.
TEST_F(ScrollViewTest, ScrollViewToVisibleOnContentsRootFocus) {
ScrollViewTestApi outer_test_api(scroll_view_.get());
auto outer_contents = std::make_unique<CustomView>();
outer_contents->SetPreferredSize(gfx::Size(500, 1000));
auto* outer_contents_ptr =
scroll_view_->SetContents(std::move(outer_contents));
auto inner_scroll_view = std::make_unique<ScrollView>();