Back to Home

ESO Lua File v101044

libraries/zo_sortfilterlist/gamepad/zo_interactivesortfilterlist_gamepad.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
--Layout consts--
local HEADER_OVERLAP_UNITS = 3
ZO_GAMEPAD_INTERACTIVE_FILTER_ARROW_PADDING = 15
ZO_GAMEPAD_INTERACTIVE_FILTER_HIGHLIGHT_PADDING = 10
ZO_GAMEPAD_INTERACTIVE_FILTER_RIGHT_ALIGN_HIGHLIGHT_PADDING = ZO_GAMEPAD_INTERACTIVE_FILTER_HIGHLIGHT_PADDING + ZO_GAMEPAD_INTERACTIVE_FILTER_ARROW_PADDING
ZO_GAMEPAD_INTERACTIVE_FILTER_LIST_HEADER_PADDING_X = ZO_GAMEPAD_INTERACTIVE_FILTER_HIGHLIGHT_PADDING - HEADER_OVERLAP_UNITS
ZO_GAMEPAD_INTERACTIVE_FILTER_LIST_HEADER_DOUBLE_PADDING_X = ZO_GAMEPAD_INTERACTIVE_FILTER_LIST_HEADER_PADDING_X * 2
ZO_GAMEPAD_INTERACTIVE_FILTER_LIST_ROW_HEIGHT = 80
ZO_GAMEPAD_INTERACTIVE_FILTER_LIST_TWO_LINE_ROW_HEIGHT = 96 --Fits two lines of text
ZO_GAMEPAD_INTERACTIVE_FILTER_LIST_SEARCH_TYPE_NAMES = 1
ZO_GAMEPAD_INTERACTIVE_FILTER_LIST_PRIMARY_DATA_TYPE = 1
-----------------
--Focus Filters--
-----------------
local GamepadInteractiveSortFilterFocus_Filters = ZO_GamepadMultiFocusArea_Base:Subclass()
-- Override
function GamepadInteractiveSortFilterFocus_Filters:CanBeSelected()
    return self.manager.areFiltersRemoved ~= true
end
-----------------
--Focus Headers--
-----------------
local GamepadInteractiveSortFilterFocus_Headers = ZO_GamepadMultiFocusArea_Base:Subclass()
function GamepadInteractiveSortFilterFocus_Headers:HandleMoveNext()
    local consumed = true
    if self.manager:HasEntries() then
        consumed = ZO_GamepadMultiFocusArea_Base.HandleMoveNext(self)
    end
    return consumed
end
--------------
--Focus List--
--------------
local GamepadInteractiveSortFilterFocus_Panel = ZO_GamepadMultiFocusArea_Base:Subclass()
function GamepadInteractiveSortFilterFocus_Panel:HandleMovement(horizontalResult, verticalResult)
    if verticalResult == MOVEMENT_CONTROLLER_MOVE_NEXT then
        self.manager:MoveNext()
        return true
    elseif verticalResult == MOVEMENT_CONTROLLER_MOVE_PREVIOUS then
        self.manager:MovePrevious()
        return true
    end
    return false
end
function GamepadInteractiveSortFilterFocus_Panel:HandleMovePrevious()
    local consumed = false
    if ZO_ScrollList_AtTopOfList(self.manager.list) then
        consumed = ZO_GamepadMultiFocusArea_Base.HandleMovePrevious(self)
    end
    return consumed
end
--------------------
--Sort/Filter List--
--------------------
--Initialization--
ZO_GamepadInteractiveSortFilterList = ZO_Object.MultiSubclass(ZO_SortFilterList_Gamepad, ZO_GamepadMultiFocusArea_Manager)
function ZO_GamepadInteractiveSortFilterList:New(...)
    return ZO_SortFilterList_Gamepad.New(self, ...)
