Back to Home

ESO Lua File v100018

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
--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 NO_SELECTED_DATA = nil
local NO_DATA_CONTROL = nil
local RESELECTING_DURING_REBUILD = true
local NOT_RESELECTING_DURING_REBUILD = false
local ANIMATE_INSTANTLY = true
    self:SetMinMax(MIN_SCROLL_VALUE, MAX_SCROLL_VALUE)
    self:SetValue(MIN_SCROLL_VALUE)
    self:SetAlpha(OFF_ALPHA)
    self.alphaAnimation, self.timeline = CreateSimpleAnimation(ANIMATION_ALPHA, self)
    self.alphaAnimation:SetDuration(STATE_CHANGE_DURATION)
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
    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
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 function SetSliderValueAnimated(self, targetValue)
    if self.scrollbar then
        self.timeline:Stop()
        local scrollMin, scrollMax = self.scrollbar:GetMinMax()
        targetValue = zo_clamp(targetValue, scrollMin, scrollMax)
        self.animationStart = self.scrollbar:GetValue()
        self.animationTarget = targetValue
        self.timeline:PlayFromStart()
    end
end
local function OnAnimationStop(animationObject, control)
    local scrollObject = animationObject.scrollObject
    scrollObject.animationStart = nil
    scrollObject.animationTarget = nil
end
local function OnAnimationUpdate(animationObject, progress)
    local scrollObject = animationObject.scrollObject
    local value = scrollObject.animationStart + (scrollObject.animationTarget - scrollObject.animationStart) * progress
    scrollObject.scrollbar:SetValue(value)
end
local function CreateScrollAnimation(scrollObject)
    local animation, timeline = CreateSimpleAnimation(ANIMATION_CUSTOM)
    animation.scrollObject = scrollObject
    animation:SetDuration(400)
    animation:SetHandler("OnStop", OnAnimationStop)
    return animation, timeline
end
--Shared Scroll Edge Fades
-----------------------------------------------------------------
local function UpdateScrollFade(useFadeGradient, scroll, slider, sliderValue)
    if(useFadeGradient) then
        local sliderMin, sliderMax = slider:GetMinMax()
        sliderValue = sliderValue or slider:GetValue()
        if(sliderValue > sliderMin) then
            scroll:SetFadeGradient(1, 0, 1, zo_min(sliderValue - sliderMin, 64))
        else
            scroll:SetFadeGradient(1, 0, 0, 0)
        end
        
        if(sliderValue < sliderMax) then
            scroll:SetFadeGradient(2, 0, -1, zo_min(sliderMax - sliderValue, 64))
        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
    self.scroll = GetControl(self, "Scroll")
    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)
    end
    
    self.hideScrollBarOnDisabled = true
    self.useFadeGradient = true
    self.animation, self.timeline = CreateScrollAnimation(self)
    
end
--Scrolling functions
    self.timeline:Stop()
    if self.scrollbar then
        self.scrollbar:SetValue(MIN_SCROLL_VALUE)
    end
