Back to Home

ESO Lua File v101041

libraries/zo_pagedlist/zo_pagedlist.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
ZO_PAGEDLIST_MOVEMENT_TYPES = 
{
    PAGE_FORWARD = 1,
    PAGE_BACK = 2,
    -- LAST allows derived classes to start their movement enumerations after the base movements
    LAST = 3,
}
    if type == ZO_PAGEDLIST_MOVEMENT_TYPES.PAGE_FORWARD then
        PlaySound(SOUNDS.GAMEPAD_PAGE_FORWARD)
    elseif type == ZO_PAGEDLIST_MOVEMENT_TYPES.PAGE_BACK then
        PlaySound(SOUNDS.GAMEPAD_PAGE_BACK)
    end
end
ZO_PagedListFooter = ZO_InitializingObject:Subclass()
function ZO_PagedListFooter:Initialize(control)
    self.control = control
    self.previousButton = control:GetNamedChild("PreviousButton")
    self.nextButton = control:GetNamedChild("NextButton")
    self.pageNumberLabel = control:GetNamedChild("PageNumberText")
end
function ZO_PagedListFooter:SetPageText(pageNumber)
    self.pageNumberLabel:SetText(pageNumber)
end
function ZO_PagedListFooter:SetHidden(hidden)
    self.control:SetHidden(hidden)
end
function ZO_PagedListFooter:IsHidden()
    return self.control:IsHidden()
end
function ZO_PagedListSetupFooter(footerControl)
    return ZO_PagedListFooter:New(footerControl)
end
ZO_PagedList = ZO_SortFilterListBase:Subclass()
function ZO_PagedList:New(...)
    return ZO_SortFilterListBase.New(self, ...)
end
function ZO_PagedList:BuildMasterList()
    -- intended to be overriden
    -- should populate the dataList by calling AddEntry
end
function ZO_PagedList:FilterList()
    -- intended to be overriden
    -- should take the dataList and filter it
end
function ZO_PagedList:SortList()
    -- can optionally be overriden
    -- should take the dataList and sort it
    -- The default implemenation will sort according to the sort keys specified in the SetupSort function
    if self.sortKeys then
        table.sort(self.dataList, function(listEntry1, listEntry2) return self:CompareSortEntries(listEntry1, listEntry2) end)
    end
end
function ZO_PagedList:OnListChanged()
    -- intended to be overriden
    -- allows a subclass to react when list contents change
end
function ZO_PagedList:OnPageChanged()
    -- intended to be overriden
    -- allows a subclass to react when list page changes
end
function ZO_PagedList:Initialize(control, movementController)
    ZO_SortFilterListBase.Initialize(self, control, movementController)
    self.listControl = control:GetNamedChild("List")
    self.focus = ZO_GamepadFocus:New(self.listControl, movementController)
    
    local selectionChangeCallback = function(entryControl)
        if self.selectionChangedCallback then
            local data = nil
            if entryControl then
                data = entryControl.data.data
            end
            self.selectionChangedCallback(data)
        end
    end
    self.dataTypes = {}
    self.dataList = {}
    self.pages = {}
    self.currPageNum = 1  
    self.numPages = 0
    self.rememberSpot = false
    local headerContainer = control:GetNamedChild("Headers")
    if headerContainer then
        local showArrows = true
        self.sortHeaderGroup = ZO_SortHeaderGroup:New(headerContainer, showArrows)
        self.sortHeaderGroup:SetColors(ZO_SELECTED_TEXT, ZO_NORMAL_TEXT, ZO_SELECTED_TEXT, ZO_DISABLED_TEXT)
        self.sortHeaderGroup:RegisterCallback(ZO_SortHeaderGroup.HEADER_CLICKED, function(key, order) self:OnSortHeaderClicked(key, order) end)
        self.sortHeaderGroup:AddHeadersFromContainer()
    end
    local footerControl = control:GetNamedChild("Footer")
    if footerControl then
        self.footer = 
        {
            control = footerControl,
            previousButton = footerControl:GetNamedChild("PreviousButton"),
            nextButton = footerControl:GetNamedChild("NextButton"),
            pageNumberLabel = footerControl:GetNamedChild("PageNumberText"),
        }
    end
    self.onEnterRow = function(rowControl, data)
        self:OnEnterRow(rowControl, data.data)   
    end
    self.onLeaveRow = function(rowControl, data)
        self:OnLeaveRow(rowControl, data.data)   
    end
    local hideKeybind = footerControl ~= nil
    self.pagedListKeybindStripDescriptor =
    {
        alignment = KEYBIND_STRIP_ALIGN_LEFT,
        -- Previous
        {
            --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 = "Paged List Previous Page",
            keybind = "UI_SHORTCUT_LEFT_TRIGGER",
            order = 100,
            callback = function()
                self:PreviousPage()
            end,
            ethereal = hideKeybind,
        },
        -- Next
        {
            --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 = "Paged List Next Page",
            keybind = "UI_SHORTCUT_RIGHT_TRIGGER",
            order = 100,
            callback = function()
                self:NextPage()
            end,
            ethereal = hideKeybind,
        },
    }