end
function ZO_GamepadInteractiveSortFilterList:Initialize(control)
    self.container = control:GetNamedChild("Container")
    ZO_SortFilterList_Gamepad.Initialize(self, control)
    ZO_GamepadMultiFocusArea_Manager.Initialize(self)
    self.searchProcessor = ZO_StringSearch:New()
    self.searchProcessor:AddProcessor(ZO_GAMEPAD_INTERACTIVE_FILTER_LIST_SEARCH_TYPE_NAMES, function(stringSearch, data, searchTerm, cache) return self:ProcessNames(stringSearch, data, searchTerm, cache) end)
    self:SetupFoci()
    self.listFragment = ZO_FadeSceneFragment:New(control)
    self.listFragment:RegisterCallback("StateChange", function(oldState, newState)
        if newState == SCENE_FRAGMENT_SHOWING then
            self:OnShowing()
        elseif newState == SCENE_FRAGMENT_SHOWN then
            self:OnShown()
        elseif newState == SCENE_FRAGMENT_HIDING then
            self:OnHiding()
        elseif newState == SCENE_FRAGMENT_HIDDEN then
            self:OnHidden()
        end
    end)
    if self.sortHeaderGroup then
        local function OnSortHeaderClicked(key, order)
            SCREEN_NARRATION_MANAGER:QueueSelectedSortHeader(self, self.sortHeaderGroup, key)
        end
        local function OnSortHeaderSelected(key)
            SCREEN_NARRATION_MANAGER:QueueSelectedSortHeader(self, self.sortHeaderGroup, key)
        end
        self.sortHeaderGroup:RegisterCallback(ZO_SortHeaderGroup.HEADER_CLICKED, OnSortHeaderClicked)
        self.sortHeaderGroup:RegisterCallback("HeaderSelected", OnSortHeaderSelected)
    end
    CALLBACK_MANAGER:RegisterCallback("AllDialogsHidden", function() self:OnAllDialogsHidden() end)
end
function ZO_GamepadInteractiveSortFilterList:InitializeSortFilterList(control)
    ZO_SortFilterList_Gamepad.InitializeSortFilterList(self, self.container)
    self.sortFunction = function(listEntry1, listEntry2) return self:CompareSortEntries(listEntry1, listEntry2) end
end
function ZO_GamepadInteractiveSortFilterList:SetupFilterFocusArea()
    -- TODO: If we want to turn on filters and searching after initialization foci will have to be re-setup
    if not (self.contentHeader:IsControlHidden() or (self.filterControl:IsControlHidden() and self.searchControl:IsControlHidden())) then
        local function FiltersActivateCallback()
            self.filterSwitcher:Activate()
        end
        local function FiltersDeactivateCallback()
            self.filterSwitcher:Deactivate()
        end
        self.filtersFocalArea = GamepadInteractiveSortFilterFocus_Filters:New(self, FiltersActivateCallback, FiltersDeactivateCallback)
        self:AddNextFocusArea(self.filtersFocalArea)
    end
end
function ZO_GamepadInteractiveSortFilterList:SetupHeaderFocusArea()
    local function HeaderActivateCallback()
        if self.sortHeaderGroup then
            self.sortHeaderGroup:SetDirectionalInputEnabled(true)
            self.sortHeaderGroup:EnableSelection(true)
        end
    end
    local function HeaderDeactivateCallback()
        if self.sortHeaderGroup then
            self.sortHeaderGroup:SetDirectionalInputEnabled(false)
            self.sortHeaderGroup:EnableSelection(false)
        end
    end
    self.headersFocalArea = GamepadInteractiveSortFilterFocus_Headers:New(self, HeaderActivateCallback, HeaderDeactivateCallback)
    self:AddNextFocusArea(self.headersFocalArea)
end
function ZO_GamepadInteractiveSortFilterList:SetupPanelFocusArea()
    local function PanelActivateCallback()
        local ANIMATE_INSTANTLY = true
        ZO_ScrollList_AutoSelectData(self.list, ANIMATE_INSTANTLY)
    end
    local function PanelDeactivateCallback()
        self:DeselectListData()
    end
    self.panelFocalArea = GamepadInteractiveSortFilterFocus_Panel:New(self, PanelActivateCallback, PanelDeactivateCallback)
    self:AddNextFocusArea(self.panelFocalArea)