end
    local scroll = self.scroll
    local _, verticalExtents = scroll:GetScrollExtents()
    if(verticalExtents > 0) then
        SetSliderValueAnimated(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)
    self.timeline:Stop()
    self.animationStart = scrollbar:GetValue()
    self.animationTarget = targetValue
    self.timeline:PlayInstantlyToEnd()
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 = (self.animationTarget * verticalExtents) / MAX_SCROLL_VALUE
            local newVerticalOffset = oldVerticalOffset + verticalDelta
            SetSliderValueAnimated(self, (newVerticalOffset / verticalExtents) * MAX_SCROLL_VALUE)
        else
            local _, currentVerticalOffset = scroll:GetScrollOffsets()
            local newVerticalOffset = currentVerticalOffset + verticalDelta
            SetSliderValueAnimated(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
function ZO_Scroll_GetScrollDistanceToControl(self, otherControl)
    -- self is a ScrollControl.
    --
    -- NOTE: This doesn't check the lineage of the otherControl, so please don't pass in controls which aren't descended
    -- from self.
    
    local scrollTop         = self:GetTop()
    local scrollBottom      = self:GetBottom()
    local _, scrollHeight   = self:GetDimensions()
    local controlTop        = otherControl:GetTop()
    local controlBottom     = otherControl:GetBottom()   
 
    if(controlTop < scrollTop) -- The control's top is above the top edge of the scroll, must scroll up to fully contain the control.
    then
        return controlTop - scrollTop 
    elseif(controlBottom > scrollBottom) -- The control's bottom is below the bottom edge of the scroll, must scroll down to fully contain the control.
    then
        return controlBottom - scrollBottom
    end
    
    return 0
end
function ZO_Scroll_ScrollToControl(self, otherControl)    
    local scrollDistance = ZO_Scroll_GetScrollDistanceToControl(self.scroll, otherControl)
    
    if(scrollDistance ~= 0) then    
         ZO_Scroll_ScrollRelative(self, scrollDistance)
    end
end
function ZO_Scroll_ScrollControlToTop(self, otherControl)
    local scrollTop         = self.scroll:GetTop()
    local controlTop        = otherControl:GetTop()
   
    ZO_Scroll_ScrollRelative(self, controlTop - scrollTop)
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 scrollbar = self.scrollbar
    local scrollTop = scroll:GetTop()
    local scrollBottom = scroll:GetBottom()
    local controlTop = otherControl:GetTop()
    local controlBottom = otherControl:GetBottom()
    local heightDelta = scroll:GetHeight() - otherControl:GetHeight()
    local halfHeightDelta = heightDelta * .5
    local value
    if controlTop < scrollTop then
        value = (controlTop - scrollTop) - halfHeightDelta
    elseif controlBottom > scrollBottom then
        value = (controlBottom - scrollBottom) + halfHeightDelta
    end
    
    if value then
        if scrollInstantly then
            ZO_Scroll_ResetToTop(self)
            local _, verticalExtents = scroll:GetScrollExtents()
            local targetValue = (value / verticalExtents) * MAX_SCROLL_VALUE
            local scrollMin, scrollMax = scrollbar:GetMinMax()
            self.timeline:Stop()
            self.animationStart = scrollbar:GetValue()
            self.animationTarget = targetValue
            self.timeline:PlayInstantlyToEnd()
        else
            ZO_Scroll_ScrollRelative(self,  value)
        end
    end
end
--Scroll update functions
    if self and self.scroll then
    end
end
    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 = (self.hideScrollBarOnDisabled and not scrollEnabled)
    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
    
        --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
        --extents updating
        local verticalExtentsChanged = self.verticalExtents ~= nil and not zo_floatsAreEqual(self.verticalExtents, verticalExtents)
        self.verticalExtents = verticalExtents
        if verticalExtentsChanged then
            if verticalExtents > 0 then
                self.scrollbar:SetValue(MAX_SCROLL_VALUE * (verticalOffset / verticalExtents))
            else
                ZO_Scroll_ResetToTop(self)
            end
        end
        UpdateScrollFade(self.useFadeGradient, scroll, scrollbar)
    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
        local verticalExtentsChanged = self.verticalExtents ~= nil and not zo_floatsAreEqual(self.verticalExtents, verticalExtents)
        self.verticalExtents = verticalExtents
        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_SetUseFadeGradient(self, useFadeGradient)
    self.useFadeGradient = useFadeGradient
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 NO_HEIGHT_SET = -1
end
end
    self.dataTypes = {}
    self.data = {}
    self.offset = 0
    self.activeControls = {}
    self.visibleData = {}
    self.categories = {}
    self.mode = SCROLL_LIST_UNIFORM
    self.controlHeight = 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.useFadeGradient = true
end
function ZO_ScrollList_SetHeight(self, height)
    self:SetHeight(height)
end
    return self:GetHeight()
end
local function AreSelectionsEnabled(self)
    return self.selectionTemplate or self.selectionCallback
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.controlHeight == NO_HEIGHT_SET then
            self.controlHeight = height
        elseif height ~= self.controlHeight then
            self.controlHeight = 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(), tostring(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,
            equalityFunction = equalityFunction,
            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
    return self.dataTypes and self.dataTypes[typeId] or nil
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
    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
    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.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)
    if controlTemplate then
        if not control[animationFieldName] then
            local highlight = CreateControlFromVirtual("$(parent)Scroll", control, controlTemplate, animationFieldName)
            control[animationFieldName] = ANIMATION_MANAGER:CreateTimelineFromVirtual("ShowOnMouseOverLabelAnimation", highlight)
        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)
    PlayAnimationOnControl(control, self.highlightTemplate, "HighlightAnimation")
    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 = self.dataTypes[typeId].selectSound
            ZO_ScrollList_SelectData(self, data, control)
            if(selectSound) then
                PlaySound(selectSound)
            end
        end          
    end
