Back to Home

ESO Lua File v100028

libraries/zo_templates/scrolltemplates.lua

[◄ back to folders ]
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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
--Vetical Scrollbar Base
------------------------
local OFF_ALPHA = 0.5
local SCROLL_AREA_ALPHA = 0.8
local ON_ALPHA = 1
local STATE_CHANGE_DURATION = 250
local MIN_SCROLL_VALUE = 0
local MAX_SCROLL_VALUE = 100
local MAX_FADE_DISTANCE_UI = 64
local DEFAULT_Y_DISTANCE_FROM_EDGE_WHERE_SELECTION_CAUSES_SCROLL = 150
local NO_SELECTED_DATA = nil
local NO_DATA_CONTROL = nil
local RESELECTING_DURING_REBUILD = true
local NOT_RESELECTING_DURING_REBUILD = false
local ANIMATE_INSTANTLY = true
ZO_SCROLL_LIST_OPERATION_ADVANCE_CURSOR = "advance_cursor"
ZO_SCROLL_LIST_OPERATION_LINE_BREAK = "line_break"
ZO_SCROLL_MOVEMENT_DIRECTION_NEGATIVE = -1
ZO_SCROLL_MOVEMENT_DIRECTION_NONE = 0
ZO_SCROLL_MOVEMENT_DIRECTION_POSITIVE = 1
ZO_SCROLL_BUILD_DIRECTION_LEFT_TO_RIGHT = 1
ZO_SCROLL_BUILD_DIRECTION_RIGHT_TO_LEFT = -1
ZO_SCROLL_SELECT_CATEGORY_PREVIOUS = -1
ZO_SCROLL_SELECT_CATEGORY_NEXT = 1
ZO_SCROLL_BAR_WIDTH = 16
-- Used by both ZO_VerticalScrollbarBase and ZO_Scroll
local function OnInteractWithScrollBar(self)
    end
end
----
-- Start of VerticalScrollbarBase functions
----
end
    self:SetMinMax(MIN_SCROLL_VALUE, MAX_SCROLL_VALUE)
    self:SetValue(MIN_SCROLL_VALUE)
    self.targetAlpha = OFF_ALPHA
    self:SetAlpha(self.targetAlpha)
    self.alphaAnimation, self.timeline = CreateSimpleAnimation(ANIMATION_ALPHA, self)
    self.alphaAnimation:SetDuration(STATE_CHANGE_DURATION)
    local function OnUpdate()
        if self.thumbHeld then
            OnInteractWithScrollBar(self)
        end
    end
    self:SetHandler("OnUpdate", OnUpdate)
end
local function UpdateAlpha(self)
    local newAlpha = OFF_ALPHA
    if self.areaOver then
        newAlpha = SCROLL_AREA_ALPHA
    end
    
    if self.thumbHeld or self.over then
        newAlpha = ON_ALPHA
    end
    
    if newAlpha ~= self:GetAlpha() then
        self.targetAlpha = newAlpha
        if self:IsHidden() then
            self:SetAlpha(newAlpha)
        else
            self.timeline:Stop()
            self.alphaAnimation:SetAlphaValues(self:GetAlpha(), newAlpha)
            self.timeline:PlayFromStart()
        end
    end
end
    self.over = true
    UpdateAlpha(self)
end
    self.over = false
    UpdateAlpha(self)
end
    local thumb = self:GetThumbTextureControl()
    if MouseIsOver(thumb) then
        self.thumbHeld = true
        UpdateAlpha(self)
    end
end
end
    self.thumbHeld = false
    UpdateAlpha(self)
end
    if self.timeline then
        self.timeline:Stop()
    end
    self:SetAlpha(self.targetAlpha)
end
    self.areaOver = true
    UpdateAlpha(self)
end
    self.areaOver = false
    UpdateAlpha(self)
end
----
-- End of VerticalScrollbarBase functions
----
local function CheckMouseInScrollArea(self)
    local inScrollArea = MouseIsOver(self)
    if inScrollArea ~= self.inScrollArea then
        self.inScrollArea = inScrollArea
        if inScrollArea then
            ZO_VerticalScrollbarBase_OnScrollAreaEnter(GetControl(self, "ScrollBar"))
        else
            ZO_VerticalScrollbarBase_OnScrollAreaExit(GetControl(self, "ScrollBar"))
        end
    end
end
    self.inScrollArea = nil
    self:SetHandler("OnUpdate", CheckMouseInScrollArea)
end
    self:SetHandler("OnUpdate", nil)
end
--Shared Scroll Animation Functions
---------------------------------------
local SCROLL_ANIMATION_UNITS_PERCENT = 1
local SCROLL_ANIMATION_UNITS_REAL = 2
local SCROLL_ANIMATION_DEFAULT_DURATION_MS = 400
local function OnScrollAnimationUpdate(animationObject, progress)
    local scrollObject = animationObject.scrollObject
    local value = scrollObject.animationStart + (scrollObject.animationTarget - scrollObject.animationStart) * progress
    if scrollObject.animationUnits == SCROLL_ANIMATION_UNITS_REAL then
        local _, verticalExtents = scrollObject.scroll:GetScrollExtents()
        if verticalExtents > 0 then
            value = MAX_SCROLL_VALUE * (value / verticalExtents)
        else
            value = 0
        end
    end
    scrollObject.scrollbar:SetValue(value)
end
local function SetScrollOffset(self, targetOffset, animateInstantly, overrideDurationMS)
    local scroll = self.scroll
    local _, currentOffset = scroll:GetScrollOffsets()
    if zo_abs(targetOffset - currentOffset) > 0.001 then
        self.timeline:Stop()
        self.animationStart = currentOffset
        self.animationTarget = targetOffset
        self.animationUnits = SCROLL_ANIMATION_UNITS_REAL
        self.animation:SetDuration(overrideDurationMS or SCROLL_ANIMATION_DEFAULT_DURATION_MS)
        if animateInstantly then
            self.timeline:PlayInstantlyToEnd()
        else
            self.timeline:PlayFromStart()
        end
    elseif self.onScrollCompleteCallback then 
        local SCROLL_ANIMATION_COMPLETE = true
        self.onScrollCompleteCallback(SCROLL_ANIMATION_COMPLETE) 
        self.onScrollCompleteCallback = nil
    end
end
local function SetSliderValue(self, targetValue, animateInstantly, overrideDurationMS)
    if self.scrollbar then
        local startValue = self.scrollbar:GetValue()
        local scrollMin, scrollMax = self.scrollbar:GetMinMax()
        targetValue = zo_clamp(targetValue, scrollMin, scrollMax)
        if zo_abs(startValue - targetValue) > 0.001 then 
            self.timeline:Stop()
            self.animationStart = startValue
            self.animationTarget = targetValue
            self.animationUnits = SCROLL_ANIMATION_UNITS_PERCENT
            self.animation:SetDuration(overrideDurationMS or SCROLL_ANIMATION_DEFAULT_DURATION_MS)
            if animateInstantly then
                self.timeline:PlayInstantlyToEnd()
            else
                self.timeline:PlayFromStart()
            end
        elseif self.onScrollCompleteCallback then 
            local SCROLL_ANIMATION_COMPLETE = true
            self.onScrollCompleteCallback(SCROLL_ANIMATION_COMPLETE) 
            self.onScrollCompleteCallback = nil 
        end
    end
end
local function OnAnimationStop(animationObject, control, completedPlaying)
    local scrollObject = animationObject.scrollObject
    scrollObject.animationStart = nil
    scrollObject.animationTarget = nil
    if scrollObject.onScrollCompleteCallback then 
        scrollObject.onScrollCompleteCallback(completedPlaying) 
        scrollObject.onScrollCompleteCallback = nil 
    end 
end
local function CreateScrollAnimation(scrollObject)
    local animation, timeline = CreateSimpleAnimation(ANIMATION_CUSTOM)
    animation.scrollObject = scrollObject
    animation:SetHandler("OnStop", OnAnimationStop)
    return animation, timeline
end
--Shared Scroll Edge Fades
-----------------------------------------------------------------
local function ComputeScrollFadeDistancesFromRealValues(sliderValue, sliderMin, sliderMax, maxFadeDistance)
    local topFadeDistance = zo_max(0, zo_min(sliderValue - sliderMin, maxFadeDistance))
    local bottomFadeDistance = zo_max(0, zo_min(sliderMax - sliderValue, maxFadeDistance))
    return topFadeDistance, bottomFadeDistance    
end
local function ComputeScrollFadeDistancesFromPercentValues(sliderValue, verticalExtents, maxFadeDistance)
    local realSliderMin = 0
    local realSliderMax = verticalExtents
    local realSliderValue = (sliderValue / MAX_SCROLL_VALUE) * verticalExtents
    return ComputeScrollFadeDistancesFromRealValues(realSliderValue, realSliderMin, realSliderMax, maxFadeDistance)