end
function ZO_PagedList:TakeFocus()
    self.focus:Activate()
end
function ZO_PagedList:ClearFocus()
    self.focus:Deactivate()
end
function ZO_PagedList:Activate()
    self:TakeFocus()
    KEYBIND_STRIP:AddKeybindButtonGroup(self.pagedListKeybindStripDescriptor)
end
function ZO_PagedList:Deactivate(retainFocus)
    KEYBIND_STRIP:RemoveKeybindButtonGroup(self.pagedListKeybindStripDescriptor)
    self.focus:Deactivate(retainFocus)
end
function ZO_PagedList:ActivateHeader()
    if self.sortHeaderGroup then
        self.sortHeaderGroup:SetDirectionalInputEnabled(true)
        self.sortHeaderGroup:EnableSelection(true)
    end
end
function ZO_PagedList:DeactivateHeader()
    if self.sortHeaderGroup then
        self.sortHeaderGroup:SetDirectionalInputEnabled(false)
        self.sortHeaderGroup:EnableSelection(false)
    end
end
function ZO_PagedList:SetupSort(sortKeys, initialKey, initialDirection)
    self.sortKeys = sortKeys
    self.currentSortKey = initialKey
    self.currentSortOrder = initialDirection
end
function ZO_PagedList:SetSelectionChangedCallback(callback)
end
function ZO_PagedList:SetLeaveListAtBeginningCallback(callback)
end
function ZO_PagedList:OnEnterRow(control, data)
    -- This is meant to be overriden in a subclass
end
function ZO_PagedList:OnLeaveRow(control, data)
    -- This is meant to be overriden in a subclass
end
function ZO_PagedList:RefreshData()
    self:FilterList()
    self:SortList()
    self:CommitList()
end
function ZO_PagedList:RefreshSort()
    self:SortList()
    self:CommitList()
end
function ZO_PagedList:RefreshFilters()
    self:FilterList()
    self:SortList()
    self:CommitList()
end
function ZO_PagedList:RefreshVisible()
    local page = self.pages[self.currPageNum]
    if page == nil then
        return 
    end
    local lastIndex = (page.startIndex + page.count - 1)
    for i = page.startIndex, lastIndex do
        local data = self.dataList[i]
        local control = data.control
        local selected = self:IsSelected(data.data)
        self.dataTypes[control.templateName].setupCallback(control, data.data, selected)
    end
    self:OnListChanged()
end
function ZO_PagedList:CommitList()
    self:BuildPages()
    self:BuildPage(self.currPageNum)
    self:RefreshFooter()
    self:OnListChanged()
end
function ZO_PagedList:AddDataTemplate(templateName, height, setupCallback, controlPoolPrefix)
    if not self.dataTypes[templateName] then
        local dataTypeInfo =
        {
            pool = ZO_ControlPool:New(templateName, self.listControl, controlPoolPrefix or templateName),
            height = height,
            setupCallback = setupCallback
        }
        self.dataTypes[templateName] = dataTypeInfo
    end
