ItemsPresenterTests_Virtualization_Simple.cs 39 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108
  1. // Copyright (c) The Avalonia Project. All rights reserved.
  2. // Licensed under the MIT license. See licence.md file in the project root for full license information.
  3. using System;
  4. using System.Collections;
  5. using System.Collections.Generic;
  6. using System.Collections.ObjectModel;
  7. using System.Linq;
  8. using Avalonia.Collections;
  9. using Avalonia.Controls.Generators;
  10. using Avalonia.Controls.Presenters;
  11. using Avalonia.Controls.Primitives;
  12. using Avalonia.Controls.Templates;
  13. using Avalonia.Input;
  14. using Avalonia.Layout;
  15. using Avalonia.LogicalTree;
  16. using Avalonia.Platform;
  17. using Avalonia.Rendering;
  18. using Avalonia.Styling;
  19. using Avalonia.UnitTests;
  20. using Xunit;
  21. namespace Avalonia.Controls.UnitTests.Presenters
  22. {
  23. public class ItemsPresenterTests_Virtualization_Simple
  24. {
  25. [Fact]
  26. public void Should_Return_Items_Count_For_Extent_Vertical()
  27. {
  28. var target = CreateTarget();
  29. target.ApplyTemplate();
  30. Assert.Equal(new Size(0, 20), ((ILogicalScrollable)target).Extent);
  31. }
  32. [Fact]
  33. public void Should_Return_Items_Count_For_Extent_Horizontal()
  34. {
  35. var target = CreateTarget(orientation: Orientation.Horizontal);
  36. target.ApplyTemplate();
  37. Assert.Equal(new Size(20, 0), ((ILogicalScrollable)target).Extent);
  38. }
  39. [Fact]
  40. public void Should_Have_Number_Of_Visible_Items_As_Viewport_Vertical()
  41. {
  42. var target = CreateTarget();
  43. target.ApplyTemplate();
  44. target.Measure(new Size(100, 100));
  45. target.Arrange(new Rect(0, 0, 100, 100));
  46. Assert.Equal(new Size(100, 10), ((ILogicalScrollable)target).Viewport);
  47. }
  48. [Fact]
  49. public void Should_Have_Number_Of_Visible_Items_As_Viewport_Horizontal()
  50. {
  51. var target = CreateTarget(orientation: Orientation.Horizontal);
  52. target.ApplyTemplate();
  53. target.Measure(new Size(100, 100));
  54. target.Arrange(new Rect(0, 0, 100, 100));
  55. Assert.Equal(new Size(10, 100), ((ILogicalScrollable)target).Viewport);
  56. }
  57. [Fact]
  58. public void Should_Add_Containers_When_Panel_Is_Not_Full()
  59. {
  60. var target = CreateTarget(itemCount: 5);
  61. var items = (IList<string>)target.Items;
  62. target.ApplyTemplate();
  63. target.Measure(new Size(100, 100));
  64. target.Arrange(new Rect(0, 0, 100, 100));
  65. Assert.Equal(5, target.Panel.Children.Count);
  66. items.Add("New Item");
  67. Assert.Equal(6, target.Panel.Children.Count);
  68. }
  69. [Fact]
  70. public void Should_Remove_Items_When_Control_Is_Shrank()
  71. {
  72. var target = CreateTarget();
  73. var items = (IList<string>)target.Items;
  74. target.ApplyTemplate();
  75. target.Measure(new Size(100, 100));
  76. target.Arrange(new Rect(0, 0, 100, 100));
  77. Assert.Equal(10, target.Panel.Children.Count);
  78. target.Measure(new Size(100, 80));
  79. target.Arrange(new Rect(0, 0, 100, 80));
  80. Assert.Equal(8, target.Panel.Children.Count);
  81. }
  82. [Fact]
  83. public void Should_Add_New_Containers_At_Top_When_Control_Is_Scrolled_To_Bottom_And_Enlarged()
  84. {
  85. var target = CreateTarget();
  86. var items = (IList<string>)target.Items;
  87. target.ApplyTemplate();
  88. target.Measure(new Size(100, 100));
  89. target.Arrange(new Rect(0, 0, 100, 100));
  90. Assert.Equal(10, target.Panel.Children.Count);
  91. ((IScrollable)target).Offset = new Vector(0, 10);
  92. target.Measure(new Size(120, 120));
  93. target.Arrange(new Rect(0, 0, 100, 120));
  94. Assert.Equal(12, target.Panel.Children.Count);
  95. for (var i = 0; i < target.Panel.Children.Count; ++i)
  96. {
  97. Assert.Equal(items[i + 8], target.Panel.Children[i].DataContext);
  98. }
  99. }
  100. [Fact]
  101. public void Should_Update_Containers_When_Items_Changes()
  102. {
  103. var target = CreateTarget();
  104. target.ApplyTemplate();
  105. target.Measure(new Size(100, 100));
  106. target.Arrange(new Rect(0, 0, 100, 100));
  107. target.Items = new[] { "foo", "bar", "baz" };
  108. Assert.Equal(3, target.Panel.Children.Count);
  109. }
  110. [Fact]
  111. public void Should_Decrease_The_Viewport_Size_By_One_If_There_Is_A_Partial_Item()
  112. {
  113. var target = CreateTarget();
  114. target.ApplyTemplate();
  115. target.Measure(new Size(100, 95));
  116. target.Arrange(new Rect(0, 0, 100, 95));
  117. Assert.Equal(new Size(100, 9), ((ILogicalScrollable)target).Viewport);
  118. }
  119. [Fact]
  120. public void Moving_To_And_From_The_End_With_Partial_Item_Should_Set_Panel_PixelOffset()
  121. {
  122. var target = CreateTarget();
  123. target.ApplyTemplate();
  124. target.Measure(new Size(100, 95));
  125. target.Arrange(new Rect(0, 0, 100, 95));
  126. ((ILogicalScrollable)target).Offset = new Vector(0, 11);
  127. var minIndex = target.ItemContainerGenerator.Containers.Min(x => x.Index);
  128. Assert.Equal(new Vector(0, 11), ((ILogicalScrollable)target).Offset);
  129. Assert.Equal(10, minIndex);
  130. Assert.Equal(10, ((IVirtualizingPanel)target.Panel).PixelOffset);
  131. ((ILogicalScrollable)target).Offset = new Vector(0, 10);
  132. minIndex = target.ItemContainerGenerator.Containers.Min(x => x.Index);
  133. Assert.Equal(new Vector(0, 10), ((ILogicalScrollable)target).Offset);
  134. Assert.Equal(10, minIndex);
  135. Assert.Equal(0, ((IVirtualizingPanel)target.Panel).PixelOffset);
  136. ((ILogicalScrollable)target).Offset = new Vector(0, 11);
  137. minIndex = target.ItemContainerGenerator.Containers.Min(x => x.Index);
  138. Assert.Equal(new Vector(0, 11), ((ILogicalScrollable)target).Offset);
  139. Assert.Equal(10, minIndex);
  140. Assert.Equal(10, ((IVirtualizingPanel)target.Panel).PixelOffset);
  141. }
  142. [Fact]
  143. public void Inserting_Items_Should_Update_Containers()
  144. {
  145. var target = CreateTarget();
  146. target.ApplyTemplate();
  147. target.Measure(new Size(100, 100));
  148. target.Arrange(new Rect(0, 0, 100, 100));
  149. ((ILogicalScrollable)target).Offset = new Vector(0, 5);
  150. var expected = Enumerable.Range(5, 10).Select(x => $"Item {x}").ToList();
  151. var items = (ObservableCollection<string>)target.Items;
  152. var actual = target.Panel.Children.Select(x => x.DataContext).ToList();
  153. Assert.Equal(expected, actual);
  154. items.Insert(6, "Inserted");
  155. expected.Insert(1, "Inserted");
  156. expected.RemoveAt(expected.Count - 1);
  157. actual = target.Panel.Children.Select(x => x.DataContext).ToList();
  158. Assert.Equal(expected, actual);
  159. }
  160. [Fact]
  161. public void Inserting_Items_Before_Visibile_Containers_Should_Update_Containers()
  162. {
  163. var target = CreateTarget();
  164. target.ApplyTemplate();
  165. target.Measure(new Size(100, 100));
  166. target.Arrange(new Rect(0, 0, 100, 100));
  167. ((ILogicalScrollable)target).Offset = new Vector(0, 5);
  168. var expected = Enumerable.Range(5, 10).Select(x => $"Item {x}").ToList();
  169. var items = (ObservableCollection<string>)target.Items;
  170. var actual = target.Panel.Children.Select(x => x.DataContext).ToList();
  171. Assert.Equal(expected, actual);
  172. items.Insert(0, "Inserted");
  173. expected = Enumerable.Range(4, 10).Select(x => $"Item {x}").ToList();
  174. actual = target.Panel.Children.Select(x => x.DataContext).ToList();
  175. Assert.Equal(expected, actual);
  176. }
  177. [Fact]
  178. public void Removing_First_Materialized_Item_Should_Update_Containers()
  179. {
  180. var target = CreateTarget();
  181. target.ApplyTemplate();
  182. target.Measure(new Size(100, 100));
  183. target.Arrange(new Rect(0, 0, 100, 100));
  184. var expected = Enumerable.Range(0, 10).Select(x => $"Item {x}").ToList();
  185. var items = (ObservableCollection<string>)target.Items;
  186. var actual = target.Panel.Children.Select(x => x.DataContext).ToList();
  187. Assert.Equal(expected, actual);
  188. items.RemoveAt(0);
  189. expected = Enumerable.Range(1, 10).Select(x => $"Item {x}").ToList();
  190. actual = target.Panel.Children.Select(x => x.DataContext).ToList();
  191. Assert.Equal(expected, actual);
  192. }
  193. [Fact]
  194. public void Removing_Items_From_Middle_Should_Update_Containers_When_All_Items_Visible()
  195. {
  196. var target = CreateTarget();
  197. target.ApplyTemplate();
  198. target.Measure(new Size(100, 200));
  199. target.Arrange(new Rect(0, 0, 100, 200));
  200. var items = (ObservableCollection<string>)target.Items;
  201. var actual = target.Panel.Children.Select(x => x.DataContext).ToList();
  202. Assert.Equal(items, actual);
  203. items.RemoveAt(2);
  204. actual = target.Panel.Children.Select(x => x.DataContext).ToList();
  205. Assert.Equal(items, actual);
  206. items.RemoveAt(items.Count - 2);
  207. actual = target.Panel.Children.Select(x => x.DataContext).ToList();
  208. Assert.Equal(items, actual);
  209. }
  210. [Fact]
  211. public void Removing_Last_Item_Should_Update_Containers_When_All_Items_Visible()
  212. {
  213. var target = CreateTarget();
  214. target.ApplyTemplate();
  215. target.Measure(new Size(100, 200));
  216. target.Arrange(new Rect(0, 0, 100, 200));
  217. ((ILogicalScrollable)target).Offset = new Vector(0, 5);
  218. var expected = Enumerable.Range(0, 20).Select(x => $"Item {x}").ToList();
  219. var items = (ObservableCollection<string>)target.Items;
  220. var actual = target.Panel.Children.Select(x => x.DataContext).ToList();
  221. Assert.Equal(expected, actual);
  222. items.Remove(items.Last());
  223. expected.Remove(expected.Last());
  224. actual = target.Panel.Children.Select(x => x.DataContext).ToList();
  225. Assert.Equal(expected, actual);
  226. }
  227. [Fact]
  228. public void Removing_Items_When_Scrolled_To_End_Should_Recyle_Containers_At_Top()
  229. {
  230. var target = CreateTarget(useAvaloniaList: true);
  231. target.ApplyTemplate();
  232. target.Measure(new Size(100, 100));
  233. target.Arrange(new Rect(0, 0, 100, 100));
  234. ((ILogicalScrollable)target).Offset = new Vector(0, 10);
  235. var expected = Enumerable.Range(10, 10).Select(x => $"Item {x}").ToList();
  236. var items = (AvaloniaList<string>)target.Items;
  237. var actual = target.Panel.Children.Select(x => x.DataContext).ToList();
  238. Assert.Equal(expected, actual);
  239. items.RemoveRange(18, 2);
  240. expected = Enumerable.Range(8, 10).Select(x => $"Item {x}").ToList();
  241. actual = target.Panel.Children.Select(x => x.DataContext).ToList();
  242. Assert.Equal(expected, actual);
  243. }
  244. [Fact]
  245. public void Removing_Items_When_Scrolled_To_Near_End_Should_Recycle_Containers_At_Bottom_And_Top()
  246. {
  247. var target = CreateTarget(useAvaloniaList: true);
  248. target.ApplyTemplate();
  249. target.Measure(new Size(100, 100));
  250. target.Arrange(new Rect(0, 0, 100, 100));
  251. ((ILogicalScrollable)target).Offset = new Vector(0, 9);
  252. var expected = Enumerable.Range(9, 10).Select(x => $"Item {x}").ToList();
  253. var items = (AvaloniaList<string>)target.Items;
  254. var actual = target.Panel.Children.Select(x => x.DataContext).ToList();
  255. Assert.Equal(expected, actual);
  256. items.RemoveRange(15, 3);
  257. expected = Enumerable.Range(7, 8).Select(x => $"Item {x}")
  258. .Concat(Enumerable.Range(18, 2).Select(x => $"Item {x}"))
  259. .ToList();
  260. actual = target.Panel.Children.Select(x => x.DataContext).ToList();
  261. Assert.Equal(expected, actual);
  262. }
  263. [Fact]
  264. public void Measuring_To_Infinity_When_Scrolled_To_End_Should_Not_Throw()
  265. {
  266. var target = CreateTarget(useAvaloniaList: true);
  267. target.ApplyTemplate();
  268. target.Measure(new Size(100, 100));
  269. target.Arrange(new Rect(0, 0, 100, 100));
  270. ((ILogicalScrollable)target).Offset = new Vector(0, 10);
  271. // Check for issue #589: this should not throw.
  272. target.Measure(Size.Infinity);
  273. var expected = Enumerable.Range(0, 20).Select(x => $"Item {x}").ToList();
  274. var items = (AvaloniaList<string>)target.Items;
  275. var actual = target.Panel.Children.Select(x => x.DataContext).ToList();
  276. Assert.Equal(expected, actual);
  277. }
  278. [Fact]
  279. public void Replacing_Items_Should_Update_Containers()
  280. {
  281. var target = CreateTarget();
  282. target.ApplyTemplate();
  283. target.Measure(new Size(100, 100));
  284. target.Arrange(new Rect(0, 0, 100, 100));
  285. var expected = Enumerable.Range(0, 10).Select(x => $"Item {x}").ToList();
  286. var items = (ObservableCollection<string>)target.Items;
  287. var actual = target.Panel.Children.Select(x => x.DataContext).ToList();
  288. Assert.Equal(expected, actual);
  289. items[4] = expected[4] = "Replaced";
  290. actual = target.Panel.Children.Select(x => x.DataContext).ToList();
  291. Assert.Equal(expected, actual);
  292. }
  293. [Fact]
  294. public void Moving_Items_Should_Update_Containers()
  295. {
  296. var target = CreateTarget();
  297. target.ApplyTemplate();
  298. target.Measure(new Size(100, 100));
  299. target.Arrange(new Rect(0, 0, 100, 100));
  300. var expected = Enumerable.Range(0, 10).Select(x => $"Item {x}").ToList();
  301. var items = (ObservableCollection<string>)target.Items;
  302. var actual = target.Panel.Children.Select(x => x.DataContext).ToList();
  303. Assert.Equal(expected, actual);
  304. items.Move(4, 8);
  305. var i = expected[4];
  306. expected.RemoveAt(4);
  307. expected.Insert(8, i);
  308. actual = target.Panel.Children.Select(x => x.DataContext).ToList();
  309. Assert.Equal(expected, actual);
  310. }
  311. [Fact]
  312. public void Setting_Items_To_Null_Should_Remove_Containers()
  313. {
  314. var target = CreateTarget();
  315. target.ApplyTemplate();
  316. target.Measure(new Size(100, 100));
  317. target.Arrange(new Rect(0, 0, 100, 100));
  318. var expected = Enumerable.Range(0, 10).Select(x => $"Item {x}").ToList();
  319. var items = (ObservableCollection<string>)target.Items;
  320. var actual = target.Panel.Children.Select(x => x.DataContext).ToList();
  321. Assert.Equal(expected, actual);
  322. target.Items = null;
  323. Assert.Empty(target.Panel.Children);
  324. }
  325. [Fact]
  326. public void Reassigning_Items_Should_Create_Containers()
  327. {
  328. var target = CreateTarget(itemCount: 5);
  329. target.ApplyTemplate();
  330. target.Measure(new Size(100, 100));
  331. target.Arrange(new Rect(0, 0, 100, 100));
  332. var expected = Enumerable.Range(0, 5).Select(x => $"Item {x}").ToList();
  333. var items = (ObservableCollection<string>)target.Items;
  334. var actual = target.Panel.Children.Select(x => x.DataContext).ToList();
  335. Assert.Equal(expected, actual);
  336. expected = Enumerable.Range(0, 6).Select(x => $"Item {x}").ToList();
  337. target.Items = expected;
  338. actual = target.Panel.Children.Select(x => x.DataContext).ToList();
  339. Assert.Equal(expected, actual);
  340. }
  341. [Fact]
  342. public void Inserting_Then_Removing_Should_Add_Remove_Containers()
  343. {
  344. var items = new AvaloniaList<string>(Enumerable.Range(0, 5).Select(x => $"Item {x}"));
  345. var toAdd = Enumerable.Range(0, 3).Select(x => $"Added Item {x}").ToArray();
  346. var target = new ItemsPresenter
  347. {
  348. VirtualizationMode = ItemVirtualizationMode.None,
  349. Items = items,
  350. ItemTemplate = new FuncDataTemplate<string>((x, _) => new TextBlock { Height = 10 }),
  351. };
  352. target.ApplyTemplate();
  353. Assert.Equal(items.Count, target.Panel.Children.Count);
  354. int addIndex = 1;
  355. foreach (var item in toAdd)
  356. {
  357. items.Insert(addIndex++, item);
  358. }
  359. Assert.Equal(items.Count, target.Panel.Children.Count);
  360. foreach (var item in toAdd)
  361. {
  362. items.Remove(item);
  363. }
  364. Assert.Equal(items.Count, target.Panel.Children.Count);
  365. }
  366. [Fact]
  367. public void Reassigning_Items_Should_Remove_Containers()
  368. {
  369. var target = CreateTarget(itemCount: 6);
  370. target.ApplyTemplate();
  371. target.Measure(new Size(100, 100));
  372. target.Arrange(new Rect(0, 0, 100, 100));
  373. var expected = Enumerable.Range(0, 6).Select(x => $"Item {x}").ToList();
  374. var actual = target.Panel.Children.Select(x => x.DataContext).ToList();
  375. Assert.Equal(expected, actual);
  376. expected = Enumerable.Range(0, 5).Select(x => $"Item {x}").ToList();
  377. target.Items = expected;
  378. actual = target.Panel.Children.Select(x => x.DataContext).ToList();
  379. Assert.Equal(expected, actual);
  380. }
  381. [Fact]
  382. public void Clearing_Items_And_ReAdding_Should_Remove_Containers()
  383. {
  384. var target = CreateTarget(itemCount: 6);
  385. target.ApplyTemplate();
  386. target.Measure(new Size(100, 100));
  387. target.Arrange(new Rect(0, 0, 100, 100));
  388. var expected = Enumerable.Range(0, 6).Select(x => $"Item {x}").ToList();
  389. var items = (ObservableCollection<string>)target.Items;
  390. var actual = target.Panel.Children.Select(x => x.DataContext).ToList();
  391. Assert.Equal(expected, actual);
  392. expected = Enumerable.Range(0, 5).Select(x => $"Item {x}").ToList();
  393. target.Items = null;
  394. target.Items = expected;
  395. actual = target.Panel.Children.Select(x => x.DataContext).ToList();
  396. Assert.Equal(expected, actual);
  397. }
  398. [Fact]
  399. public void Scrolling_To_Partial_Last_Item_Then_Adding_Item_Updates_Containers()
  400. {
  401. var target = CreateTarget(itemCount: 10);
  402. var items = (IList<string>)target.Items;
  403. target.ApplyTemplate();
  404. target.Measure(new Size(100, 95));
  405. target.Arrange(new Rect(0, 0, 100, 95));
  406. ((ILogicalScrollable)target).Offset = new Vector(0, 1);
  407. Assert.Equal(new Vector(0, 1), ((ILogicalScrollable)target).Offset);
  408. var expected = Enumerable.Range(0, 10).Select(x => $"Item {x}").ToList();
  409. var actual = target.Panel.Children.Select(x => x.DataContext).ToList();
  410. Assert.Equal(expected, actual);
  411. Assert.Equal(10, ((IVirtualizingPanel)target.Panel).PixelOffset);
  412. items.Add("Item 10");
  413. expected = Enumerable.Range(1, 10).Select(x => $"Item {x}").ToList();
  414. actual = target.Panel.Children.Select(x => x.DataContext).ToList();
  415. Assert.Equal(expected, actual);
  416. Assert.Equal(0, ((IVirtualizingPanel)target.Panel).PixelOffset);
  417. }
  418. [Fact]
  419. public void Scrolling_To_Item_In_Zero_Sized_Presenter_Doesnt_Throw()
  420. {
  421. using (UnitTestApplication.Start(new TestServices()))
  422. {
  423. var target = CreateTarget(itemCount: 10);
  424. var items = (IList<string>)target.Items;
  425. target.ApplyTemplate();
  426. target.Measure(Size.Empty);
  427. target.Arrange(Rect.Empty);
  428. // Check for issue #591: this should not throw.
  429. target.ScrollIntoView(items[0]);
  430. }
  431. }
  432. [Fact]
  433. public void InsertRange_Items_Should_Update_Containers()
  434. {
  435. var target = CreateTarget(useAvaloniaList: true);
  436. target.ApplyTemplate();
  437. target.Measure(new Size(100, 100));
  438. target.Arrange(new Rect(0, 0, 100, 100));
  439. var expected = Enumerable.Range(0, 10).Select(x => $"Item {x}").ToList();
  440. var items = (AvaloniaList<string>)target.Items;
  441. var actual = target.Panel.Children.Select(x => x.DataContext).ToList();
  442. Assert.Equal(expected, actual);
  443. var toAdd = Enumerable.Range(0, 3).Select(x => $"New Item {x}").ToList();
  444. int index = 1;
  445. items.InsertRange(index, toAdd);
  446. expected.InsertRange(index, toAdd);
  447. expected.RemoveRange(10, toAdd.Count);
  448. actual = target.Panel.Children.Select(x => x.DataContext).ToList();
  449. Assert.Equal(expected, actual);
  450. }
  451. [Fact]
  452. public void InsertRange_Items_Before_Last_Should_Update_Containers()
  453. {
  454. var target = CreateTarget(useAvaloniaList: true);
  455. target.ApplyTemplate();
  456. target.Measure(new Size(100, 100));
  457. target.Arrange(new Rect(0, 0, 100, 100));
  458. var expected = Enumerable.Range(0, 10).Select(x => $"Item {x}").ToList();
  459. var items = (AvaloniaList<string>)target.Items;
  460. var actual = target.Panel.Children.Select(x => x.DataContext).ToList();
  461. Assert.Equal(expected, actual);
  462. var toAdd = Enumerable.Range(0, 3).Select(x => $"New Item {x}").ToList();
  463. int index = 8;
  464. items.InsertRange(index, toAdd);
  465. expected.InsertRange(index, toAdd);
  466. expected.RemoveRange(10, toAdd.Count);
  467. actual = target.Panel.Children.Select(x => x.DataContext).ToList();
  468. Assert.Equal(expected, actual);
  469. }
  470. [Fact]
  471. public void RemoveRange_Items_Should_Update_Containers()
  472. {
  473. var target = CreateTarget(useAvaloniaList: true);
  474. target.ApplyTemplate();
  475. target.Measure(new Size(100, 100));
  476. target.Arrange(new Rect(0, 0, 100, 100));
  477. var expected = Enumerable.Range(0, 13).Select(x => $"Item {x}").ToList();
  478. var items = (AvaloniaList<string>)target.Items;
  479. var actual = target.Panel.Children.Select(x => x.DataContext).ToList();
  480. Assert.Equal(expected.Take(10), actual);
  481. int index = 5;
  482. int count = 3;
  483. items.RemoveRange(index, count);
  484. expected.RemoveRange(index, count);
  485. actual = target.Panel.Children.Select(x => x.DataContext).ToList();
  486. Assert.Equal(expected, actual);
  487. }
  488. [Fact]
  489. public void RemoveRange_Items_Before_Last_Should_Update_Containers()
  490. {
  491. var target = CreateTarget(useAvaloniaList: true);
  492. target.ApplyTemplate();
  493. target.Measure(new Size(100, 100));
  494. target.Arrange(new Rect(0, 0, 100, 100));
  495. var expected = Enumerable.Range(0, 13).Select(x => $"Item {x}").ToList();
  496. var items = (AvaloniaList<string>)target.Items;
  497. var actual = target.Panel.Children.Select(x => x.DataContext).ToList();
  498. Assert.Equal(expected.Take(10), actual);
  499. int index = 8;
  500. int count = 3;
  501. items.RemoveRange(index, count);
  502. expected.RemoveRange(index, count);
  503. actual = target.Panel.Children.Select(x => x.DataContext).ToList();
  504. Assert.Equal(expected, actual);
  505. }
  506. [Fact]
  507. public void Should_Add_Containers_For_Items_After_Clear()
  508. {
  509. var target = CreateTarget(itemCount: 10);
  510. var defaultItems = (IList<string>)target.Items;
  511. var items = new AvaloniaList<string>(defaultItems);
  512. target.Items = items;
  513. target.ApplyTemplate();
  514. target.Measure(new Size(100, 100));
  515. target.Arrange(new Rect(target.DesiredSize));
  516. Assert.Equal(10, target.Panel.Children.Count);
  517. items.Clear();
  518. target.Panel.Measure(new Size(100, 100));
  519. target.Panel.Arrange(new Rect(target.Panel.DesiredSize));
  520. target.Measure(new Size(100, 100));
  521. target.Arrange(new Rect(target.DesiredSize));
  522. Assert.Empty(target.Panel.Children);
  523. items.AddRange(defaultItems.Select(s => s + " new"));
  524. target.Panel.Measure(new Size(100, 100));
  525. target.Panel.Arrange(new Rect(target.Panel.DesiredSize));
  526. target.Measure(new Size(100, 100));
  527. target.Arrange(new Rect(target.DesiredSize));
  528. Assert.Equal(10, target.Panel.Children.Count);
  529. }
  530. [Fact]
  531. public void Scroll_To_Last_Should_Work()
  532. {
  533. var target = CreateTarget(itemCount: 11);
  534. var scroller = (TestScroller)target.Parent;
  535. scroller.Width = scroller.Height = 100;
  536. scroller.LayoutManager.ExecuteInitialLayoutPass(scroller);
  537. var last = (target.Items as IList)[10];
  538. target.ScrollIntoView(last);
  539. Assert.Equal(new Vector(0, 1), ((ILogicalScrollable)target).Offset);
  540. Assert.Same(target.Panel.Children[9].DataContext, last);
  541. }
  542. [Fact]
  543. public void Second_Scroll_To_Last_Should_Work()
  544. {
  545. var target = CreateTarget(itemCount: 11);
  546. var scroller = (TestScroller)target.Parent;
  547. scroller.Width = scroller.Height = 100;
  548. scroller.LayoutManager.ExecuteInitialLayoutPass(scroller);
  549. var last = (target.Items as IList)[10];
  550. target.ScrollIntoView(last);
  551. Assert.Equal(new Vector(0, 1), ((ILogicalScrollable)target).Offset);
  552. Assert.Same(target.Panel.Children[9].DataContext, last);
  553. target.ScrollIntoView(last);
  554. Assert.Equal(new Vector(0, 1), ((ILogicalScrollable)target).Offset);
  555. Assert.Same(target.Panel.Children[9].DataContext, last);
  556. }
  557. [Fact]
  558. public void Scrolling_Less_Than_A_Page_Should_Move_Recycled_Items()
  559. {
  560. var target = CreateTarget();
  561. var items = (IList<string>)target.Items;
  562. target.ApplyTemplate();
  563. target.Measure(new Size(100, 100));
  564. target.Arrange(new Rect(0, 0, 100, 100));
  565. var containers = target.Panel.Children.ToList();
  566. var scroller = (ScrollContentPresenter)target.Parent;
  567. scroller.Offset = new Vector(0, 5);
  568. var scrolledContainers = containers
  569. .Skip(5)
  570. .Take(5)
  571. .Concat(containers.Take(5)).ToList();
  572. Assert.Equal(new Vector(0, 5), ((ILogicalScrollable)target).Offset);
  573. Assert.Equal(scrolledContainers, target.Panel.Children);
  574. for (var i = 0; i < target.Panel.Children.Count; ++i)
  575. {
  576. Assert.Equal(items[i + 5], target.Panel.Children[i].DataContext);
  577. }
  578. scroller.Offset = new Vector(0, 0);
  579. Assert.Equal(new Vector(0, 0), ((ILogicalScrollable)target).Offset);
  580. Assert.Equal(containers, target.Panel.Children);
  581. var dcs = target.Panel.Children.Select(x => x.DataContext).ToList();
  582. for (var i = 0; i < target.Panel.Children.Count; ++i)
  583. {
  584. Assert.Equal(items[i], target.Panel.Children[i].DataContext);
  585. }
  586. }
  587. [Fact]
  588. public void Scrolling_More_Than_A_Page_Should_Recycle_Items()
  589. {
  590. var target = CreateTarget(itemCount: 50);
  591. var items = (IList<string>)target.Items;
  592. target.ApplyTemplate();
  593. target.Measure(new Size(100, 100));
  594. target.Arrange(new Rect(0, 0, 100, 100));
  595. var containers = target.Panel.Children.ToList();
  596. var scroller = (ScrollContentPresenter)target.Parent;
  597. scroller.Offset = new Vector(0, 20);
  598. Assert.Equal(new Vector(0, 20), ((ILogicalScrollable)target).Offset);
  599. Assert.Equal(containers, target.Panel.Children);
  600. for (var i = 0; i < target.Panel.Children.Count; ++i)
  601. {
  602. Assert.Equal(items[i + 20], target.Panel.Children[i].DataContext);
  603. }
  604. scroller.Offset = new Vector(0, 0);
  605. Assert.Equal(new Vector(0, 0), ((ILogicalScrollable)target).Offset);
  606. Assert.Equal(containers, target.Panel.Children);
  607. for (var i = 0; i < target.Panel.Children.Count; ++i)
  608. {
  609. Assert.Equal(items[i], target.Panel.Children[i].DataContext);
  610. }
  611. }
  612. public class Vertical
  613. {
  614. [Fact]
  615. public void GetControlInDirection_Down_Should_Return_Existing_Container_If_Materialized()
  616. {
  617. var target = CreateTarget();
  618. var scroller = (TestScroller)target.Parent;
  619. scroller.Width = scroller.Height = 100;
  620. scroller.LayoutManager.ExecuteInitialLayoutPass(scroller);
  621. var from = target.Panel.Children[5];
  622. var result = ((ILogicalScrollable)target).GetControlInDirection(
  623. NavigationDirection.Down,
  624. from);
  625. Assert.Same(target.Panel.Children[6], result);
  626. }
  627. [Fact]
  628. public void GetControlInDirection_Down_Should_Scroll_If_Necessary()
  629. {
  630. var target = CreateTarget();
  631. var scroller = (TestScroller)target.Parent;
  632. scroller.Width = scroller.Height = 100;
  633. scroller.LayoutManager.ExecuteInitialLayoutPass(scroller);
  634. var from = target.Panel.Children[9];
  635. var result = ((ILogicalScrollable)target).GetControlInDirection(
  636. NavigationDirection.Down,
  637. from);
  638. Assert.Equal(new Vector(0, 1), ((ILogicalScrollable)target).Offset);
  639. Assert.Same(target.Panel.Children[9], result);
  640. }
  641. [Fact]
  642. public void GetControlInDirection_Down_Should_Scroll_If_Partially_Visible()
  643. {
  644. var target = CreateTarget();
  645. var scroller = (TestScroller)target.Parent;
  646. scroller.Width = 100;
  647. scroller.Height = 95;
  648. scroller.LayoutManager.ExecuteInitialLayoutPass(scroller);
  649. var from = target.Panel.Children[8];
  650. var result = ((ILogicalScrollable)target).GetControlInDirection(
  651. NavigationDirection.Down,
  652. from);
  653. Assert.Equal(new Vector(0, 1), ((ILogicalScrollable)target).Offset);
  654. Assert.Same(target.Panel.Children[8], result);
  655. }
  656. [Fact]
  657. public void GetControlInDirection_Up_Should_Scroll_If_Partially_Visible_Item_Is_Currently_Shown()
  658. {
  659. var target = CreateTarget();
  660. var scroller = (TestScroller)target.Parent;
  661. scroller.Width = 100;
  662. scroller.Height = 95;
  663. scroller.LayoutManager.ExecuteInitialLayoutPass(scroller);
  664. ((ILogicalScrollable)target).Offset = new Vector(0, 11);
  665. var from = target.Panel.Children[1];
  666. var result = ((ILogicalScrollable)target).GetControlInDirection(
  667. NavigationDirection.Up,
  668. from);
  669. Assert.Equal(new Vector(0, 10), ((ILogicalScrollable)target).Offset);
  670. Assert.Same(target.Panel.Children[0], result);
  671. }
  672. [Fact]
  673. public void Should_Return_Horizontal_Extent_And_Viewport()
  674. {
  675. var target = CreateTarget();
  676. target.ApplyTemplate();
  677. target.Measure(new Size(5, 100));
  678. target.Arrange(new Rect(0, 0, 5, 100));
  679. Assert.Equal(new Size(10, 20), ((ILogicalScrollable)target).Extent);
  680. Assert.Equal(new Size(5, 10), ((ILogicalScrollable)target).Viewport);
  681. }
  682. [Fact]
  683. public void Horizontal_Scroll_Should_Update_Item_Position()
  684. {
  685. var target = CreateTarget();
  686. target.ApplyTemplate();
  687. target.Measure(new Size(5, 100));
  688. target.Arrange(new Rect(0, 0, 5, 100));
  689. ((ILogicalScrollable)target).Offset = new Vector(5, 0);
  690. target.Measure(new Size(5, 100));
  691. target.Arrange(new Rect(0, 0, 5, 100));
  692. Assert.Equal(new Rect(-5, 0, 10, 10), target.Panel.Children[0].Bounds);
  693. }
  694. }
  695. public class Horizontal
  696. {
  697. [Fact]
  698. public void GetControlInDirection_Right_Should_Return_Existing_Container_If_Materialized()
  699. {
  700. var target = CreateTarget(orientation: Orientation.Horizontal);
  701. var scroller = (TestScroller)target.Parent;
  702. scroller.Width = scroller.Height = 100;
  703. scroller.LayoutManager.ExecuteInitialLayoutPass(scroller);
  704. var from = target.Panel.Children[5];
  705. var result = ((ILogicalScrollable)target).GetControlInDirection(
  706. NavigationDirection.Right,
  707. from);
  708. Assert.Same(target.Panel.Children[6], result);
  709. }
  710. [Fact]
  711. public void GetControlInDirection_Right_Should_Scroll_If_Necessary()
  712. {
  713. var target = CreateTarget(orientation: Orientation.Horizontal);
  714. var scroller = (TestScroller)target.Parent;
  715. scroller.Width = scroller.Height = 100;
  716. scroller.LayoutManager.ExecuteInitialLayoutPass(scroller);
  717. var from = target.Panel.Children[9];
  718. var result = ((ILogicalScrollable)target).GetControlInDirection(
  719. NavigationDirection.Right,
  720. from);
  721. Assert.Equal(new Vector(1, 0), ((ILogicalScrollable)target).Offset);
  722. Assert.Same(target.Panel.Children[9], result);
  723. }
  724. [Fact]
  725. public void GetControlInDirection_Right_Should_Scroll_If_Partially_Visible()
  726. {
  727. var target = CreateTarget(orientation: Orientation.Horizontal);
  728. var scroller = (TestScroller)target.Parent;
  729. scroller.Width = 95;
  730. scroller.Height = 100;
  731. scroller.LayoutManager.ExecuteInitialLayoutPass(scroller);
  732. var from = target.Panel.Children[8];
  733. var result = ((ILogicalScrollable)target).GetControlInDirection(
  734. NavigationDirection.Right,
  735. from);
  736. Assert.Equal(new Vector(1, 0), ((ILogicalScrollable)target).Offset);
  737. Assert.Same(target.Panel.Children[8], result);
  738. }
  739. [Fact]
  740. public void GetControlInDirection_Left_Should_Scroll_If_Partially_Visible_Item_Is_Currently_Shown()
  741. {
  742. var target = CreateTarget(orientation: Orientation.Horizontal);
  743. var scroller = (TestScroller)target.Parent;
  744. scroller.Width = 95;
  745. scroller.Height = 100;
  746. scroller.LayoutManager.ExecuteInitialLayoutPass(scroller);
  747. ((ILogicalScrollable)target).Offset = new Vector(11, 0);
  748. var from = target.Panel.Children[1];
  749. var result = ((ILogicalScrollable)target).GetControlInDirection(
  750. NavigationDirection.Left,
  751. from);
  752. Assert.Equal(new Vector(10, 0), ((ILogicalScrollable)target).Offset);
  753. Assert.Same(target.Panel.Children[0], result);
  754. }
  755. }
  756. private static ItemsPresenter CreateTarget(
  757. Orientation orientation = Orientation.Vertical,
  758. int itemCount = 20,
  759. bool useAvaloniaList = false)
  760. {
  761. ItemsPresenter result;
  762. var itemsSource = Enumerable.Range(0, itemCount).Select(x => $"Item {x}");
  763. var items = useAvaloniaList ?
  764. (IEnumerable)new AvaloniaList<string>(itemsSource) :
  765. (IEnumerable)new ObservableCollection<string>(itemsSource);
  766. var scroller = new TestScroller
  767. {
  768. CanHorizontallyScroll = true,
  769. CanVerticallyScroll = true,
  770. Content = result = new TestItemsPresenter
  771. {
  772. Items = items,
  773. ItemsPanel = VirtualizingPanelTemplate(orientation),
  774. DataTemplates = { StringDataTemplate() },
  775. VirtualizationMode = ItemVirtualizationMode.Simple,
  776. }
  777. };
  778. scroller.UpdateChild();
  779. return result;
  780. }
  781. private static IDataTemplate StringDataTemplate()
  782. {
  783. return new FuncDataTemplate<string>((x, _) => new Canvas
  784. {
  785. Width = 10,
  786. Height = 10,
  787. });
  788. }
  789. private static ITemplate<IPanel> VirtualizingPanelTemplate(
  790. Orientation orientation = Orientation.Vertical)
  791. {
  792. return new FuncTemplate<IPanel>(() => new VirtualizingStackPanel
  793. {
  794. Orientation = orientation,
  795. });
  796. }
  797. private class TestScroller : ScrollContentPresenter, IRenderRoot, ILayoutRoot, ILogicalRoot
  798. {
  799. public IRenderer Renderer { get; }
  800. public Size ClientSize { get; }
  801. public double RenderScaling => 1;
  802. public Size MaxClientSize => Size.Infinity;
  803. public double LayoutScaling => 1;
  804. public ILayoutManager LayoutManager { get; } = new LayoutManager();
  805. public IRenderTarget CreateRenderTarget() => throw new NotImplementedException();
  806. public void Invalidate(Rect rect) => throw new NotImplementedException();
  807. public Point PointToClient(PixelPoint p) => throw new NotImplementedException();
  808. public PixelPoint PointToScreen(Point p) => throw new NotImplementedException();
  809. }
  810. private class TestItemsPresenter : ItemsPresenter
  811. {
  812. protected override IItemContainerGenerator CreateItemContainerGenerator()
  813. {
  814. return new ItemContainerGenerator<TestContainer>(
  815. this,
  816. TestContainer.ContentProperty,
  817. null);
  818. }
  819. }
  820. private class TestContainer : ContentControl
  821. {
  822. public TestContainer()
  823. {
  824. Template = new FuncControlTemplate<TestContainer>((parent, scope) => new ContentPresenter
  825. {
  826. Name = "PART_ContentPresenter",
  827. [~ContentPresenter.ContentProperty] = parent[~ContentControl.ContentProperty],
  828. [~ContentPresenter.ContentTemplateProperty] = parent[~ContentControl.ContentTemplateProperty],
  829. }.RegisterInNameScope(scope));
  830. }
  831. }
  832. }
  833. }