end
function ZO_GamepadInteractiveSortFilterList:SetupFoci()
end
function ZO_GamepadInteractiveSortFilterList:InitializeHeader(headerData)
    self.contentHeader = self.container:GetNamedChild("ContentHeader")
    ZO_GamepadGenericHeader_Initialize(self.contentHeader, ZO_GAMEPAD_HEADER_TABBAR_DONT_CREATE, ZO_GAMEPAD_HEADER_LAYOUTS.CONTENT_HEADER_DATA_PAIRS_LINKED)
    if headerData then
        headerData.titleTextAlignment = headerData.titleTextAlignment or TEXT_ALIGN_CENTER
    else
        headerData = { titleTextAlignment = TEXT_ALIGN_CENTER }
    end
    self.contentHeaderData = headerData
    ZO_GamepadGenericHeader_RefreshData(self.contentHeader, self.contentHeaderData)
    local titleFonts =
    {
        {
            font = "ZoFontGamepadBold48",
        },
        {
            font = "ZoFontGamepadBold34",
        },
        {
            font = "ZoFontGamepadBold27",
        }
    }
    ZO_FontAdjustingWrapLabel_OnInitialized(self.contentHeader:GetNamedChild("TitleContainerTitle"), titleFonts, TEXT_WRAP_MODE_ELLIPSIS)
end
function ZO_GamepadInteractiveSortFilterList:InitializeFilters()
    self.filterSwitcher = ZO_GamepadFocus:New(self.contentHeader, ZO_MovementController:New(MOVEMENT_CONTROLLER_DIRECTION_HORIZONTAL))
    local FocusChangedCallback = function()
        self.searchEdit:LoseFocus()
    end
end
function ZO_GamepadInteractiveSortFilterList:InitializeDropdownFilter()
    self.filterControl = self.contentHeader:GetNamedChild("DropdownFilter")
    local filterDropdownControl = self.filterControl:GetNamedChild("Dropdown")
    self.filterDropdown = ZO_ComboBox_ObjectFromContainer(filterDropdownControl)
    self.filterDropdown:SetSelectedColor(ZO_DISABLED_TEXT)
    self.filterDropdown:SetSortsItems(false)
    local function DropDownDeactivatedCallback()
        self.filterSwitcher:Activate()
        self:OnFilterDeactivated()
    end
    local filterData = {
        callback = function()
            self.filterSwitcher:Deactivate()
            self.filterDropdown:Activate()
        end,
        activate = function()
            self.filterDropdown:SetSelectedColor(ZO_SELECTED_TEXT)
            SCREEN_NARRATION_MANAGER:QueueFocus(self.filterSwitcher)
        end,
        deactivate = function()
            self.filterDropdown:SetSelectedColor(ZO_DISABLED_TEXT)
        end,
        narrationText = function()
            local narrations = {}
            ZO_AppendNarration(narrations, self.filterDropdown:GetNarrationText())
            ZO_AppendNarration(narrations, self:GetEmptyRowNarration())
            return narrations
        end,
        headerNarrationFunction = function()
            return self:GetHeaderNarration()
        end,
        footerNarrationFunction = function()
            return self:GetFooterNarration()
        end,
        highlight = self.filterControl:GetNamedChild("Highlight"),
        canFocus = function() return not self.filterControl:IsHidden() and not filterDropdownControl:IsHidden() end,
    }
    self.filterSwitcher:AddEntry(filterData)
end
function ZO_GamepadInteractiveSortFilterList:InitializeSearchFilter()
    self.searchControl = self.contentHeader:GetNamedChild("SearchFilter")
    local searchEdit = self.searchControl:GetNamedChild("SearchEdit")
    local function SearchEditFocusLost()
        ZO_GamepadEditBox_FocusLost(searchEdit)
        SCREEN_NARRATION_MANAGER:QueueFocus(self.filterSwitcher)
        self:RefreshFilters()
    end
    searchEdit:SetHandler("OnFocusLost", SearchEditFocusLost)
    local searchData = {
        callback = function() 
            if not searchEdit:HasFocus() then
                searchEdit:TakeFocus()
            end
        end,
        activate = function()
            SCREEN_NARRATION_MANAGER:QueueFocus(self.filterSwitcher)
        end,
        narrationText = function()
            local narrations = {}
            ZO_AppendNarration(narrations, ZO_FormatEditBoxNarrationText(searchEdit, GetString(SI_SCREEN_NARRATION_EDIT_BOX_SEARCH_NAME)))
            ZO_AppendNarration(narrations, self:GetEmptyRowNarration())
            return narrations
        end,
        headerNarrationFunction = function()
            return self:GetHeaderNarration()
        end,
        footerNarrationFunction = function()
            return self:GetFooterNarration()
        end,
        highlight = self.searchControl:GetNamedChild("Highlight"),
        canFocus = function() return not self.searchControl:IsHidden() and not searchEdit:IsHidden() end
    }
    self.filterSwitcher:AddEntry(searchData)
    self.searchEdit = searchEdit