end
local function UpdateScrollFade(self, scroll, isPercent, sliderValue)
    if self.useFadeGradient then
        local slider = self.scrollbar
        sliderValue = sliderValue or slider:GetValue()
        local maxFadeDistance = ZO_Scroll_GetMaxFadeDistance(self)
        local topFadeDistance, bottomFadeDistance
        if isPercent then
            local _, verticalExtents = scroll:GetScrollExtents()
            topFadeDistance, bottomFadeDistance = ComputeScrollFadeDistancesFromPercentValues(sliderValue, verticalExtents, maxFadeDistance)
        else
            local sliderMin, sliderMax = slider:GetMinMax()
            topFadeDistance, bottomFadeDistance = ComputeScrollFadeDistancesFromRealValues(sliderValue, sliderMin, sliderMax, maxFadeDistance)
        end
        if topFadeDistance > 0 then
            scroll:SetFadeGradient(1, 0, 1, topFadeDistance)
        else
            scroll:SetFadeGradient(1, 0, 0, 0)
        end
        
        if bottomFadeDistance > 0 then
            scroll:SetFadeGradient(2, 0, -1, bottomFadeDistance)
        else
            scroll:SetFadeGradient(2, 0, 0, 0);
        end
    else
        scroll:SetFadeGradient(1, 0, 0, 0)
        scroll:SetFadeGradient(2, 0, 0, 0)
    end
end
--Scroll Control - Encapsulates a scroll control with a scrollbar
-----------------------------------------------------------------
--Init
local function ZO_ScrollUp_OnMouseDown(self)
end
local function ZO_ScrollDown_OnMouseDown(self)
end
local function ZO_Scroll_ScrollOrBarOnHeightChanged(scrollOrBarControl, newHeight)
    local scrollPane = scrollOrBarControl:GetParent()
    ZO_Scroll_UpdateScrollBar(scrollPane)
end
    self.scroll = GetControl(self, "Scroll")
    self.scroll:SetHandler("OnRectHeightChanged", ZO_Scroll_ScrollOrBarOnHeightChanged)
    self.scrollbar = GetControl(self, "ScrollBar")
    
    if self.scrollbar then
        self.scrollUpButton = GetControl(self.scrollbar, "Up")
        self.scrollUpButton:SetHandler("OnMouseDown", ZO_ScrollUp_OnMouseDown)
        self.scrollDownButton = GetControl(self.scrollbar, "Down")
        self.scrollDownButton:SetHandler("OnMouseDown", ZO_ScrollDown_OnMouseDown)
        self.scrollbar:SetHandler("OnRectHeightChanged", ZO_Scroll_ScrollOrBarOnHeightChanged)
    end
    
    self.useScrollbar = true
    self.hideScrollBarOnDisabled = true
    self.useFadeGradient = true
    self.animation, self.timeline = CreateScrollAnimation(self)
    
end
--Scrolling functions
    if self.timeline then
        self.timeline:Stop()
    end
    if self.scrollbar then
        self.scrollbar:SetValue(MIN_SCROLL_VALUE)
    end
end
    local scroll = self.scroll
    local _, verticalExtents = scroll:GetScrollExtents()
    if verticalExtents > 0 then
        SetSliderValue(self, (value / verticalExtents) * MAX_SCROLL_VALUE)
    end
end
    local scroll = self.scroll
    local scrollbar = self.scrollbar
    local _, verticalExtents = scroll:GetScrollExtents()
    local targetValue = (value / verticalExtents) * MAX_SCROLL_VALUE
    local scrollMin, scrollMax = scrollbar:GetMinMax()
    targetValue = zo_clamp(targetValue, scrollMin, scrollMax)
    SetSliderValue(self, targetValue, ANIMATE_INSTANTLY)
end
function ZO_Scroll_ScrollRelative(self, verticalDelta)
    local scroll = self.scroll
    local _, verticalExtents = scroll:GetScrollExtents()   
    
    if verticalExtents > 0 then
        if self.animationTarget then
            local oldVerticalOffset
            if self.animationUnits == SCROLL_ANIMATION_UNITS_PERCENT then
                oldVerticalOffset = (self.animationTarget * verticalExtents) / MAX_SCROLL_VALUE
            else
                oldVerticalOffset = self.animationTarget
            end
            local newVerticalOffset = oldVerticalOffset + verticalDelta
            SetSliderValue(self, (newVerticalOffset / verticalExtents) * MAX_SCROLL_VALUE)
        else
            local _, currentVerticalOffset = scroll:GetScrollOffsets()
            local newVerticalOffset = currentVerticalOffset + verticalDelta
            SetSliderValue(self, (newVerticalOffset / verticalExtents) * MAX_SCROLL_VALUE)
        end
    end
end
    local scroll = self.scroll
    local _, verticalExtents = scroll:GetScrollExtents()
    scroll:SetVerticalScroll((value/MAX_SCROLL_VALUE) * verticalExtents)
end
local SCROLL_TO_SIDE_TOP = 1
local SCROLL_TO_SIDE_BOTTOM = 2
function ZO_Scroll_GetScrollDistanceToControl(self, otherControl, scrollToSide)
    local scroll = self.scroll
    local scrollTop = scroll:GetTop()
    local scrollBottom = scroll:GetBottom()
    local controlTop = otherControl:GetTop()
    local controlBottom = otherControl:GetBottom()   
 
    local scrollDistance = 0
    if scrollToSide == SCROLL_TO_SIDE_TOP then -- The control's top is above the top edge of the scroll, must scroll up to fully contain the control.
        scrollDistance = controlTop - scrollTop
    elseif scrollToSide == SCROLL_TO_SIDE_BOTTOM  then -- The control's bottom is below the bottom edge of the scroll, must scroll down to fully contain the control.
        scrollDistance = controlBottom - scrollBottom
    end
    if scrollDistance ~= 0 and self.useFadeGradient then
        local _, verticalOffset = scroll:GetScrollOffsets()
        local _, verticalExtents = scroll:GetScrollExtents()
        local verticalOffsetAfterScroll = zo_clamp(verticalOffset + scrollDistance, 0, verticalExtents)
        local topFadeDistance, bottomFadeDistance = ComputeScrollFadeDistancesFromRealValues(verticalOffsetAfterScroll, 0, verticalExtents, ZO_Scroll_GetMaxFadeDistance(self))
        if scrollToSide == SCROLL_TO_SIDE_TOP then
            -- divide by 2 for effect
            scrollDistance = scrollDistance - topFadeDistance * 0.5
        else
            -- divide by 2 for effect
            scrollDistance = scrollDistance + bottomFadeDistance * 0.5
        end
    end
    
    return scrollDistance
end
function ZO_Scroll_ScrollToControl(self, otherControl)
    local scroll = self.scroll
    local scrollTop = scroll:GetTop()
    local scrollBottom = scroll:GetBottom()
    local controlTop = otherControl:GetTop()
    local controlBottom = otherControl:GetBottom()   
 
    local scrollToSide
    if controlTop < scrollTop then -- The control's top is above the top edge of the scroll, must scroll up to fully contain the control.
        scrollToSide = SCROLL_TO_SIDE_TOP
    elseif controlBottom > scrollBottom then -- The control's bottom is below the bottom edge of the scroll, must scroll down to fully contain the control.
        scrollToSide = SCROLL_TO_SIDE_BOTTOM
    end
  
    local scrollDistance = ZO_Scroll_GetScrollDistanceToControl(self, otherControl, scrollToSide)
    if scrollDistance ~= 0 then    
         ZO_Scroll_ScrollRelative(self, scrollDistance)
    end
end
function ZO_Scroll_ScrollControlToTop(self, otherControl)
    local scrollDistance = ZO_Scroll_GetScrollDistanceToControl(self, otherControl, SCROLL_TO_SIDE_TOP)
    if scrollDistance ~= 0 then    
         ZO_Scroll_ScrollRelative(self, scrollDistance)
    end
end
function ZO_Scroll_ScrollControlToBottom(self, otherControl)
    local scrollDistance = ZO_Scroll_GetScrollDistanceToControl(self, otherControl, SCROLL_TO_SIDE_BOTTOM)
    if scrollDistance ~= 0 then    
         ZO_Scroll_ScrollRelative(self, scrollDistance)
    end
end
    local scroll = self.scroll
    local scrollTop = scroll:GetTop()
    local scrollBottom = scroll:GetBottom()
    local controlTop = control:GetTop()
    local controlBottom = control:GetBottom()
    
    return controlTop >= scrollTop and controlBottom <= scrollBottom
end
function ZO_Scroll_ScrollControlIntoView(self, otherControl)
    local scroll = self.scroll
    local scrollTop = scroll:GetTop()
    local scrollBottom = scroll:GetBottom()
    local controlTop = otherControl:GetTop()
    local controlBottom = otherControl:GetBottom()
    
    if controlTop < scrollTop then
        ZO_Scroll_ScrollRelative(self, controlTop - scrollTop)
    elseif controlBottom > scrollBottom then
        ZO_Scroll_ScrollRelative(self, controlBottom - scrollBottom)
    end
end
function ZO_Scroll_ScrollControlIntoCentralView(self, otherControl, scrollInstantly)
    local scroll = self.scroll
    local _, verticalExtents = scroll:GetScrollExtents()
    local _, verticalOffset = scroll:GetScrollOffsets()
    local scrollTop = scroll:GetTop()
    local scrollBottom = scroll:GetBottom()
    local controlTop = otherControl:GetTop()
    local controlBottom = otherControl:GetBottom()
    local halfControlHeight = (controlBottom - controlTop) * 0.5
    local halfScrollHeight = (scrollBottom - scrollTop) * 0.5
    local scrollDistance = controlTop + halfControlHeight - scrollTop - halfScrollHeight
    local scrollToValue = zo_clamp(verticalOffset + scrollDistance, 0, verticalExtents)
    if scrollInstantly then
        ZO_Scroll_ResetToTop(self)
        local targetValue = (scrollToValue / verticalExtents) * MAX_SCROLL_VALUE
        SetSliderValue(self, targetValue, scrollInstantly)
    else
        ZO_Scroll_ScrollAbsolute(self, scrollToValue)
    end