end
function ZO_ScrollList_EnableHighlight(self, highlightTemplate, highlightCallback)
    if not self.highlightTemplate then
        self.highlightTemplate = highlightTemplate
        
        self.highlightLocked = false
        self.pendingHighlightControl = nil
        
        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_SetUseFadeGradient(self, useFadeGradient)
    self.useFadeGradient = useFadeGradient
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 equalityFunction = self.dataTypes[dataEntry1.typeId].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(currentDataEntry.data == data) then
                return currentControl
            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 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 = self.dataTypes[currentDataEntry.typeId]
    
    if(self.highlightTemplate and currentControl == self.highlightedControl) then
        UnhighlightControl(self, currentControl)
        if(self.highlightLocked) then
            self.highlightLocked = false
        end
    end
    if(currentControl == self.pendingHighlightControl) then
        self.pendingHighlightControl = nil
    end
    
    if AreSelectionsEnabled(self) and currentControl == self.selectedControl then
        UnselectControl(self, currentControl, ANIMATE_INSTANTLY)
    end
    
    if(dataType.hideCallback) then
        dataType.hideCallback(currentControl, currentControl.dataEntry.data)
    end
    
    dataType.pool:ReleaseObject(currentControl.key)
    currentControl.key = nil
    currentControl.dataEntry = nil
    self.activeControls[i] = self.activeControls[#self.activeControls]
    self.activeControls[#self.activeControls] = nil
end
local HIDE_SCROLLBAR = true
local function ResizeScrollBar(self, scrollableDistance)
    local scrollBarHeight = self.scrollbar:GetHeight()
    local scrollListHeight = ZO_ScrollList_GetHeight(self)
    if(scrollableDistance > 0) then
        self.scrollbar:SetEnabled(true)
        if self.ScrollBarHiddenCallback then
            self.ScrollBarHiddenCallback(self, not HIDE_SCROLLBAR)
        else
            self.scrollbar:SetHidden(false)
        end
        self.scrollbar:SetThumbTextureHeight(scrollBarHeight * scrollListHeight /(scrollableDistance + scrollListHeight))
        if(self.offset > scrollableDistance) then
            self.offset = scrollableDistance
        end
        self.scrollbar:SetMinMax(0, scrollableDistance)
    else
        self.offset = 0
        self.scrollbar:SetThumbTextureHeight(scrollBarHeight)
        self.scrollbar:SetMinMax(0, 0)
        self.scrollbar:SetEnabled(false)
        if(self.hideScrollBarOnDisabled) then
            if self.ScrollBarHiddenCallback then
                self.ScrollBarHiddenCallback(self, HIDE_SCROLLBAR)
            else
                self.scrollbar:SetHidden(true)
            end
        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]
    return self.dataTypes[dataEntry.typeId].selectable
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
function ZO_ScrollList_ScrollDataIntoView(self, dataIndex)
    local scrollTop = self.scrollbar:GetValue()
    local scrollBottom = self.scrollbar:GetValue() + ZO_ScrollList_GetHeight(self)
    local controlTop = (dataIndex-1) * self.controlHeight
    local controlBottom = dataIndex * self.controlHeight
    if(controlTop < scrollTop) then
        ZO_ScrollList_ScrollRelative(self, controlTop - scrollTop)
    elseif(controlBottom > scrollBottom) then
        ZO_ScrollList_ScrollRelative(self, controlBottom - scrollBottom)
    end
end
function ZO_ScrollList_ScrollDataToCenter(self, dataIndex)
    local scrollCenter = self.scrollbar:GetValue() + ZO_ScrollList_GetHeight(self) / 2
    local controlTop = (dataIndex-1) * self.controlHeight
    local controlCenter  = controlTop + self.controlHeight / 2
    ZO_ScrollList_ScrollRelative(self, controlCenter - scrollCenter)
end
    if not self.selectedDataIndex then
        return
    end
    for i = 1, #self.data do
        -- Allow Wraping
        local newIndex = ((self.selectedDataIndex + i - 1) % #self.data) + 1
        if CanSelectData(self, newIndex) then
            ZO_ScrollList_SelectDataAndScrollIntoView(self, self.data[newIndex].data)
            break
        end
    end
end
     if not self.selectedDataIndex then
        return
    end
     for i = 1, #self.data do
        -- Allow Wraping
        local newIndex = ((self.selectedDataIndex + #self.data - i - 1) % #self.data) + 1
        if CanSelectData(self, newIndex) then
            ZO_ScrollList_SelectDataAndScrollIntoView(self, self.data[newIndex].data)
            break
        end
    end
end
    for i = 1, #self.data do
        if(CanSelectData(self, i)) then
            return true
        end
    end
    return false
end
    for i = #self.data, 1, -1 do
        if(CanSelectData(self, i)) then
            return true
        end
    end
    return false
end
function ZO_ScrollList_AutoSelectData(self, animateInstantly)
    AutoSelect(self, animateInstantly)
end
    self.lastSelectedDataIndex = nil
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
    CheckRunHandler(self, "OnMouseExit")
    
    self.visibleData = {}
    
    local scrollableDistance = 0
    local foundSelected = false
    if(self.mode == SCROLL_LIST_NON_UNIFORM) then
        local currentY = 0
        for i = 1,#self.data do
            local currentData = self.data[i]
            currentData.top = currentY
            currentY = currentY + self.dataTypes[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
    else
        for i = 1,#self.data do
            table.insert(self.visibleData, i)
            
            if selectionsEnabled and AreDataEqualSelections(self, self.data[i].data, self.selectedData) then
               foundSelected = true
               ZO_ScrollList_SelectData(self, self.data[i].data, NO_DATA_CONTROL, RESELECTING_DURING_REBUILD, ANIMATE_INSTANTLY)
            end
        end
        scrollableDistance = (#self.data) * self.controlHeight - windowHeight
    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 dataType = self.dataTypes[dataEntry.typeId]
            if(overrideSetupCallback) then
                overrideSetupCallback(control, dataEntry.data, self)
            elseif(dataType.setupCallback) then
                dataType.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.controlHeight * #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.controlHeight)+1
    else
        local found, 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 = {}
    local windowHeight = ZO_ScrollList_GetHeight(self)
    local controlHeight = self.controlHeight
    local activeControls = self.activeControls
    local offset = self.offset
    UpdateScrollFade(self.useFadeGradient, self.contents, self.scrollbar, offset)
    
    --remove active controls that are now hidden
    local i = 1
    local numActive = #activeControls
    while(i <= numActive) do
        local currentDataEntry = activeControls[i].dataEntry
        
        if(currentDataEntry.bottom < offset or currentDataEntry.top > offset + windowHeight) then
            FreeActiveScrollListControl(self, i)
            numActive = numActive - 1
        else
            i = i + 1
        end
        
        consideredMap[currentDataEntry] = true
    end
        
    --add revealed controls
    local firstInViewIndex = FindStartPoint(self, offset)
   
    local data = self.data
    local dataTypes = self.dataTypes
    local visibleData = self.visibleData
    local mode = self.mode
    
    local i = firstInViewIndex
    local visibleDataIndex = visibleData[i]
    local dataEntry = data[visibleDataIndex]
    local bottomEdge = offset + windowHeight
    
    local controlTop
    
    if(dataEntry) then
        if(mode == SCROLL_LIST_UNIFORM) then
            controlTop = (i-1) * controlHeight 
        else
            controlTop = dataEntry.top
        end
    end
    while(dataEntry and controlTop <= bottomEdge) do
        if(not consideredMap[dataEntry]) then
            local dataType = dataTypes[dataEntry.typeId]
            local controlPool = dataType.pool
            local control, key = controlPool:AcquireObject()
            
            control:SetHidden(false)
            control.dataEntry = dataEntry
            control.key = key
            control.index = visibleDataIndex
            if(dataType.setupCallback) then
                dataType.setupCallback(control, dataEntry.data, self)
            end
            table.insert(activeControls, control)
            consideredMap[dataEntry] = true
            
            if AreDataEqualSelections(self, dataEntry.data, self.selectedData) then
                SelectControl(self, control, ANIMATE_INSTANTLY)
            end
            
            --even uniform active controls need to know their position to determine if they are still active
            if(self.mode == SCROLL_LIST_UNIFORM) then
                dataEntry.top = controlTop
                dataEntry.bottom = controlTop + controlHeight
            end
        end
        i = i + 1
        visibleDataIndex = visibleData[i]
        dataEntry = data[visibleDataIndex]
        if(dataEntry) then
            if(mode == SCROLL_LIST_UNIFORM) then
                controlTop = (i-1) * controlHeight
            else
                controlTop = dataEntry.top
            end
        end
    end
    
    --update positions
    local contents = self.contents
    local numActive = #activeControls
    
    for i = 1, numActive do
        local currentControl = activeControls[i]
        local currentData = currentControl.dataEntry
        local controlOffset = currentData.top - offset
        currentControl:ClearAnchors()
        currentControl:SetAnchor(TOPLEFT, contents, TOPLEFT, 0, controlOffset)
        currentControl:SetAnchor(TOPRIGHT, contents, TOPRIGHT, 0, controlOffset)
    end  
    
    --reset considered
    for k,v in pairs(consideredMap) do
        consideredMap[k] = nil
    end
end
    self.timeline:Stop()
    self.scrollbar:SetValue(0)
end
    if(not self.lock) then
        if(self.animationTarget) then
            SetSliderValueAnimated(self, self.animationTarget + delta)
        else
            SetSliderValueAnimated(self, self.scrollbar:GetValue() + delta)
        end
    end
end
    if(not self.lock) then
        SetSliderValueAnimated(self, value)
    end
end
--This function actually moves the scroll window. The only thing that should ever call it is the slider's value changed handler.
--All other scrolling behavior should call scroll absolute or scroll relative which moves the slider and activates the value changed handler.
    self.offset = value
end
-- These functions are used for scrolling through the scroll list as a block of text instead of scrolling though each entry.
    return self.selectedDataIndex and self.selectedDataIndex ~= 1
end
    return self.selectedDataIndex and self.selectedDataIndex ~= #self.data
end
    local minIndex = #self.data
    local minIndexData = nil
    
    for i = 1, #self.activeControls do
        local currentControl = self.activeControls[i]
        local currentData = currentControl.dataEntry.data
        local currentIndex = currentControl.index
        if currentIndex < minIndex then
            minIndex = currentIndex
            minIndexData = currentData
        end
    end
    return self.selectedDataIndex == minIndex, minIndexData
end
    local maxIndex = 1
    local maxIndexData = nil
    
    for i = 1, #self.activeControls do
        local currentControl = self.activeControls[i]
        local currentData = currentControl.dataEntry.data
        local currentIndex = currentControl.index
        if currentIndex > maxIndex then
            maxIndex = currentIndex
            maxIndexData = currentData
        end
    end
    return self.selectedDataIndex == maxIndex, maxIndexData
end
    return self.selectedDataIndex == 1
end
    return self.selectedDataIndex == #self.data
end
    ZO_ScrollList_ScrollDataIntoView(self, self.selectedDataIndex)
end
    local _, scrollableDistance  = self.scrollbar:GetMinMax()
    return scrollableDistance > 0
end