end
function ZO_GamepadInteractiveSortFilterList:InitializeKeybinds()
    -- Keybind Strip when a filter column header is selected
    local filterKeybindStripDescriptor =
    {
        alignment = KEYBIND_STRIP_ALIGN_LEFT,
        {
            name = GetString(SI_GAMEPAD_SELECT_OPTION),
            keybind = "UI_SHORTCUT_PRIMARY",
            callback = function()
                local data = self.filterSwitcher:GetFocusItem()
                if data.callback then
                    data.callback()
                end
            end,
        },
    }
    ZO_Gamepad_AddBackNavigationKeybindDescriptors(filterKeybindStripDescriptor, GAME_NAVIGATION_TYPE_BUTTON, self:GetBackKeybindCallback())
    -- Keybind Strip when a list column header is selected
    local headerKeybindStripDescriptor =
    {
        alignment = KEYBIND_STRIP_ALIGN_LEFT,
        {
            name = GetString(SI_GAMEPAD_SORT_OPTION),
            keybind = "UI_SHORTCUT_PRIMARY",
            callback = function()
                self.sortHeaderGroup:SortBySelected()
            end,
            enabled = function()
                return self:CanChangeSortKey()
            end
        },
    }
    ZO_Gamepad_AddBackNavigationKeybindDescriptors(headerKeybindStripDescriptor, GAME_NAVIGATION_TYPE_BUTTON, self:GetBackKeybindCallback())
    --Triggers let you go straight to top or bottom of the list
    self.keybindStripDescriptor[#self.keybindStripDescriptor + 1] = {
         --Ethereal binds show no text, the name field is used to help identify the keybind when debugging. This text does not have to be localized.
        name = "Gamepad Interactive Sort Filter List Left Trigger",
        keybind = "UI_SHORTCUT_LEFT_TRIGGER",
        ethereal = true,
        callback = function()
            self:OnLeftTrigger()
        end,
    }
    self.keybindStripDescriptor[#self.keybindStripDescriptor + 1] = {
        --Ethereal binds show no text, the name field is used to help identify the keybind when debugging. This text does not have to be localized.
        name = "Gamepad Interactive Sort Filter List Right Trigger",
        keybind = "UI_SHORTCUT_RIGHT_TRIGGER",
        ethereal = true,
        callback = function()
            self:OnRightTrigger()
        end,
    }
    if self.filtersFocalArea then
        self.filtersFocalArea:SetKeybindDescriptor(filterKeybindStripDescriptor)
    end
    if self.headersFocalArea then
        self.headersFocalArea:SetKeybindDescriptor(headerKeybindStripDescriptor)
    end
    self.panelFocalArea:SetKeybindDescriptor(self.keybindStripDescriptor)
end
function ZO_GamepadInteractiveSortFilterList:AddUniversalKeybind(keybind)
    if self.filtersFocalArea then
        self.filtersFocalArea:AppendKeybind(keybind)
    end
    if self.headersFocalArea then
        self.headersFocalArea:AppendKeybind(keybind)
    end
    self.panelFocalArea:AppendKeybind(keybind)
end
function ZO_GamepadInteractiveSortFilterList:GetBackKeybindCallback()
    -- this function can be overridden in a subclass
