ItemsPresenterTests_Virtualization_Simple.cs 40 KB

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