end
function ZO_Scroll_SetScrollToRealOffsetAccountingForGradients(self, finalTotalHeight, controlFinalTopOffset, durationMS)
    local scroll = self.scroll
    local scrollHeight = scroll:GetHeight()
    local finalVerticalExtents = zo_max(finalTotalHeight - scrollHeight, 0)
    local finalVerticalOffset = controlFinalTopOffset
    if self.useFadeGradient then            
        local topGradientHeight = ComputeScrollFadeDistancesFromRealValues(finalVerticalOffset, 0, finalVerticalExtents, ZO_Scroll_GetMaxFadeDistance(self))
            -- divide by 2 for effect
        finalVerticalOffset = finalVerticalOffset - topGradientHeight * 0.5
    end
    finalVerticalOffset = zo_clamp(finalVerticalOffset, 0, finalVerticalExtents)
    local DONT_ANIMATE_INSTANTLY = false
    SetScrollOffset(self, finalVerticalOffset, DONT_ANIMATE_INSTANTLY, durationMS)
end
--Scroll update functions
    if self and self.scroll and not self.targetControl then
    end
end
function ZO_Scroll_OnMouseWheel(self, delta)
    ZO_Scroll_ScrollRelative(self, -delta * 40)
end
    if self.scrollbar then
    end
end
function ZO_Scroll_UpdateScrollBar(self, forceUpdateBarValue)
    local scroll = self.scroll
    local _, verticalOffset = scroll:GetScrollOffsets()
    local _, verticalExtents   = scroll:GetScrollExtents()
    local scrollEnabled = verticalExtents > 0 or verticalOffset > 0
    local scrollbar  = self.scrollbar
    local scrollIndicator = self.scrollIndicator
    local scrollbarHidden = not self.useScrollbar or (self.hideScrollBarOnDisabled and not scrollEnabled)
    local verticalExtentsChanged = self.verticalExtents ~= nil and not zo_floatsAreEqual(self.verticalExtents, verticalExtents)
    self.verticalExtents = verticalExtents
    if scrollbar then
        --thumb resizing
        local scrollBarHeight = scrollbar:GetHeight()
        local scrollAreaHeight = scroll:GetHeight()
        if verticalExtents > 0 and scrollBarHeight >= 0 and scrollAreaHeight >= 0 then
            local thumbHeight = scrollBarHeight * scrollAreaHeight /(verticalExtents + scrollAreaHeight)
            scrollbar:SetThumbTextureHeight(thumbHeight)
        else
            scrollbar:SetThumbTextureHeight(scrollBarHeight)
        end
        --set mouse input enabled based on scrollability
        scroll:SetMouseEnabled(scrollEnabled)
        --auto scroll bar hiding
        local wasHidden = scrollbar:IsHidden()
        scrollbar:SetHidden(scrollbarHidden)
        scrollbar:SetMinMax(MIN_SCROLL_VALUE, not scrollbarHidden and MAX_SCROLL_VALUE or MIN_SCROLL_VALUE)
        if wasHidden and not scrollbarHidden and scrollbar.resetScrollbarOnShow then
            ZO_Scroll_ResetToTop(self)
            self.scrollValue = MIN_SCROLL_VALUE
        end
        --update the scrollBar value when the extents changes or explicitly ask to
        if verticalExtentsChanged or forceUpdateBarValue then
            if verticalExtents > 0 then
                local previousScrollBarValue = scrollbar:GetValue()
                local finalValue = MAX_SCROLL_VALUE * (verticalOffset / verticalExtents)
                if not zo_floatsAreEqual(previousScrollBarValue, finalValue) then
                    scrollbar:SetValue(finalValue)
                end
                -- If the previous and current scrollBar values are the same,
                -- the onValueChanged function will not be invoked to update the scroll child position.
                -- We need to explicitly call to recalculate our scroll child position since our extents changed.
                if previousScrollBarValue == scrollbar:GetValue() then
                    scroll:SetVerticalScroll(verticalOffset)
                end
            else
                ZO_Scroll_ResetToTop(self)
            end
        end
        local IS_PERCENT = true
        UpdateScrollFade(self, scroll, IS_PERCENT)
    elseif scrollIndicator then
        --auto scroll indicator hiding
        local wasHidden = scrollIndicator:IsHidden()
        scrollIndicator:SetHidden(scrollbarHidden)
        if wasHidden and not scrollbarHidden then
            ZO_Scroll_ResetToTop(self)
            self.scrollValue = 0
        end
        --extents updating
        if verticalExtentsChanged then
            if verticalExtents <= 0 then
                ZO_Scroll_ResetToTop(self)
            end
        end
        ZO_UpdateScrollFade(self.useFadeGradient, scroll, ZO_SCROLL_DIRECTION_VERTICAL)
    end
end
--Visual Config
    return self.scrollIndicator
end
    self.hideScrollBarOnDisabled = hide    
end
function ZO_Scroll_SetUseScrollbar(self, useScrollbar)
    self.useScrollbar = useScrollbar
end
function ZO_Scroll_SetUseFadeGradient(self, useFadeGradient)
    self.useFadeGradient = useFadeGradient
end
function ZO_Scroll_SetMaxFadeDistance(self, maxFadeDistance)
    self.maxFadeDistanceUI = maxFadeDistance
end
    return self.maxFadeDistanceUI or MAX_FADE_DISTANCE_UI
end
function ZO_Scroll_SetupGutterTexture(self, textureControl)
    textureControl:ClearAnchors()
    textureControl:SetAnchor(TOPLEFT, self.scrollUpButton, BOTTOMLEFT, 0, 0)
    textureControl:SetAnchor(BOTTOMRIGHT, self.scrollDownButton, TOPRIGHT, 0, 0)
    textureControl:SetParent(self.scrollbar)
    
    self.gutter = textureControl
    
end
function ZO_Scroll_SetResetScrollbarOnShow(self, resetOnShow)
    self.resetScrollbarOnShow = resetOnShow
end
--Scroll List Control
--A scrollable list of controls that reuses controls as they scroll out of view.
--Use this control when you have a very large number of a couple different types of controls to display.
--To use:
--(1) Add a scroll list to your XML.
--(2) Add data types to the scroll list, one for each type of control. A data type includes an XML control template, a height, and a callback that can setup the control given data.
--(3) Add data to the scroll list. First, use GetDataList to get the table holding the data. Next, use CreateDataEntry to create a list element of a certain data type. You may pass
-- in an arbitrary piece of data that will be given to the setup callback when the control is shown. Once you have made as many data entries as you need, add them to the data
-- list in any way you want. Finally, call Commit to update the scroll list with your data.
-- Note: The scroll list can use faster update logic if all controls are the same height.
-------------------------------------------------------------------------------------------------------------
local SCROLL_LIST_UNIFORM = 1
local SCROLL_LIST_NON_UNIFORM = 2
local SCROLL_LIST_OPERATIONS = 3
local NO_HEIGHT_SET = -1
end
end
    self.dataTypes = {}
    self.data = {}
    self.offset = 0
    self.yDistanceFromEdgeWhereSelectionCausesScroll = DEFAULT_Y_DISTANCE_FROM_EDGE_WHERE_SELECTION_CAUSES_SCROLL
    self.activeControls = {}
    self.visibleData = {}
    self.categories = {}
    self.mode = SCROLL_LIST_UNIFORM
    self.buildDirection = ZO_SCROLL_BUILD_DIRECTION_LEFT_TO_RIGHT
    self.uniformControlHeight = NO_HEIGHT_SET
    
    self.highlightLocked = false
    self.highlightedControl = nil
    self.highlightCallback = nil
    self.pendingHighlightControl = nil
    
    self.selectedControl = nil
    self.selectedData = nil
    self.selectedDataIndex = nil
    self.lastSelectedDataIndex = nil
    self.selectionDataTypes = nil
    self.deselectOnReselect = true
    self.autoSelect = false
    
    self.contents = GetControl(self, "Contents")
    self.scrollbar = GetControl(self, "ScrollBar")
    self.upButton = GetControl(self.scrollbar, "Up")
    self.upButton:SetHandler("OnMouseDown", ZO_ScrollListUp_OnMouseDown)
    self.downButton = GetControl(self.scrollbar, "Down")
    self.downButton:SetHandler("OnMouseDown", ZO_ScrollListDown_OnMouseDown)
    
    self.scrollbar:SetEnabled(false)
    self.animation, self.timeline = CreateScrollAnimation(self)
    self.hideScrollBarOnDisabled = true
    self.useScrollbar = true
    self.useFadeGradient = true
end
function ZO_ScrollList_SetYDistanceFromEdgeWhereSelectionCausesScroll(self, yDistanceFromEdgeWhereSelectionCausesScroll)
    self.yDistanceFromEdgeWhereSelectionCausesScroll = yDistanceFromEdgeWhereSelectionCausesScroll
end
function ZO_ScrollList_SetHeight(self, height)
    self:SetHeight(height)
end
    return self:GetHeight()
end
local function AreSelectionsEnabled(self)
    if self.selectionTemplate or self.selectionCallback then
        return true
    else
        return false
    end
end
    local function OnScreenResized()
        ZO_ScrollList_Commit(self)    
    end
    self:RegisterForEvent(EVENT_SCREEN_RESIZED, OnScreenResized)