end
function ZO_GamepadInteractiveSortFilterList:SetupSort(sortKeys, initialKey, initialDirection)
    self.sortKeys = sortKeys
    local DONT_SUPPRESS_CALLBACKS = nil
    local DONT_FORCE_RESELECT = nil
    self.sortHeaderGroup:SelectHeaderByKey(initialKey, DONT_SUPPRESS_CALLBACKS, DONT_FORCE_RESELECT, initialDirection)
    self.sortHeaderGroup:SortBySelected()
end
--Events/Callbacks--
function ZO_GamepadInteractiveSortFilterList:OnAllDialogsHidden()
    --Re-narrate the current focus upon closing dialogs
    local NARRATE_HEADER = true
    self:NarrateSelection(NARRATE_HEADER)
end
function ZO_GamepadInteractiveSortFilterList:NarrateSelection(narrateHeader)
    if self:IsActivated() then
        --Determine if we need to narrate the filter switcher, sort header group, or list entry
        if self:IsCurrentFocusArea(self.filtersFocalArea) then
            SCREEN_NARRATION_MANAGER:QueueFocus(self.filterSwitcher, narrateHeader)
        elseif self:IsCurrentFocusArea(self.headersFocalArea) then
            if self.sortHeaderGroup then
                SCREEN_NARRATION_MANAGER:QueueSelectedSortHeader(self, self.sortHeaderGroup, self.sortHeaderGroup:GetKeyForCurrentSelectedIndex(), narrateHeader)
            end
        elseif self:IsCurrentFocusArea(self.panelFocalArea) then
            SCREEN_NARRATION_MANAGER:QueueSortFilterListEntry(self, narrateHeader)
        end
    end
end
function ZO_GamepadInteractiveSortFilterList:OnShowing()
    --To be overriden
end
function ZO_GamepadInteractiveSortFilterList:OnShown()
    --To be overriden
end
function ZO_GamepadInteractiveSortFilterList:OnHiding()
    self:Deactivate()
end
function ZO_GamepadInteractiveSortFilterList:OnHidden()
    --To be overriden
end
function ZO_GamepadInteractiveSortFilterList:Activate(foregoDirectionalInput)
    if not foregoDirectionalInput then
        self:SetDirectionalInputEnabled(true)
    end
    local hasEntries = self:HasEntries()
    local activeFocus = hasEntries and self.panelFocalArea or self.headersFocalArea
    if not activeFocus then
        self:Deactivate()
    else
        self:ActivateFocusArea(activeFocus)
        self.isActive = true
        ZO_GamepadOnDefaultActivatedChanged(self.list, self.isActive)
        if hasEntries then
            local NARRATE_HEADER = true
            SCREEN_NARRATION_MANAGER:QueueSortFilterListEntry(self, NARRATE_HEADER)
        elseif self.sortHeaderGroup then
            local NARRATE_HEADER = true
            SCREEN_NARRATION_MANAGER:QueueSelectedSortHeader(self, self.sortHeaderGroup, self.sortHeaderGroup:GetKeyForCurrentSelectedIndex(), NARRATE_HEADER)
        end
    end
end
function ZO_GamepadInteractiveSortFilterList:Deactivate(foregoDirectionalInput)
    if not foregoDirectionalInput then
        self:SetDirectionalInputEnabled(false)
    end
    if self.filterDropdown and self.filterDropdown:IsActive() then
        local BLOCK_CALLBACK = true
        self.filterDropdown:Deactivate(BLOCK_CALLBACK)
    end
    self:ActivateFocusArea(nil)
    self.isActive = false
end
function ZO_GamepadInteractiveSortFilterList:IsActive()
    return self.isActive
end
function ZO_GamepadInteractiveSortFilterList:ActivatePanelFocus()
    if self:HasEntries() then
        self:ActivateFocusArea(self.panelFocalArea)
    end
end
function ZO_GamepadInteractiveSortFilterList:IsPanelFocused()
    return self:IsCurrentFocusArea(self.panelFocalArea)
end
function ZO_GamepadInteractiveSortFilterList:IsHeaderFocused()
    return self:IsCurrentFocusArea(self.headersFocalArea)
end
function ZO_GamepadInteractiveSortFilterList:AreFiltersFocused()
    return self:IsCurrentFocusArea(self.filtersFocalArea)