end
function ZO_PagedList:AddEntry(templateName, data)
     if self.dataTypes[templateName] then
        local entry = 
        {
            templateName = templateName,
            data = data
        }
        
        self.dataList[#self.dataList + 1] = entry
    end
end
function ZO_PagedList:Clear()
    self.dataList = {}
    for templateName, dataTypeInfo in pairs(self.dataTypes) do
        dataTypeInfo.pool:ReleaseAllObjects()
    end
end
function ZO_PagedList:GetSelectedData()
    local focusItem = self.focus:GetFocusItem()
    if focusItem then
        return focusItem.data.data
    end
end
function ZO_PagedList:IsSelected(data)
    local focusItem = self.focus:GetFocusItem()
    if focusItem then
        return focusItem.data.data == data
    end
    return false
end
function ZO_PagedList:SetPage(pageNum)
    local newPageNum = zo_clamp(pageNum, 1, self.numPages)
    if newPageNum ~= self.currPageNum then
        if newPageNum > self.currPageNum then
            self.onPlaySoundFunction(ZO_PAGEDLIST_MOVEMENT_TYPES.PAGE_FORWARD)
        else
            self.onPlaySoundFunction(ZO_PAGEDLIST_MOVEMENT_TYPES.PAGE_BACK)
        end
        self.currPageNum = newPageNum
        self:BuildPage(self.currPageNum)
        self:RefreshFooter()
        self:OnListChanged()
    end
end
function ZO_PagedList:PreviousPage()
    self:SetPage(self.currPageNum - 1)
end
function ZO_PagedList:NextPage()
    self:SetPage(self.currPageNum + 1)
end
function ZO_PagedList:AcquireControl(dataIndex, relativeControl)
    local PADDING = 0
    local templateName = self.dataList[dataIndex].templateName
    local control, key = self.dataTypes[templateName].pool:AcquireObject()
    
    if relativeControl then
        control:SetAnchor(TOPLEFT, relativeControl, BOTTOMLEFT, 0, PADDING)
    else
        control:SetAnchor(TOPLEFT, self.listControl, TOPLEFT, 0, PADDING)
    end
    control.key = key
    control.templateName = templateName
    control.dataIndex = dataIndex
    return control, true
end
function ZO_PagedList:ReleaseControl(control)
    local templateName = control.templateName
    local pool = self.dataTypes[templateName].pool
    pool:ReleaseObject(control.key)
end
function ZO_PagedList:BuildPages()
    self.pages = {}
    local currPageHeight = 0
    local currPageNum = 1
    local _, pageHeight = self.listControl:GetDimensions()
    
    self.pages[currPageNum] = {startIndex = 1, count = 0}
    for i, data in ipairs(self.dataList) do
        local templateName = data.templateName
        local height = self.dataTypes[templateName].height
        if (currPageHeight + height) > pageHeight then
            currPageHeight = 0
            currPageNum = currPageNum + 1
            self.pages[currPageNum] = {startIndex = i, count = 0}
        end
        currPageHeight = currPageHeight + height
        self.pages[currPageNum].count = self.pages[currPageNum].count + 1
    end
    if self.emptyRow then
        self.emptyRow:SetHidden(#self.dataList > 0)
    end
    self.numPages = currPageNum
    if self.rememberSpot then
        self.currPageNum = zo_min(self.currPageNum, currPageNum)
    else
        self.currPageNum = 1
    end
end
local INCLUDE_SAVED_INDEX = true
function ZO_PagedList:BuildPage(pageNum)
    local savedIndex = self.focus:GetFocus(INCLUDE_SAVED_INDEX)
    self.focus:RemoveAllEntries()
    for templateName, dataTypeInfo in pairs(self.dataTypes) do
        dataTypeInfo.pool:ReleaseAllObjects()
    end
    local page = self.pages[pageNum]
    local lastIndex = (page.startIndex + page.count - 1)
    local previousControl
    for i = page.startIndex, lastIndex do
        local data = self.dataList[i]
        local control = self:AcquireControl(i, previousControl)
        data.control = control
        local selected = self:IsSelected(data.data)
        self.dataTypes[control.templateName].setupCallback(control, data.data, selected)
        local entry =
        {
            control = control,
            highlight = control:GetNamedChild("Highlight"),
            data = data,
            activate = self.onEnterRow,
            deactivate = self.onLeaveRow,
        }
        self.focus:AddEntry(entry)
        previousControl = control
        if self.alternateRowBackgrounds then
            local rowBackground = control:GetNamedChild("BG")
            if rowBackground then
                local hidden = (i % 2) == 0
                rowBackground:SetHidden(hidden)
            end
        end
    end
    if self.rememberSpot then
        local itemsOnPage = self.focus:GetItemCount()
        if savedIndex then
            savedIndex = zo_min(savedIndex, itemsOnPage)
        end
        self.focus:SetFocusByIndex(savedIndex or 1)
    else
        self.focus:SetFocusByIndex(1)
    end
end
function ZO_PagedList:RefreshSelectedRow()
    local focusItem = self.focus:GetFocusItem()
    if focusItem then
        local selected = self:IsSelected(focusItem.data.data)
        self.dataTypes[focusItem.control.templateName].setupCallback(focusItem.control, focusItem.data.data, selected)
    end
end
function ZO_PagedList:OnSortHeaderClicked(key, order)
    self.currentSortKey = key
    self.currentSortOrder = order
    self:RefreshSort()
end
function ZO_PagedList:CompareSortEntries(listEntry1, listEntry2)
    return ZO_TableOrderingFunction(listEntry1.data, listEntry2.data, self.currentSortKey, self.sortKeys, self.currentSortOrder)
end
function ZO_PagedList:SetEmptyText(emptyText, template)
    if not self.emptyRow then
        self.emptyRow = CreateControlFromVirtual("$(parent)EmptyRow", self.focus.control, template)
    end
    self.emptyRow:GetNamedChild("Message"):SetText(emptyText)
end
function ZO_PagedList:RefreshFooter()
    if not self.footer then 
        return
    end
    local enablePrevious = self.currPageNum > 1
    self.footer.previousButton:SetEnabled(enablePrevious)
    local enableNext = self.currPageNum < #self.pages
    self.footer.nextButton:SetEnabled(enableNext)
    
    local pageNumberText = zo_strformat(SI_GAMEPAD_PAGED_LIST_PAGE_NUMBER, self.currPageNum)
    self.footer.pageNumberLabel:SetText(pageNumberText)
    self.footer.control:SetHidden(#self.pages <= 1)
end
function ZO_PagedList:SetAlternateRowBackgrounds(alternate)
    self.alternateRowBackgrounds = alternate
end
function ZO_PagedList:SetPlaySoundFunction(fn)
end
function ZO_PagedList:SetRememberSpotInList(rememberSpot)
    self.rememberSpot = rememberSpot
end