end
local function UpdateModeFromHeight(self, height)
    if self.mode == SCROLL_LIST_UNIFORM then
        if self.uniformControlHeight == NO_HEIGHT_SET then
            self.uniformControlHeight = height
        elseif height ~= self.uniformControlHeight then
            self.uniformControlHeight = nil
            self.mode = SCROLL_LIST_NON_UNIFORM
            ZO_ScrollList_Commit(self)
        end
    end
end
--Adds a new control type for the list to handle. It must maintain a consistent size.
--@typeId - A unique identifier to give to CreateDataEntry when you want to add an element of this type.
--@templateName - The name of the virtual control template that will be used to hold this data
--@height - The control height
--@setupCallback - The function that will be called when a control of this type becomes visible. Signature: setupCallback(control, data)
--@dataTypeSelectSound - An optional sound to play when a row of this data type is selected.
--@resetControlCallback - An optional callback when the datatype control gets reset.
function ZO_ScrollList_AddDataType(self, typeId, templateName, height, setupCallback, hideCallback, dataTypeSelectSound, resetControlCallback)
    if not self.dataTypes[typeId] then
        local factoryFunction = function(objectPool) return ZO_ObjectPool_CreateNamedControl(string.format("%s%dRow", self:GetName(), typeId), templateName, objectPool, self.contents) end
        local pool = ZO_ObjectPool:New(factoryFunction, resetControlCallback or ZO_ObjectPool_DefaultResetControl)
        self.dataTypes[typeId] = 
        {
            height = height,
            setupCallback = setupCallback,
            hideCallback = hideCallback,
            pool = pool,
            selectSound = dataTypeSelectSound,
            selectable = true,
        }
        
        --automatically choose the scrolling logic based on if the controls are all the same height or not
        UpdateModeFromHeight(self, height)
    end
end
-- Scroll List Construction Operations --
local function GetLineBreakPositions(layoutInfo, currentX, currentY, lineBreakAmount, indentX)
    indentX = indentX or 0
    currentX = layoutInfo.startPos + indentX * layoutInfo.direction
    currentY = currentY + lineBreakAmount + layoutInfo.lineBreakModifier
    layoutInfo.lineBreakModifier = 0
    return currentX, currentY
end
-- ZO_ScrollListOperation --
ZO_ScrollListOperation = ZO_Object:Subclass()
function ZO_ScrollListOperation:New()
    local operation = ZO_Object.New(self)
    operation:Initialize()
    return operation
end
function ZO_ScrollListOperation:Initialize()
    self.selectable = false
end
function ZO_ScrollListOperation:GetPositionsAndAdvance(layoutInfo, currentX, currentY, data)
    assert(false) -- Override in derived classes
end
function ZO_ScrollListOperation:AddToScrollContents(contents, control, offset)
    assert(false) -- Override in derived classes
end
-- ZO_ScrollList_AdvanceCursor_Operation --
ZO_ScrollList_AdvanceCursor_Operation = ZO_ScrollListOperation:Subclass()
function ZO_ScrollList_AdvanceCursor_Operation:New()
    return ZO_ScrollListOperation.New(self)
end
function ZO_ScrollList_AdvanceCursor_Operation:GetPositionsAndAdvance(layoutInfo, currentX, currentY, data)
    local instanceData = data.data
    data.top = currentY
    data.bottom = currentY + instanceData.moveY
    data.left = currentX
    data.right = currentX + instanceData.moveX * layoutInfo.direction
    currentX = data.right
    currentY = currentY + instanceData.moveY
    return currentX, currentY
end
function ZO_ScrollList_AdvanceCursor_Operation:AddToScrollContents(contents, control, offset)
    assert(false) -- Cannot add this operation to contents
end
-- ZO_ScrollList_LineBreak_Operation --
ZO_ScrollList_LineBreak_Operation = ZO_ScrollListOperation:Subclass()
function ZO_ScrollList_LineBreak_Operation:New()
    return ZO_ScrollListOperation.New(self)
end
function ZO_ScrollList_LineBreak_Operation:GetPositionsAndAdvance(layoutInfo, currentX, currentY, data)
    local instanceData = data.data
    data.top = currentY
    data.bottom = currentY + instanceData.lineBreakAmount + layoutInfo.lineBreakModifier
    if layoutInfo.startPos < layoutInfo.endPos then
        data.left = layoutInfo.startPos
        data.right = layoutInfo.endPos
    else
        data.left = layoutInfo.endPos
        data.right = layoutInfo.startPos
    end
    local indentX = instanceData.indentX or 0
    currentX, currentY = GetLineBreakPositions(layoutInfo, currentX, currentY, instanceData.lineBreakAmount, indentX)
    return currentX, currentY
end
function ZO_ScrollList_LineBreak_Operation:AddToScrollContents(contents, control, offset)
    assert(false) -- Cannot add a line break to contents
end
-- ZO_ScrollList_AddControl_Operation --
ZO_ScrollList_AddControl_Operation = ZO_ScrollListOperation:Subclass()
function ZO_ScrollList_AddControl_Operation:New()
    return ZO_ScrollListOperation.New(self)
end
function ZO_ScrollList_AddControl_Operation:Initialize()
    ZO_ScrollListOperation.Initialize(self)
    -- Defined set of actions this operation can use
    self.controlWidth = 0
    self.controlHeight = 0
    self.spacingX = 0
    self.spacingY = 0
    self.selectable = true
    self.templateName = nil
    self.pool = nil
    self.showCallback = nil
    self.hideCallback = nil
    self.onSelectSound = nil
end
function ZO_ScrollList_AddControl_Operation:SetSpacingValues(spacingX, spacingY)
    self.spacingX = spacingX
    self.spacingY = spacingY
end
-- A controlWidth of nil will cause controls to be added Anchor TOPLEFT Anchor TOPRIGHT to fill the horizontal space of the parent control
function ZO_ScrollList_AddControl_Operation:SetControlTemplate(templateName, parentControl, operationId, controlWidth, controlHeight, resetControlCallback)
    if self.templateName then
        return
    end
    self.controlWidth = controlWidth
    self.controlHeight = controlHeight
    self.templateName = templateName
    local factoryFunction = function(objectPool)
        local controlName = string.format("%s%dControl", parentControl:GetName(), operationId)
        return ZO_ObjectPool_CreateNamedControl(controlName, templateName, objectPool, parentControl)
    end
    self.pool = ZO_ObjectPool:New(factoryFunction, resetControlCallback or ZO_ObjectPool_DefaultResetControl)
end
function ZO_ScrollList_AddControl_Operation:SetSelectable(isSelectable)
    self.selectable = isSelectable
end
function ZO_ScrollList_AddControl_Operation:SetIndentAmount(indentX)
    self.indentX = indentX
end
function ZO_ScrollList_AddControl_Operation:SetOnSelectedSound(onSelectSound)
    self.onSelectSound = onSelectSound
end
function ZO_ScrollList_AddControl_Operation:SetScrollUpdateCallbacks(setupCallback, hideCallback)
end
function ZO_ScrollList_AddControl_Operation:GetPositionsAndAdvance(layoutInfo, currentX, currentY, data)
    local controlWidth = self.controlWidth
    if controlWidth then
        if currentX * layoutInfo.direction + controlWidth > layoutInfo.endPos then
            currentX, currentY = GetLineBreakPositions(layoutInfo, currentX, currentY, self.spacingY, self.indentX)
        end
        -- Calculate left and right based on the direction we are told to advance
        -- Since we want Left to always be less than Right, and having Right_To_Left
        -- build direction will cause Left to be greater than Right
        -- we need to compensate for that fact in this case, but keep the calculation the same
        -- when we are in the direction of Left_To_Right
        local halfControlWidth = controlWidth / 2 
        data.left = currentX - halfControlWidth + halfControlWidth * layoutInfo.direction
        data.right = currentX + halfControlWidth + halfControlWidth * layoutInfo.direction
        data.top = currentY
        data.bottom = currentY + self.controlHeight
        currentX = currentX + (controlWidth + self.spacingX) * layoutInfo.direction
        layoutInfo.lineBreakModifier = zo_max(layoutInfo.lineBreakModifier, self.controlHeight)
    else
        if layoutInfo.startPos < layoutInfo.endPos then
            data.left = layoutInfo.startPos
            data.right = layoutInfo.endPos
        else
            data.left = layoutInfo.endPos
            data.right = layoutInfo.startPos
        end
        data.top = currentY
        data.bottom = currentY + self.controlHeight
        layoutInfo.lineBreakModifier = zo_max(layoutInfo.lineBreakModifier, self.controlHeight)
        currentX, currentY = GetLineBreakPositions(layoutInfo, currentX, currentY, self.spacingY, self.indentX)
    end
    return currentX, currentY
end
function ZO_ScrollList_AddControl_Operation:AddToScrollContents(contents, control, currentX, currentY, offset)
    local xOffset = currentX
    local yOffset = currentY - offset
    if self.controlWidth then
        control:SetAnchor(TOPLEFT, contents, TOPLEFT, xOffset, yOffset)
    else
        control:SetAnchor(TOPLEFT, contents, TOPLEFT, xOffset, yOffset)
        control:SetAnchor(TOPRIGHT, contents, TOPRIGHT, xOffset, yOffset)
    end
end
-- ZO_ScrollList_AddControl_Centered_Operation --
ZO_ScrollList_AddControl_Centered_Operation = ZO_ScrollList_AddControl_Operation:Subclass()
function ZO_ScrollList_AddControl_Centered_Operation:New()
    return ZO_ScrollList_AddControl_Operation.New(self)