end
function ZO_GamepadInteractiveSortFilterList:CanChangeSortKey()
    --To be overriden
    return true
end
-- explicitly call the correct base class function
function ZO_GamepadInteractiveSortFilterList:UpdateDirectionalInput()
    ZO_GamepadMultiFocusArea_Manager.UpdateDirectionalInput(self)
end
function ZO_GamepadInteractiveSortFilterList:OnFilterDeactivated()
    self:RefreshFilters()
end
function ZO_GamepadInteractiveSortFilterList:OnLeftTrigger()
end
function ZO_GamepadInteractiveSortFilterList:OnRightTrigger()
end
--Get / Set --
function ZO_GamepadInteractiveSortFilterList:SetTitle(titleName)
    self.contentHeaderData.titleText = titleName
    ZO_GamepadGenericHeader_RefreshData(self.contentHeader, self.contentHeaderData)
end
function ZO_GamepadInteractiveSortFilterList:RefreshHeader()
    ZO_GamepadGenericHeader_RefreshData(self.contentHeader, self.contentHeaderData)
end
--This class uses :SetEmptyText(), not :SetNoItemText()
function ZO_GamepadInteractiveSortFilterList:SetEmptyText(emptyText)
    if not self.emptyRow then
        self.emptyRow = self.container:GetNamedChild("EmptyRow")
        self.emptyRowMessage = self.emptyRow:GetNamedChild("Message")
    end
    self.emptyText = emptyText
    self.emptyRowMessage:SetText(emptyText)
end
function ZO_GamepadInteractiveSortFilterList:SetMasterList(list)
    self.masterList = list
end
function ZO_GamepadInteractiveSortFilterList:GetMasterList()
    return self.masterList
end
function ZO_GamepadInteractiveSortFilterList:GetHeaderControl(headerName)
    return self.headersContainer:GetNamedChild(headerName)
end
function ZO_GamepadInteractiveSortFilterList:SetHeaderNameForKey(key, name)
    if self.sortHeaderGroup then
        self.sortHeaderGroup:SetHeaderNameForKey(key, name)
    end
end
function ZO_GamepadInteractiveSortFilterList:GetContentHeaderData()
    return self.contentHeaderData
end
function ZO_GamepadInteractiveSortFilterList:GetCurrentSearch()
    return self.searchEdit:GetText()
end
--This class uses :HasEntries(), not :IsEmpty()
function ZO_GamepadInteractiveSortFilterList:HasEntries(ignoreFilters)
    if ignoreFilters then
        return self.masterList and #self.masterList > 0 or false
    else
        return ZO_SortFilterList.HasEntries(self)
    end
end
function ZO_GamepadInteractiveSortFilterList:GetListFragment()
    return self.listFragment
end
function ZO_GamepadInteractiveSortFilterList:UpdateKeybinds()
    ZO_SortFilterList_Gamepad.UpdateKeybinds(self)
    if self.filtersFocalArea then
        self.filtersFocalArea:UpdateKeybinds()
    end
    if self.headersFocalArea then
        self.headersFocalArea:UpdateKeybinds()
    end
    self.panelFocalArea:UpdateKeybinds()
end
function ZO_GamepadInteractiveSortFilterList:RemoveFilters()
    -- TODO: Instead of doing this, create a ZO_GamepadInteractiveSortList base class that doesn't have filters, and then implement filter behavior as a subclass.
    self.areFiltersRemoved = true
    local searchControl = self.contentHeader:GetNamedChild("SearchFilter")
    local dropdownControl = self.contentHeader:GetNamedChild("DropdownFilter")
    local titleControl = self.contentHeader:GetNamedChild("TitleContainerTitle")
    searchControl:SetHidden(true)
    dropdownControl:SetHidden(true)
    titleControl:ClearAnchors()
    titleControl:SetAnchor(TOPLEFT, nil, TOPLEFT, 0, 0)
    titleControl:SetAnchor(BOTTOMRIGHT, nil, BOTTOMRIGHT, 0, 0)
end
--List management --
function ZO_GamepadInteractiveSortFilterList:FilterScrollList()
    -- intended to be overriden
    -- should take the master list data and filter it
end
function ZO_GamepadInteractiveSortFilterList:SortScrollList()
    -- can optionally be overriden
    -- should take the filtered data and sort it
    -- The default implemenation will sort according to the sort keys specified in the SetupSort function
    if self.sortKeys and self.currentSortKey and self.currentSortOrder ~= nil then
        local scrollData = ZO_ScrollList_GetDataList(self.list)
        table.sort(scrollData, self.sortFunction)
    end
end
function ZO_GamepadInteractiveSortFilterList:CompareSortEntries(listEntry1, listEntry2)
    return ZO_TableOrderingFunction(listEntry1.data, listEntry2.data, self.currentSortKey, self.sortKeys, self.currentSortOrder)
end
function ZO_GamepadInteractiveSortFilterList:CommitScrollList()
    ZO_SortFilterList.CommitScrollList(self)
    --Display a different string if there are no results to find than if your filters eliminated all results
    if self.emptyRow and not self.emptyRow:IsHidden() then
        self.emptyRowMessage:SetText(#self.masterList == 0 and self.emptyText or GetString(SI_SORT_FILTER_LIST_NO_RESULTS))
    end
    if self:IsPanelFocused() and self.isActive then
        local scrollData = ZO_ScrollList_GetDataList(self.list)
        if #scrollData == 0 then
            --If the cursor is in the list, but the list is empty because of a filter, we need to force it out of the panel area
            self:ActivateFocusArea(self.headersFocalArea)
        else
            local ANIMATE_INSTANTLY = true
            local selectedData = ZO_ScrollList_GetSelectedData(self.list)
            if selectedData then
                -- make sure our selection is in view in case there was a large change from a filter
                local NO_CALLBACK = nil
                ZO_ScrollList_ScrollDataIntoView(self.list, ZO_ScrollList_GetSelectedDataIndex(self.list), NO_CALLBACK, ANIMATE_INSTANTLY)
            else
                -- if we've lost our selection and the panelFocalArea is active, then we want to
                -- AutoSelect the next appropriate entry
                ZO_ScrollList_AutoSelectData(self.list, ANIMATE_INSTANTLY)
            end
        end
    end
end
function ZO_GamepadInteractiveSortFilterList:IsMatch(searchTerm, data)
    return self.searchProcessor:IsMatch(searchTerm, data)
end
function ZO_GamepadInteractiveSortFilterList:ProcessNames(stringSearch, data, searchTerm, cache)
    local lowerSearchTerm = searchTerm:lower()
    if(zo_plainstrfind(data.displayName:lower(), lowerSearchTerm)) then
        return true
    end
    if(data.characterName ~= nil and zo_plainstrfind(data.characterName:lower(), lowerSearchTerm)) then
        return true
    end
end
function ZO_GamepadInteractiveSortFilterList:DeselectListData()
end
--Overridden from base
function ZO_GamepadInteractiveSortFilterList:GetEmptyRowNarration()
    local narrations = {}
    if self.emptyRow and not self.emptyRow:IsHidden() then
        --Narrate a different string if there are no results to find than if your filters eliminated all results
        local emptyMessage = #self.masterList == 0 and self.emptyText or GetString(SI_SORT_FILTER_LIST_NO_RESULTS)
        ZO_AppendNarration(narrations, SCREEN_NARRATION_MANAGER:CreateNarratableObject(emptyMessage))
    end
    return narrations
end
--Overridden from base
function ZO_GamepadInteractiveSortFilterList:GetHeaderNarration()
    return ZO_GamepadGenericHeader_GetNarrationText(self.contentHeader, self.contentHeaderData)
end
--Global functions--
    ZO_SortHeader_Initialize(control, text, sortKey, ZO_SORT_ORDER_UP, textAlignment, nil, "ZO_GamepadInteractiveSortFilterHeaderHighlight", narrationText)
    if textAlignment == TEXT_ALIGN_RIGHT then
        local nameControl = control:GetNamedChild("Name")
        --Account for the arrow
        nameControl:SetAnchor(BOTTOMRIGHT, control, BOTTOMRIGHT, -ZO_GAMEPAD_INTERACTIVE_FILTER_ARROW_PADDING)
    end
end