end
function ZO_ScrollList_AddControl_Centered_Operation:AddToScrollContents(contents, control, currentX, currentY, offset)
    local xOffset = currentX
    local yOffset = currentY - offset
    if self.controlWidth then
        control:SetAnchor(CENTER, contents, TOPLEFT, xOffset + self.controlWidth / 2, yOffset + self.controlHeight / 2)
    else
        control:SetAnchor(TOPLEFT, contents, TOPLEFT, xOffset, yOffset)
        control:SetAnchor(TOPRIGHT, contents, TOPRIGHT, xOffset, yOffset)
    end
end
do
    local advanceCursorOperation = ZO_ScrollList_AdvanceCursor_Operation:New()
    local lineBreakOperation = ZO_ScrollList_LineBreak_Operation:New()
    function GetDataTypeInfo(self, typeId)
        if typeId == ZO_SCROLL_LIST_OPERATION_ADVANCE_CURSOR then
            return advanceCursorOperation
        elseif typeId == ZO_SCROLL_LIST_OPERATION_LINE_BREAK then
            return lineBreakOperation
        end
    
        return self.dataTypes[typeId]
    end
end
function ZO_ScrollList_SetBuildDirection(self, buildDirection)
    self.buildDirection = buildDirection
end
-- A controlWidth of nil will cause controls to be added Anchor TOPLEFT Anchor TOPRIGHT to fill the horizontal space of the parent control
function ZO_ScrollList_AddControlOperation(self, operationId, templateName, controlWidth, controlHeight, resetControlCallback, showCallback, hideCallback, spacingX, spacingY, indentX, selectable, centerEntries)
    if not self.dataTypes[operationId] then
        local operation = centerEntries and ZO_ScrollList_AddControl_Centered_Operation:New() or ZO_ScrollList_AddControl_Operation:New()
        operation:SetSpacingValues(spacingX, spacingY)
        operation:SetControlTemplate(templateName, self.contents, operationId, controlWidth, controlHeight, resetControlCallback)
        operation:SetScrollUpdateCallbacks(showCallback, hideCallback)
        operation:SetSelectable(selectable)
        operation:SetIndentAmount(indentX)
        self.dataTypes[operationId] = operation
        self.mode = SCROLL_LIST_OPERATIONS
    end
end
    return self.dataTypes[typeId]
end
function ZO_ScrollList_UpdateDataTypeHeight(self, typeId, newHeight)
    local dataTable = ZO_ScrollList_GetDataTypeTable(self, typeId)
    if dataTable and dataTable.height ~= newHeight then
        dataTable.height = newHeight
        UpdateModeFromHeight(self, newHeight)
    end
end
function ZO_ScrollList_SetTypeSelectable(self, typeId, selectable)
    self.dataTypes[typeId].selectable = selectable
end
function ZO_ScrollList_SetTypeCategoryHeader(self, typeId, isHeader)
    self.dataTypes[typeId].categoryHeader = isHeader
end
    self.dataTypes[typeId].equalityFunction = equalityFunction
end
function ZO_ScrollList_SetDeselectOnReselect(self, deselectOnReselect)
    self.deselectOnReselect = deselectOnReselect
end
function ZO_ScrollList_SetAutoSelect(self, autoSelect)
    self.autoSelect = autoSelect
end
end
function ZO_ScrollList_AddCategory(self, categoryId, parentId)
    if self.categories[categoryId] then
        return
    end    
    
    --if a parent id is given and it doesn't exist, give up
    local parent = nil
    if parentId then
        parent = self.categories[parentId]
        if not parent then
            return
        end        
    end
    
    local category = {id = categoryId, parent = parent, children = {}, hidden = false}
    self.categories[categoryId] = category
    if parent then
        table.insert(parent.children, category)
    end
end
    self.categories = {}
    if AreSelectionsEnabled(self) then
        ZO_ScrollList_SelectData(self, NO_SELECTED_DATA, NO_DATA_CONTROL, RESELECTING_DURING_REBUILD, ANIMATE_INSTANTLY)
        self.lastSelectedDataIndex = nil
    end
end
function ZO_ScrollList_GetCategoryHidden(self, categoryId)
    local category = self.categories[categoryId]
    if category then
        return category.hidden
    end
end
--Creates a data entry for use in the scroll list. Add it to the data list then commit it.
function ZO_ScrollList_CreateDataEntry(typeId, data, categoryId)
    local entry =
    {
        typeId = typeId,
        categoryId = categoryId,
        data = data,
    }
    data.dataEntry = entry
    return entry
end
function ZO_ScrollList_AddOperation(self, operationId, data)
    local operation =
    {
        typeId = operationId,
        data = data
    }
    
    if data then
        data.dataEntry = operation -- Used in the comparison function
    end
    local scrollData = ZO_ScrollList_GetDataList(self)
    table.insert(scrollData, operation)
end
    return entry.data
end
    if control.dataEntry then
        return control.dataEntry.data
    end
end
    return self.data
end
    return #self.visibleData > 0
end
    if AreSelectionsEnabled(self) then
        return self.selectedDataIndex
    end
    return nil
end
    if AreSelectionsEnabled(self) then
        return self.selectedData
    end
    return nil
end
end
--Allows you to prevent the list from scrolling
    self.lock = lock
end
    for i = 0, #self.activeControls do
        local control = self.activeControls[i]
        if MouseIsOver(control) then
            return control
        end
    end
end
local function PlayAnimationOnControl(control, controlTemplate, animationFieldName, animateInstantly, overrideEndAlpha)
    if controlTemplate then
        if not control[animationFieldName] then
            local highlight = CreateControlFromVirtual("$(parent)Scroll", control, controlTemplate, animationFieldName)
            control[animationFieldName] = ANIMATION_MANAGER:CreateTimelineFromVirtual("ShowOnMouseOverLabelAnimation", highlight)
            if overrideEndAlpha then
                control[animationFieldName]:GetAnimation(1):SetAlphaValues(0, overrideEndAlpha)
            end
        end
        if animateInstantly then
            control[animationFieldName]:PlayInstantlyToEnd()
        else
            control[animationFieldName]:PlayForward()
        end
    end
end
local function RemoveAnimationOnControl(control, animationFieldName, animateInstantly)
    if control[animationFieldName] then
        if animateInstantly then
            control[animationFieldName]:PlayInstantlyToStart()
        else
            control[animationFieldName]:PlayBackward()
        end
    end
end
local function HighlightControl(self, control)
    local ANIMATE_INSTANTLY = false
    PlayAnimationOnControl(control, self.highlightTemplate, "HighlightAnimation", ANIMATE_INSTANTLY, self.overrideHighlightEndAlpha)
    self.highlightedControl = control
    
    if self.highlightCallback then
        self.highlightCallback(control, true)
    end   
end
local function UnhighlightControl(self, control) 
    RemoveAnimationOnControl(control, "HighlightAnimation")
    self.highlightedControl = nil
    if self.highlightCallback then
        self.highlightCallback(control, false)
    end
end
local function SelectControl(self, control, animateInstantly)
    PlayAnimationOnControl(control, self.selectionTemplate, "SelectionAnimation", animateInstantly)
    self.selectedControl = control
end
local function UnselectControl(self, control, animateInstantly)
    RemoveAnimationOnControl(control, "SelectionAnimation", animateInstantly)
    self.selectedControl = nil
end
--Allows you to lock the highlight in place. The highlight will automatically unlock if the list is recommitted.
    if not self.highlightTemplate or (self.highlightLocked == lock) then
        return
    end
   
    self.highlightLocked = lock
    
    if lock then
        self.pendingHighlightControl = self.highlightedControl
    else
        if self.highlightedControl then
            UnhighlightControl(self, self.highlightedControl)
        end
        if self.pendingHighlightControl then
            HighlightControl(self, self.pendingHighlightControl)
        end
    end
end
--Reinitializes the highlight (used mostly when a mouse enter would have been missed)
local function RefreshHighlight(self)
    if not self.highlightTemplate then
        return
    end
    self.highlightLocked = false
    if self.highlightedControl then
        UnhighlightControl(self, self.highlightedControl)
    end
    
    --find the control to highlight if any
    for i = 0, #self.activeControls do
        local control = self.activeControls[i]
        if MouseIsOver(control) then
            HighlightControl(self, control)
            return
        end
    end
end
    if not self.highlightTemplate then
        return
    end
    
    --allows us to place the highlight correctly when we unlock
    if self.highlightLocked then
        self.pendingHighlightControl = control
        return
    end
    
end
    if not self.highlightTemplate then
        return
    end
    
    if self.highlightLocked then
        self.pendingHighlightControl = nil
        return
    end
    
end
    if AreSelectionsEnabled(self) then
        if control == self.selectedControl then
            if self.deselectOnReselect then
                ZO_ScrollList_SelectData(self, nil)
            end
        else
            local data = ZO_ScrollList_GetData(control)
            local typeId = control.dataEntry.typeId
            local selectSound = GetDataTypeInfo(self, typeId).selectSound
            ZO_ScrollList_SelectData(self, data, control)
            if selectSound then
                PlaySound(selectSound)
            end
        end
    end
end
function ZO_ScrollList_EnableHighlight(self, highlightTemplate, highlightCallback, overrideEndAlpha)
    if not self.highlightTemplate then
        self.highlightTemplate = highlightTemplate
        
        self.highlightLocked = false
        self.pendingHighlightControl = nil
        self.overrideHighlightEndAlpha = overrideEndAlpha
        
        RefreshHighlight(self)
    end
end
function ZO_ScrollList_SetHideScrollbarOnDisable(self, hideOnDisable)
    -- Not updating state here, you should call this when the list is being created.
    -- The bar will update state properly when the list has data committed.
    self.hideScrollBarOnDisabled = hideOnDisable
end
function ZO_ScrollList_SetUseScrollbar(self, useScrollbar)
    -- Not updating state here, you should call this when the list is being created.
    -- The bar will update state properly when the list has data committed.
    self.useScrollbar = useScrollbar
end
function ZO_ScrollList_SetUseFadeGradient(self, useFadeGradient)
    self.useFadeGradient = useFadeGradient
end
    ZO_PreHookHandler(self.scrollbar, "OnMouseDown", IgnoreMouseDownEditFocusLoss)
    ZO_PreHookHandler(self.upButton, "OnMouseDown", IgnoreMouseDownEditFocusLoss)
    ZO_PreHookHandler(self.downButton, "OnMouseDown", IgnoreMouseDownEditFocusLoss)
end
function ZO_ScrollList_EnableSelection(self, selectionTemplate, selectionCallback)
    if not self.selectionTemplate then
        self.selectionTemplate = selectionTemplate
    end
end
--Determines if one piece of selected data is the "same" as the other. Used mainly to
--keep an item selected even when the data for the list is updated if they share some
--property determined by the equality function. For example, if you have an item with
--id=1 and state=up and replace it with id=1 and state=down, the selection will be maintained
--if the equality function only compares ids.
local function AreDataEqualSelections(self, data1, data2)
    if data1 == data2 then
        return true
    end
    if data1 == nil or data2 == nil then
        return false
    end        
    local dataEntry1 = data1.dataEntry
    local dataEntry2 = data2.dataEntry
    if dataEntry1.typeId == dataEntry2.typeId then
        local dataTypeInfo = GetDataTypeInfo(self, dataEntry1.typeId)
        local equalityFunction = dataTypeInfo.equalityFunction
        if equalityFunction then
            return equalityFunction(data1, data2)
        end
    end
    return false
end
    if AreSelectionsEnabled(self) and AreDataEqualSelections(self, self.selectedData, data) then
        return true
    end
    return false
end
    if data then
        local numActive = #self.activeControls
        for i = 1, numActive do
            local currentControl = self.activeControls[i]
            local currentDataEntry = currentControl.dataEntry
            if AreDataEqualSelections(self, currentDataEntry.data, data) then
                return currentControl
            end
        end
    end
    return nil
end
    if data then
        for i, entryData in ipairs(self.data) do
            if entryData == data then
                return i
            end
        end
    end
    return nil
end
function ZO_ScrollList_SelectData(self, data, control, reselectingDuringRebuild, animateInstantly)
    if AreSelectionsEnabled(self) and self.selectedData ~= data then
        if reselectingDuringRebuild == nil then
            reselectingDuringRebuild = false
        end
        if animateInstantly == nil then
            animateInstantly = false
        end
        local dataIndex
        if data ~= nil then
            for i = 1, #self.data do
                if AreDataEqualSelections(self, self.data[i].data, data) then
                    dataIndex = i
                    break
                end
            end
            --this data we tried to select isn't in the scroll list at all, just abort
            if dataIndex == nil then
                return
            end
        end
        local previouslySelectedData = self.selectedData
        if self.selectedData then
            self.selectedData = nil
            self.selectedDataIndex = nil
            if self.selectedControl then
                UnselectControl(self, self.selectedControl, animateInstantly)
            end
        end
        
        if data ~= nil then
            self.selectedDataIndex = dataIndex
            self.lastSelectedDataIndex = dataIndex
            self.selectedData = data
            if not control then
                control = ZO_ScrollList_GetDataControl(self, data)
            end
            if control then
                SelectControl(self, control, animateInstantly)
            end
        end
        
        if self.selectionCallback then
            self.selectionCallback(previouslySelectedData, self.selectedData, reselectingDuringRebuild)
        end
    end
end
local function OnContentsUpdate(self)
    local _, windowHeight = self:GetDimensions()
    
    if windowHeight > 0 then
        self:SetHandler("OnUpdate", nil)
        ZO_ScrollList_SetHeight(self, windowHeight)
        ZO_ScrollList_Commit(self:GetParent())        
    end
end
local function FreeActiveScrollListControl(self, i)
    local currentControl = self.activeControls[i]
    local currentDataEntry = currentControl.dataEntry
    local dataType = GetDataTypeInfo(self, currentDataEntry.typeId)
    
    if self.highlightTemplate then
        if currentControl == self.highlightedControl then
            UnhighlightControl(self, currentControl)
            if self.highlightLocked then
                self.highlightLocked = false
            end
        else
            RemoveAnimationOnControl(currentControl, "HighlightAnimation", ANIMATE_INSTANTLY)
        end
    end
    if currentControl == self.pendingHighlightControl then
        self.pendingHighlightControl = nil
    end
    
    if AreSelectionsEnabled(self) then
        if currentControl == self.selectedControl then
            UnselectControl(self, currentControl, ANIMATE_INSTANTLY)
        else
            RemoveAnimationOnControl(currentControl, "SelectionAnimation", ANIMATE_INSTANTLY)
        end
    end
    
    local controlPool = dataType.pool
    local hideCallback = dataType.hideCallback
    if hideCallback then
        hideCallback(currentControl, currentControl.dataEntry.data)
    end
    
    controlPool:ReleaseObject(currentControl.key)
    currentControl.key = nil
    currentControl.dataEntry = nil
    currentDataEntry.control = nil
    currentControl.index = nil
    self.activeControls[i] = self.activeControls[#self.activeControls]
    self.activeControls[#self.activeControls] = nil
end
local function ResizeScrollBar(self, scrollableDistance)
    local shouldHideScrollbar
    local scrollBarHeight = self.scrollbar:GetHeight()
    local scrollListHeight = ZO_ScrollList_GetHeight(self)
    if scrollableDistance > 0 then
        if self.offset > scrollableDistance then
            self.offset = scrollableDistance
        end
        self.scrollbar:SetThumbTextureHeight(scrollBarHeight * scrollListHeight / (scrollableDistance + scrollListHeight))
        self.scrollbar:SetMinMax(0, scrollableDistance)
        self.scrollbar:SetEnabled(true)
        shouldHideScrollbar = false
    else
        self.offset = 0
        self.scrollbar:SetThumbTextureHeight(scrollBarHeight)
        self.scrollbar:SetMinMax(0, 0)
        self.scrollbar:SetEnabled(false)
        shouldHideScrollbar = self.hideScrollBarOnDisabled
    end
    shouldHideScrollbar = shouldHideScrollbar or not self.useScrollbar
    if self.scrollbar:IsControlHidden() ~= shouldHideScrollbar then
        if self.ScrollBarHiddenCallback then
            self.ScrollBarHiddenCallback(self, shouldHideScrollbar)
        else
            self.scrollbar:SetHidden(shouldHideScrollbar)
        end
    end
end
local function CheckRunHandler(self, handlerName)
    local mouseOverControl = WINDOW_MANAGER:GetMouseOverControl()
    if mouseOverControl and not mouseOverControl:IsHidden() and mouseOverControl:IsChildOf(self) then
        local handler = mouseOverControl:GetHandler(handlerName)
        if handler then
            handler(mouseOverControl)
        end
    end
end
local function CanSelectData(self, index)
    local dataEntry = self.data[index]
    local dataTypeInfo = GetDataTypeInfo(self, dataEntry.typeId)
    return dataTypeInfo.selectable
end
local function IsCategoryHeader(self, index)
    local dataEntry = self.data[index]
    local dataTypeInfo = GetDataTypeInfo(self, dataEntry.typeId)
    return dataTypeInfo.categoryHeader
end
local function AutoSelect(self, animateInstantly)
    if #self.data > 0 then
        local recalledIndex = self.selectedDataIndex or self.lastSelectedDataIndex
        if recalledIndex then
            for i = zo_min(recalledIndex, #self.data), 1, -1 do
                if CanSelectData(self, i) then
                    ZO_ScrollList_SelectData(self, self.data[i].data, NO_DATA_CONTROL, NOT_RESELECTING_DURING_REBUILD, animateInstantly)
                    return
                end
            end
        end
        if ZO_ScrollList_TrySelectFirstData(self) then
            return
        end
    end
        
    ZO_ScrollList_SelectData(self, NO_SELECTED_DATA, NO_DATA_CONTROL, NOT_RESELECTING_DURING_REBUILD, animateInstantly)
end
local function GetDataControlPositions(self, dataEntry, dataIndex)
    local controlTop
    local controlBottom
    if self.mode == SCROLL_LIST_UNIFORM then
        controlTop = (dataIndex - 1) * self.uniformControlHeight
        controlBottom = controlTop + self.uniformControlHeight
    else
        controlTop = dataEntry.top
        controlBottom = dataEntry.bottom
    end
    return controlTop, controlBottom
end
local function GetDataControlDimensions(self, dataEntry)
    local controlWidth
    local controlHeight
    local dataTypeInfo = ZO_ScrollList_GetDataTypeTable(self, dataEntry.typeId)
    if self.mode == SCROLL_LIST_OPERATIONS then
        controlWidth = dataTypeInfo.controlWidth
        controlHeight = dataTypeInfo.controlHeight
    else
        controlHeight = dataTypeInfo.height
    end
    return controlWidth, controlHeight
end
-- If an animation is in progress and we call to change the scrollBar's value,
-- we must account for the distance left to travel in our calculations
-- of the new scrollBar value so we do not over/under shoot the target
    local animationOffset = 0
    if self.animationTarget then
       animationOffset = self.animationTarget - self.scrollbar:GetValue()
    end
    return animationOffset
end
function ZO_ScrollList_ScrollDataIntoView(self, dataIndex, onScrollCompleteCallback, animateInstantly)
    local data = self.data[dataIndex]
    local scrollTop = self.scrollbar:GetValue()
    local scrollBottom = self.scrollbar:GetValue() + ZO_ScrollList_GetHeight(self)
    local controlTop, controlBottom = GetDataControlPositions(self, data, dataIndex)
    local scrollAnimationOffset = CalculateScrollAnimationOffset(self)
    local calculatedControlTop = controlTop - self.yDistanceFromEdgeWhereSelectionCausesScroll - scrollAnimationOffset
    local calculatedControlBottom = controlBottom + self.yDistanceFromEdgeWhereSelectionCausesScroll - scrollAnimationOffset
    if calculatedControlTop < scrollTop then
        ZO_ScrollList_ScrollRelative(self, calculatedControlTop - scrollTop, onScrollCompleteCallback, animateInstantly)
    elseif calculatedControlBottom > scrollBottom then
        ZO_ScrollList_ScrollRelative(self, calculatedControlBottom - scrollBottom, onScrollCompleteCallback, animateInstantly)
    elseif onScrollCompleteCallback then
        onScrollCompleteCallback(true)
    end
end
    return self.scrollbar:GetValue()
end
function ZO_ScrollList_ScrollDataToCenter(self, dataIndex, onScrollCompleteCallback, animateInstantly)
    local data = self.data[dataIndex]
    local scrollCenter = self.scrollbar:GetValue() + ZO_ScrollList_GetHeight(self) / 2
    local controlTop = GetDataControlPositions(self, data, dataIndex)
    local _, controlHeight = GetDataControlDimensions(self, data)
    local controlCenter  = controlTop + controlHeight / 2
    local scrollAnimationOffset = CalculateScrollAnimationOffset(self)
    ZO_ScrollList_ScrollRelative(self, controlCenter - scrollCenter - scrollAnimationOffset, onScrollCompleteCallback, animateInstantly)
end
function ZO_ScrollList_SelectNextData(self, onScrollCompleteCallback, shouldAnimateInstantly)
    if not self.selectedDataIndex then
        return
    end
    for i = 1, #self.data do
        -- Allow Wrapping
        local newIndex = ((self.selectedDataIndex + i - 1) % #self.data) + 1
        local hasWrapped = newIndex < self.selectedDataIndex
        if CanSelectData(self, newIndex) then
            ZO_ScrollList_SelectDataAndScrollIntoView(self, self.data[newIndex].data, onScrollCompleteCallback, hasWrapped or shouldAnimateInstantly)
            return
        end
    end
end
function ZO_ScrollList_SelectPreviousData(self, onScrollCompleteCallback, shouldAnimateInstantly)
    if not self.selectedDataIndex then
        return
    end
    for i = 1, #self.data do
        -- Allow Wrapping
        local newIndex = ((self.selectedDataIndex + #self.data - i - 1) % #self.data) + 1
        local hasWrapped = newIndex > self.selectedDataIndex
        if CanSelectData(self, newIndex) then
            ZO_ScrollList_SelectDataAndScrollIntoView(self, self.data[newIndex].data, onScrollCompleteCallback, hasWrapped or shouldAnimateInstantly)
            return
        end
    end
end
-- x and y direction must use the values for directions described at the top of this file
function ZO_ScrollList_SelectNextDataInDirection(self, xDirection, yDirection)
    if not self.selectedDataIndex then
        return
    end
    local numDataEntries = #self.data
    -- Move Y Direction
    if yDirection ~= ZO_SCROLL_MOVEMENT_DIRECTION_NONE then
        local currentData = self.data[self.selectedDataIndex]
        local holdXPos = self.lastHoldXPos or 0
        local nextIndex = self.selectedDataIndex + yDirection
        local currentTopValue = currentData.top * yDirection
        local bestDistance = math.huge
        local bestIndex = nil
        while nextIndex <= numDataEntries and nextIndex > 0 do
            if CanSelectData(self, nextIndex) then
                local nextData = self.data[nextIndex]
                local nextDataTopValue = nextData.top * yDirection
                -- check and see if the next data is within the y direction we are searching,
                -- and has an x direction greater than or equal to our current data's x
                if nextDataTopValue > currentTopValue then
                    local deltaDistance = zo_abs(nextData.left - holdXPos)
                    if deltaDistance < bestDistance then
                        bestIndex = nextIndex
                        bestDistance = deltaDistance
                    end
                end
                -- we only want to select an entry that is only one y delta away.
                -- We must look ahead and see if the next data after current next data has an even greater y
                local lookAheadIndex = nextIndex + yDirection
                local nextSelectableData
                local noFurtherDataToExplore = false
                while not nextSelectableData do
                    -- we can't look ahead anymore, bail out
                    if lookAheadIndex > numDataEntries or lookAheadIndex < 1 then
                        break
                    end
                    if CanSelectData(self, lookAheadIndex) then
                        nextSelectableData = self.data[lookAheadIndex]
                        if currentTopValue < nextDataTopValue and nextDataTopValue < nextSelectableData.top * yDirection then
                            noFurtherDataToExplore = true
                            break
                        end
                    end
                    lookAheadIndex = lookAheadIndex + yDirection
                end
                -- we found that there is no other data to look at
                -- and we no longer need to look any further
                if noFurtherDataToExplore then
                    break
                end
            end
            nextIndex = nextIndex + yDirection
        end
        if bestIndex then
            ZO_ScrollList_SelectDataAndScrollIntoView(self, self.data[bestIndex].data)
        end
    end
    -- Move X Direction
    -- Since data is given in X direction order, simply pick the next selectable data
    -- in the correct layout direction in contigious order
    -- we also save this X position for use in calculating Y direction
    -- since this emulates how people already expect this form of selection to work (see text editors)
    local nextIndex = self.selectedDataIndex + xDirection
    if xDirection == ZO_SCROLL_MOVEMENT_DIRECTION_POSITIVE then
        while nextIndex <= numDataEntries do
            if CanSelectData(self, nextIndex) then
                ZO_ScrollList_SelectDataAndScrollIntoView(self, self.data[nextIndex].data)
                break
            end
            nextIndex = nextIndex + xDirection
        end
        self.lastHoldXPos = self.data[self.selectedDataIndex].left
    elseif xDirection == ZO_SCROLL_MOVEMENT_DIRECTION_NEGATIVE then
        while nextIndex > 0 do
            if CanSelectData(self, nextIndex) then
                ZO_ScrollList_SelectDataAndScrollIntoView(self, self.data[nextIndex].data)
                break
            end
            nextIndex = nextIndex + xDirection
        end
        self.lastHoldXPos = self.data[self.selectedDataIndex].left
    end
end
    self.lastHoldXPos = nil
end
    if self.selectedDataIndex then
        self.lastHoldXPos = self.data[self.selectedDataIndex].left
    end
end
function ZO_ScrollList_TrySelectFirstData(self, onScrollCompleteCallback, shouldAnimateInstantly)
    for i = 1, #self.data do
        if CanSelectData(self, i) then
            ZO_ScrollList_SelectDataAndScrollIntoView(self, self.data[i].data, onScrollCompleteCallback, shouldAnimateInstantly)
            return true
        end
    end
    return false
end
function ZO_ScrollList_TrySelectLastData(self, onScrollCompleteCallback, shouldAnimateInstantly)
    for i = #self.data, 1, -1 do
        if CanSelectData(self, i) then
            ZO_ScrollList_SelectDataAndScrollIntoView(self, self.data[i].data, onScrollCompleteCallback, shouldAnimateInstantly)
            return true
        end
    end
    return false
end
function ZO_ScrollList_AutoSelectData(self, animateInstantly)
    AutoSelect(self, animateInstantly)
end
--When the list in inactive, you can't get selected data. Auto select is a mechanic of lists that will reselect the last thing that was selected
-- Assuming it wasn't reset, or manually set to something else. If another party needs to know what data would be selected if the list were active, this is how
    if #self.data > 0 then
        local recalledIndex = self.selectedDataIndex or self.lastSelectedDataIndex
        if recalledIndex and CanSelectData(self, recalledIndex) then
            return recalledIndex
        end
    end
    return nil
end
    local recalledIndex = ZO_ScrollList_GetAutoSelectIndex(self)
    if recalledIndex then
        return self.data[recalledIndex].data
    end
    return nil
end
    self.lastSelectedDataIndex = nil
end
-- direction: ZO_SCROLL_SELECT_CATEGORY_PREVIOUS or ZO_SCROLL_SELECT_CATEGORY_NEXT
    local currentlySelectedData = ZO_ScrollList_GetSelectedData(self)
    if not currentlySelectedData then
        return
    end
    local listData = ZO_ScrollList_GetDataList(self)
    local nextDataIndex = ZO_ScrollList_GetDataIndex(self, currentlySelectedData.dataEntry) + direction
    if nextDataIndex < 1 or nextDataIndex > #listData then
        -- we are already at the end of our list
        return
    end
    -- if we are going backwards and hit a non-selectable entry, we need to keep going until we find a selectable entry so we don't just select the same value
    if direction == ZO_SCROLL_SELECT_CATEGORY_PREVIOUS then
        while not CanSelectData(self, nextDataIndex) do
            nextDataIndex = nextDataIndex + direction
            if nextDataIndex == 0 or nextDataIndex == #listData then
                -- could not find an acceptable target, we are at the selectable end of our list
                return
            end
        end
    end
    while nextDataIndex > 0 and nextDataIndex <= #listData do
        if IsCategoryHeader(self, nextDataIndex) then
            -- we found header data, select the first selectable entry under it
            local lookAheadIndex = nextDataIndex + 1
            ZO_ScrollList_SelectData(self, listData[lookAheadIndex].data)
            ZO_ScrollList_ScrollDataToCenter(self, lookAheadIndex)
            return
        end
        nextDataIndex = nextDataIndex + direction
    end
    -- could not find another header data, so just pick the last selectable value we found
    ZO_ScrollList_SelectData(self, listData[nextDataIndex - direction].data)
    ZO_ScrollList_ScrollDataToCenter(self, nextDataIndex - direction)
end
--Updates the scroll control with new data. Call this when you modify the data list by adding or removing entries.
    local windowHeight = ZO_ScrollList_GetHeight(self)
    local selectionsEnabled = AreSelectionsEnabled(self)
        
    --the window isn't big enough to show anything (its anchors probably haven't been processed yet), so delay the commit until that happens
    if windowHeight <= 0 then
        self.contents:SetHandler("OnUpdate", OnContentsUpdate)
        return
    end
    self.contents:SetHandler("OnUpdate", nil)
    CheckRunHandler(self, "OnMouseExit")
    
    self.visibleData = {}
    
    local scrollableDistance = 0
    local foundSelected = false
    local numData = #self.data
    if self.mode == SCROLL_LIST_UNIFORM then
        for i, currentData in ipairs(self.data) do
            table.insert(self.visibleData, i)
            
            if selectionsEnabled and AreDataEqualSelections(self, currentData.data, self.selectedData) then
               foundSelected = true
               ZO_ScrollList_SelectData(self, currentData.data, NO_DATA_CONTROL, RESELECTING_DURING_REBUILD, ANIMATE_INSTANTLY)
            end
        end
        scrollableDistance = numData * self.uniformControlHeight - windowHeight
    elseif self.mode == SCROLL_LIST_NON_UNIFORM then
        local currentY = 0
        for i, currentData in ipairs(self.data) do
            currentData.top = currentY
            currentY = currentY + GetDataTypeInfo(self, currentData.typeId).height
            currentData.bottom = currentY
            table.insert(self.visibleData, i)
            
            if selectionsEnabled and AreDataEqualSelections(self, currentData.data, self.selectedData) then
                foundSelected = true
                ZO_ScrollList_SelectData(self, currentData.data, NO_DATA_CONTROL, RESELECTING_DURING_REBUILD, ANIMATE_INSTANTLY)
            end
        end
        scrollableDistance = currentY - windowHeight
    elseif self.mode == SCROLL_LIST_OPERATIONS then
        local layoutInfo = {}
        layoutInfo.lineBreakModifier = 0
        layoutInfo.direction = self.buildDirection
        if self.buildDirection == ZO_SCROLL_BUILD_DIRECTION_LEFT_TO_RIGHT then
            layoutInfo.startPos = 0
            layoutInfo.endPos = self.contents:GetWidth()
        else
            layoutInfo.startPos = self.contents:GetWidth()
            layoutInfo.endPos = 0
        end
        local currentX = layoutInfo.startPos
        local currentY = 0
        for i, currentData in ipairs(self.data) do
            local currentOperation = GetDataTypeInfo(self, currentData.typeId)
            currentX, currentY = currentOperation:GetPositionsAndAdvance(layoutInfo, currentX, currentY, currentData)
            table.insert(self.visibleData, i)
            if selectionsEnabled and AreDataEqualSelections(self, currentData.data, self.selectedData) then
                foundSelected = true
                ZO_ScrollList_SelectData(self, currentData.data, NO_DATA_CONTROL, RESELECTING_DURING_REBUILD, ANIMATE_INSTANTLY)
            end
        end
        if numData > 0 then
            scrollableDistance = self.data[numData].bottom - windowHeight
        else
            scrollableDistance = 0
        end
    end
    
    ResizeScrollBar(self, scrollableDistance)
    
    --nuke the active list since things may have left it
    local i = #self.activeControls
    while i >= 1 do
        FreeActiveScrollListControl(self, i)
        i = i - 1
    end
    if selectionsEnabled then
        if not foundSelected then
            if self.autoSelect then
                AutoSelect(self, ANIMATE_INSTANTLY)
            else
                ZO_ScrollList_SelectData(self, NO_SELECTED_DATA, NO_DATA_CONTROL, RESELECTING_DURING_REBUILD, ANIMATE_INSTANTLY)
            end
        end
    end
    CheckRunHandler(self, "OnMouseEnter")
end
--updates the layout of visible controls
--data: optionally allows you to only update the control backed by the specified data table
--overrideSetupCallback: optionally allows you to call this function instead of the normal setup function if you only need to do a very specific update
    for i = 1, #self.activeControls do
        local control = self.activeControls[i]
        local dataEntry = control.dataEntry
        if not data or data == dataEntry.data then
            local dataTypeInfo = GetDataTypeInfo(self, dataEntry.typeId)
            if overrideSetupCallback then
                overrideSetupCallback(control, dataEntry.data, self)
            elseif dataTypeInfo.setupCallback then
                dataTypeInfo.setupCallback(control, dataEntry.data, self)
            end
        end
    end
end
    if self.mode == SCROLL_LIST_UNIFORM then
        --nuke the active list since things may have left it
        local i = #self.activeControls
        while i >= 1 do
            FreeActiveScrollListControl(self, i)
            i = i - 1
        end
        
        --update scroll distance
        local windowHeight = ZO_ScrollList_GetHeight(self)
        local scrollSize = self.uniformControlHeight * #self.visibleData       
        ResizeScrollBar(self, math.max(0, scrollSize-windowHeight))        
    end
end
function ZO_ScrollList_HideData(self, index)
    if self.mode == SCROLL_LIST_UNIFORM then
        for i = 1, #self.visibleData do
            if self.visibleData[i] == index then
                table.remove(self.visibleData, i)            
                break
            end
        end
        
    end
end
function ZO_ScrollList_HideCategory(self, categoryId)
    local data = self.data
    local visibleData = self.visibleData
    local categories = self.categories
    if self.mode == SCROLL_LIST_UNIFORM then
        local category = self.categories[categoryId]
        if category then
            category.hidden = true    
            local numRemoved = 0
            
            local i = 1
            while i <= #self.visibleData do
                local curCategoryId = data[visibleData[i]].categoryId
                local curCategory = categories[curCategoryId]
                local found = false
                
                --climb the hierarchy to see if this piece of data is under this category
                while curCategory do
                    curCategoryId = curCategory.id
                    if curCategoryId == categoryId then
                        table.remove(visibleData, i)
                        found = true
                        numRemoved = numRemoved + 1
                        break
                    end
                    curCategory = curCategory.parent
                end 
                
                if not found then
                    i = i + 1
                end          
            end
        
            if numRemoved > 0 then
                UpdateAfterDataVisibilityChange(self)
            end
        end
    end
end
function ZO_ScrollList_ShowData(self, index)
    if self.mode == SCROLL_LIST_UNIFORM then
        local inserted = false
        for i = 1, #self.visibleData do
            if self.visibleData[i] == index then
                return
            elseif self.visibleData[i] > index then
                table.insert(self.visibleData, index, i)   
                inserted = true         
                break
            end
        end
        
        if not inserted then
            table.insert(self.visibleData, index)
        end
        
    end
end
local function CompareIndices(search, compare)
    return search - compare
end
    if self.mode == SCROLL_LIST_UNIFORM then
        for categoryId in pairs(self.categories) do
            ZO_ScrollList_HideCategory(self, categoryId)
        end
    end
end
function ZO_ScrollList_ShowCategory(self, categoryId)
    if self.mode == SCROLL_LIST_UNIFORM then
        local category = self.categories[categoryId]
        if category then
            category.hidden = false
            local numShown = 0
            local i = 1
            while i <= #self.data do
                local curCategoryId = self.data[i].categoryId
                local curCategory = self.categories[curCategoryId]
                local shouldInsert = true
                while curCategory do
                    if curCategory.hidden then
                        shouldInsert = false
                        break
                    end
                    curCategory = curCategory.parent
                end
                if shouldInsert then
                    local found, insertionPoint = zo_binarysearch(i, self.visibleData, CompareIndices)        
                    if not found then
                        numShown = numShown + 1
                        table.insert(self.visibleData, insertionPoint, i)
                    end
                end
                i = i + 1
            end
        
            if numShown > 0 then
                UpdateAfterDataVisibilityChange(self)
            end
        end
    end
end
local function CompareEntries(topEdge, compareData)
    return topEdge - compareData.bottom
end
--Used to locate the point in the data list where we should start looking for in view controls
local function FindStartPoint(self, topEdge)
    if self.mode == SCROLL_LIST_UNIFORM then
        return zo_floor(topEdge / self.uniformControlHeight) + 1
    else
        local _, insertPoint = zo_binarysearch(topEdge, self.data, CompareEntries)
        return insertPoint
    end
end
--holds controls that have already been evaluated and do not need to be looked at again this update scroll call
local consideredMap = {}