ESO Lua File v100012

ingame/collections/keyboard/collectionsbook.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
local MAX_SUMMARY_CATEGORIES = 10
local SUMMARY_CATEGORY_BAR_HEIGHT = 16
local SUMMARY_CATEGORY_PADDING = 50
local COLLECTIBLE_PADDING = 10
local COLLECTIBLE_STICKER_SINGLE_WIDTH = 170
local COLLECTIBLE_STICKER_SINGLE_HEIGHT = 125
local COLLECTIBLE_STICKER_ROW_STRIDE = 3
local MAX_COLLECTIBLE_ROW_WIDTH = (COLLECTIBLE_STICKER_SINGLE_WIDTH + COLLECTIBLE_PADDING) * COLLECTIBLE_STICKER_ROW_STRIDE
local RETAIN_SCROLL_POSITION = true
local DONT_RETAIN_SCROLL_POSITION = true
--Descriptive defaults for readibility in function calls
local FORCE_HIDE_PROGRESS_TEXT = true
local DONT_HIDE_LOCKED = false
local function GetTextColor(enabled, normalColor, disabledColor)
    if enabled then
        return (normalColor or ZO_NORMAL_TEXT):UnpackRGBA()
    end
    return (disabledColor or ZO_DISABLED_TEXT):UnpackRGBA()
end
local function ApplyTextColorToLabel(label, ...)
    label:SetColor(GetTextColor(...))
end
--[[Collectible]]--
-------------------
--[[ Initialization ]]--
------------------------
local Collectible = ZO_Object:Subclass()
function Collectible:New(...)
    local collectible = ZO_Object.New(self)
    collectible:Initialize(...)
    
    return collectible
end
function Collectible:Initialize(control, gridDimensions)
    control.collectible = self
    self.control = control
    self.gridDimensions = gridDimensions
    self.title = control:GetNamedChild("Title")
    self.highlight = control:GetNamedChild("Highlight")
    self.icon = control:GetNamedChild("Icon")
    self.activeIcon = control:GetNamedChild("ActiveIcon")
    self.cornerTag = control:GetNamedChild("CornerTag")
    self.iconAnimation = ANIMATION_MANAGER:CreateTimelineFromVirtual("JournalProgressIconSlotMouseOverAnimation", self.icon)
end
function Collectible:Show(collectibleId, previousControl)
    self.collectibleId = collectibleId
    local name, description, icon, lockedIcon, unlocked, purchasable, isActive, categoryType = self:GetCollectibleInfo()
    local effectiveIcon = unlocked and icon or lockedIcon
    
    self.unlocked = unlocked
    self.purchasable = purchasable
    self.title:SetText(zo_strformat(SI_COLLECTIBLE_NAME_FORMATTER, name))
    self.icon:SetTexture(effectiveIcon or ZO_NO_TEXTURE_FILE)
    ApplyTextColorToLabel(self.title, unlocked, ZO_NORMAL_TEXT, ZO_DISABLED_TEXT)
    self.title:SetHidden(false)
    self.icon:SetHidden(false)
    self:SetAnchor(previousControl)
    self.control:SetHidden(false)
    self.categoryType = categoryType
    
    self.active = isActive
    self.activeIcon:SetHidden(not isActive)
    self.isUsable = unlocked and COLLECTIONS_INVENTORY_VALID_CATEGORY_TYPES[categoryType] and
                    not (isActive and categoryType == COLLECTIBLE_CATEGORY_TYPE_MOUNT) --a mount must always be set
    if self.isCurrentMouseTarget then
        self:ShowKeybinds()
    end
end
function Collectible:ShowBlank(previousControl)
    self.collectibleId = nil
    self.purchasable = false
    self.title:SetHidden(true)
    self.icon:SetHidden(true)
    self:SetAnchor(previousControl)
    self.control:SetHidden(false)
    self.activeIcon:SetHidden(true)
    self.cornerTag:SetHidden(true)
end
function Collectible:GetId()
    return self.collectibleId
end
function Collectible:GetCollectibleInfo()
    return GetCollectibleInfo(self.collectibleId)
end
function Collectible:SetAnchor(previousControl)
    local width = self.control:GetWidth()
    local height = self.control:GetHeight()
    if not previousControl then
        self.control:SetAnchor(TOPLEFT, nil, TOPLEFT, COLLECTIBLE_PADDING, 0)
        self.right = width + COLLECTIBLE_PADDING
        self.bottom = height
    else
        --We assume that collectibles will be sorted largest to smallest, to avoid weird Tetris combinations
        if previousControl.right + width > MAX_COLLECTIBLE_ROW_WIDTH then
            self.control:SetAnchor(TOPLEFT, nil, TOPLEFT, COLLECTIBLE_PADDING, previousControl.bottom + COLLECTIBLE_PADDING)
            self.right = width + COLLECTIBLE_PADDING
            self.bottom = previousControl.bottom + height + COLLECTIBLE_PADDING
        else
            self.control:SetAnchor(TOPLEFT, previousControl.control, TOPRIGHT, COLLECTIBLE_PADDING, 0)
            self.right = previousControl.right + width + COLLECTIBLE_PADDING
            self.bottom = previousControl.bottom
        end
    end
end
function Collectible:GetControl()
    return self.control
end
function Collectible:Reset()
    self.control:SetHidden(true)
    self:SetHighlightHidden(true)
end
function Collectible:SetHighlightHidden(hidden)
    self.highlight:SetHidden(false) -- let alpha take care of the actual hiding
    if not self.highlightAnimation then
        self.highlightAnimation = ANIMATION_MANAGER:CreateTimelineFromVirtual("JournalProgressHighlightAnimation", self.highlight)
    end
    if(hidden) then
        ApplyTextColorToLabel(self.title, self.unlocked, ZO_NORMAL_TEXT, ZO_DISABLED_TEXT)
        self.iconAnimation:PlayBackward()
        self.highlightAnimation:PlayBackward()
    else
        ApplyTextColorToLabel(self.title, self.unlocked, ZO_HIGHLIGHT_TEXT, ZO_SELECTED_TEXT)
        self.iconAnimation:PlayForward()
        self.highlightAnimation:PlayForward()
    end
end
function Collectible:ShowCollectibleMenu()
    local collectibleId = self.collectibleId
    if not collectibleId then
        return
    end
    ClearMenu()
    --Use
    if self.isUsable then
        local textEnum = self.active and SI_COLLECTIBLE_ACTION_PUT_AWAY or SI_COLLECTIBLE_ACTION_SET_ACTIVE
        AddMenuItem(GetString(textEnum), function() UseCollectible(collectibleId) end)
    end
        --Link in chat
        local link = GetCollectibleLink(collectibleId, LINK_STYLE_BRACKETS)
        AddMenuItem(GetString(SI_ITEM_ACTION_LINK_TO_CHAT), function() ZO_LinkHandler_InsertLink(zo_strformat(SI_TOOLTIP_ITEM_NAME, link)) end)
    end
    --Rename
    if IsCollectibleRenameable(collectibleId) then
        AddMenuItem(GetString(SI_COLLECTIBLE_ACTION_RENAME), function() ZO_Dialogs_ShowDialog("COLLECTIONS_INVENTORY_RENAME_COLLECTIBLE", { collectibleId = collectibleId }) end)
    end
end
local g_keybindUseCollectible = {
    name = nil,
    keybind = "UI_SHORTCUT_PRIMARY",
    callback = nil,
}
local g_keybindRenameCollectible = {
    name = GetString(SI_COLLECTIBLE_ACTION_RENAME),
    keybind = "UI_SHORTCUT_SECONDARY",
    callback = nil,
}
function Collectible:ShowKeybinds()
    local function UpdateKeybind(keybind)
        if KEYBIND_STRIP:HasKeybindButton(keybind) then
            KEYBIND_STRIP:UpdateKeybindButton(keybind)
        else
            KEYBIND_STRIP:AddKeybindButton(keybind)
        end
    end
    if self.isUsable then
        local textEnum = self.active and SI_COLLECTIBLE_ACTION_PUT_AWAY or SI_COLLECTIBLE_ACTION_SET_ACTIVE
        g_keybindUseCollectible.name = GetString(textEnum)
        g_keybindUseCollectible.callback = function() UseCollectible(self.collectibleId) end
        UpdateKeybind(g_keybindUseCollectible)
    end
    if IsCollectibleRenameable(self.collectibleId) then
        g_keybindRenameCollectible.callback = function() ZO_Dialogs_ShowDialog("COLLECTIONS_INVENTORY_RENAME_COLLECTIBLE", { collectibleId = self.collectibleId }) end
        UpdateKeybind(g_keybindRenameCollectible)
    end
end
function Collectible:HideKeybinds()
    KEYBIND_STRIP:RemoveKeybindButton(g_keybindUseCollectible)
    KEYBIND_STRIP:RemoveKeybindButton(g_keybindRenameCollectible)
end
function Collectible:OnMouseEnter()
    if self.collectibleId then
        self:SetHighlightHidden(false)
        InitializeTooltip(ItemTooltip, self.control, RIGHT, -5, 0, LEFT)
        ItemTooltip:SetCollectible(self.collectibleId, true)
        self.isCurrentMouseTarget = true
        self:ShowKeybinds()
        if self.purchasable then
            self.cornerTag:SetHidden(false)
        end
    end
end
function Collectible:OnMouseExit()
    if self.collectibleId then
        self:SetHighlightHidden(true)
        ClearTooltip(ItemTooltip)
        self:HideKeybinds()
        self.isCurrentMouseTarget = false
        if self.purchasable then
            self.cornerTag:SetHidden(true)
        end
    end
end
function Collectible:OnClicked(button)
    if(button == MOUSE_BUTTON_INDEX_RIGHT) then
        --TODO: Add open store bridge (if applicable)
        self:ShowCollectibleMenu()
    end
end
function Collectible:OnMouseDoubleClick(button)
    if(button == MOUSE_BUTTON_INDEX_LEFT) then
        if self.collectibleId and self.isUsable then
            UseCollectible(self.collectibleId)
        end
    end
end
function Collectible:OnEffectivelyHidden()
    self:HideKeybinds()
end
--[[ Collection ]]--
--------------------
--[[ Initialization ]]--
------------------------
local CollectionsBook = ZO_JournalProgressBook_Common:Subclass()
function CollectionsBook:New(...)
    return ZO_JournalProgressBook_Common.New(self, ...)
end
do
    local filterData = 
    {
        SI_COLLECTIONS_BOOK_FILTER_SHOW_ALL,
        SI_COLLECTIONS_BOOK_FILTER_SHOW_LOCKED,
        SI_COLLECTIONS_BOOK_FILTER_SHOW_UNLOCKED,
    }
    function CollectionsBook:Initialize(control)
        ZO_JournalProgressBook_Common.Initialize(self, control)
        self.searchString = ""
        self.searchResults = {}
        self:InitializeSummary(control)
        self:InitializeFilters(filterData)
        self.control:SetHandler("OnUpdate", function() self.refreshGroups:UpdateRefreshGroups() end)
        local collectionsBookScene = ZO_Scene:New("collectionsBook", SCENE_MANAGER)
        collectionsBookScene:RegisterCallback("StateChange",
            function(oldState, newState)
                if newState == SCENE_SHOWN then
                    ZO_Scroll_ResetToTop(self.contentList)
                end
            end)
        self:UpdateCollection()
        SYSTEMS:RegisterKeyboardObject(ZO_COLLECTIONS_SYSTEM_NAME, self)
    end
end
function CollectionsBook:InitializeControls()
    ZO_JournalProgressBook_Common.InitializeControls(self)
    self.contentSearch = self.contents:GetNamedChild("Search")
    self.scrollbar = self.contentList:GetNamedChild("ScrollBar")
    self.noMatches = self.contents:GetNamedChild("NoMatchMessage")
end
function CollectionsBook:InitializeEvents()
    ZO_JournalProgressBook_Common.InitializeEvents(self)
    local SEARCH_DATA_STRIDE = 3
    local function UpdateSearchResults(...)
        ZO_ClearTable(self.searchResults)
        for i = 1, select("#", ...), SEARCH_DATA_STRIDE do
            local categoryIndex, subcategoryIndex, collectibleIndex = select(i, ...)
            if not self.searchResults[categoryIndex] then
                self.searchResults[categoryIndex] = {}
            end
            local effectiveSubCategory = subcategoryIndex or "root"
            if not self.searchResults[categoryIndex][effectiveSubCategory] then
                self.searchResults[categoryIndex][effectiveSubCategory] = {}
            end
            self.searchResults[categoryIndex][effectiveSubCategory][collectibleIndex] = true
        end
    end
    local function OnSearchResultsReady()
        self:UpdateCollection()
        if NonContiguousCount(self.searchResults) > 0 then
            local data = self.categoryTree:GetSelectedData()
            self:UpdateCategoryLabels(data, DONT_RETAIN_SCROLL_POSITION)
        end
    end
    self.control:RegisterForEvent(EVENT_COLLECTIBLES_SEARCH_RESULTS_READY, OnSearchResultsReady)
    COLLECTIONS_BOOK_SINGLETON:RegisterCallback("OnCollectibleUpdated", function(...) self:OnCollectibleUpdated(...) end)
    COLLECTIONS_BOOK_SINGLETON:RegisterCallback("OnCollectionUpdated", function(...) self:OnCollectionUpdated(...) end)
    self.refreshGroups = ZO_Refresh:New()
    self.refreshGroups:AddRefreshGroup("FullUpdate",
    {
        RefreshAll = function()
            self:UpdateCollection()
        end,
    })
    self.refreshGroups:AddRefreshGroup("CollectibleUpdated",
    {
        RefreshSingle = function(collectibleId)
            self:UpdateCollectible(collectibleId)
        end,
    })
end
function CollectionsBook:InitializeSummary(control)
    ZO_JournalProgressBook_Common.InitializeSummary(self, control, GetString(SI_COLLECTIONS_BOOK_OVERALL))
end
function CollectionsBook:InitializeStickerGrid(control)
    local function CreateSticker(objectPool)
        local collectibleSticker = ZO_ObjectPool_CreateControl("ZO_CollectableSticker", objectPool, self.contentListScrollChild)
        collectibleSticker.owner = self
        return Collectible:New(collectibleSticker, { 1, 1 }) --TODO: Implement stickers of varied dimensions in defs
    end
    
    local function ResetSticker(collectibleSticker)
        collectibleSticker:Reset()
    end
    self.collectibleStickerPool = ZO_ObjectPool:New(CreateSticker, ResetSticker)
end
--[[ Summary ]]--
-----------------
function CollectionsBook:ShowSummary(categoryContentList)
    ZO_JournalProgressBook_Common.ShowSummary(self)
end
function CollectionsBook:UpdateSummary()
    self.summaryStatusBarPool:ReleaseAllObjects()
    self:UpdateStatusBar(self.summaryTotal, nil, GetUnlockedCollectiblesCount(), GetTotalCollectiblesCount(), 0, nil, true)
        
    local numCategories = zo_min(self:GetNumCategories(), MAX_SUMMARY_CATEGORIES)
    local yOffset = SUMMARY_CATEGORY_PADDING
    for i = 1, numCategories do
        local name, _, numCollectibles, unlockedCollectibles, totalCollectibles = self:GetCategoryInfo(i)
        local statusBar = self.summaryStatusBarPool:AcquireObject()
        self:UpdateStatusBar(statusBar, zo_strformat(SI_COLLECTIBLE_NAME_FORMATTER, name), unlockedCollectibles, totalCollectibles, numCollectibles, DONT_HIDE_LOCKED, FORCE_HIDE_PROGRESS_TEXT)
        statusBar:ClearAnchors()
        if i % 2 == 0 then
            statusBar:SetAnchor(TOPRIGHT, self.summaryTotal, BOTTOMRIGHT, 0, yOffset)
            yOffset = yOffset + SUMMARY_CATEGORY_PADDING + SUMMARY_CATEGORY_BAR_HEIGHT
        else
            statusBar:SetAnchor(TOPLEFT, self.summaryTotal, BOTTOMLEFT, 0, yOffset)
        end
    end
end
--[[ Categories ]]--
--------------------
function CollectionsBook:GetNumCategories()
    return GetNumCollectibleCategories()
end
function CollectionsBook:GetCategoryInfo(categoryIndex)
    return GetCollectibleCategoryInfo(categoryIndex)
end
function CollectionsBook:GetCategoryIcons(categoryIndex)
    return GetCollectibleCategoryKeyboardIcons(categoryIndex)
end
function CollectionsBook:GetSubCategoryInfo(categoryIndex, i)
    return GetCollectibleSubCategoryInfo(categoryIndex, i)
end
--[[ Refresh ]]--
-----------------
function CollectionsBook:BuildCategories()
    --Per a design call, we're (temporarily?) removing progress indicators, so no summary blade
    self.categoryTree:Reset()
    self.nodeLookupData = {}
        
    if self.searchString == "" then
        for i = 1, self:GetNumCategories() do
            local name, numSubCategories, _, _, _, hidesUnearned = self:GetCategoryInfo(i)
            local normalIcon, pressedIcon, mouseoverIcon = self:GetCategoryIcons(i)
            self:AddTopLevelCategory(i, zo_strformat(SI_COLLECTIBLE_NAME_FORMATTER, name), numSubCategories, hidesUnearned, normalIcon, pressedIcon, mouseoverIcon)
        end
    else
        for categoryIndex, data in pairs(self.searchResults) do
            local name, numSubCategories, _, _, _, hidesUnearned = self:GetCategoryInfo(categoryIndex)
            local normalIcon, pressedIcon, mouseoverIcon = self:GetCategoryIcons(categoryIndex)
            self:AddTopLevelCategory(categoryIndex, zo_strformat(SI_COLLECTIBLE_NAME_FORMATTER, name), numSubCategories, hidesUnearned, normalIcon, pressedIcon, mouseoverIcon)
        end
    end
    self.categoryTree:Commit()
end
function CollectionsBook:AddTopLevelCategory(categoryIndex, name, numSubCategories, hidesUnearned, normalIcon, pressedIcon, mouseoverIcon)
    if self.searchString == "" then
        ZO_JournalProgressBook_Common.AddTopLevelCategory(self, categoryIndex, name, numSubCategories, hidesUnearned, normalIcon, pressedIcon, mouseoverIcon)
    else
        --Special search layout
        local tree = self.categoryTree
        local lookup = self.nodeLookupData
        local hasChildren = NonContiguousCount(self.searchResults[categoryIndex]) > 1 or self.searchResults[categoryIndex]["root"] == nil
        local nodeTemplate = hasChildren and "ZO_IconHeader" or "ZO_JournalChildlessCategory"
        local parent = self:AddCategory(lookup, tree, nodeTemplate, nil, categoryIndex, name, hidesUnearned, normalIcon, pressedIcon, mouseoverIcon)
        --We only want to add a general subcategory if we have any subcategories and we have any collectibles in the main category
        --Otherwise we'd have an emtpy general category, or only a general subcategory which can just be a childless instead
        if(hasChildren and self.searchResults[categoryIndex]["root"]) then
            local isFakedSubcategory = true
            local isSummary = false
            self:AddCategory(lookup, tree, "ZO_JournalSubCategory", parent, categoryIndex, GetString(SI_JOURNAL_PROGRESS_CATEGORY_GENERAL), hidesUnearned, normalIcon, pressedIcon, mouseoverIcon, isSummary, isFakedSubcategory)
        end
        
        for subcategoryIndex, data in pairs(self.searchResults[categoryIndex]) do
            if subcategoryIndex ~= "root" then
                local subCategoryName, subCategoryEntries, _, _, hidesUnearned = self:GetSubCategoryInfo(categoryIndex, subcategoryIndex)
                self:AddCategory(lookup, tree, "ZO_JournalSubCategory", parent, subcategoryIndex, zo_strformat(SI_COLLECTIBLE_NAME_FORMATTER, subCategoryName), nil, normalIcon, pressedIcon, mouseoverIcon)
            end
        end
        return parent
    end
end
function CollectionsBook:UpdateCategoryLabels(data, retainScrollPosition)
    ZO_JournalProgressBook_Common.UpdateCategoryLabels(self, data)
    --Per a design call, we're (temporarily?) removing progress indicators, so no category progress
    self.categoryProgress:SetHidden(true)
    self.categoryLabel:SetHidden(true)
    self:BuildContentList(data, retainScrollPosition)
end
    local function GetCategoryIndices(data, parentData)
        if not data.isFakedSubcategory and parentData then
            return parentData.categoryIndex, data.categoryIndex
        end
        
        return data.categoryIndex
    end
    function CollectionsBook:GetCollectibleIds(categoryIndex, subCategoryIndex, index, ...)
        if index >= 1 then
            if self.searchString ~= "" then
                local effectiveSubcategoryIndex = subCategoryIndex or "root"
                if not self.searchResults[categoryIndex][effectiveSubcategoryIndex][index] then
                    index = index - 1
                    return self:GetCollectibleIds(categoryIndex, subCategoryIndex, index, ...)
                end
            end
            local id = GetCollectibleId(categoryIndex, subCategoryIndex, index) 
            index = index - 1
            return self:GetCollectibleIds(categoryIndex, subCategoryIndex, index, id, ...)
        end
        return ...
    end
    function CollectionsBook:BuildContentList(data, retainScrollPosition)
        local parentData = data.parentData
        local categoryIndex, subCategoryIndex = GetCategoryIndices(data, parentData)
        local numCollectibles = self:GetCategoryInfoFromData(data, parentData)
        ZO_Notifications_ClearCollectibleNotificationsForCategory(categoryIndex, subCategoryIndex)
        local position = self.scrollbar:GetValue()
        self:LayoutCollection(self:GetCollectibleIds(categoryIndex, subCategoryIndex, numCollectibles))
        
        if retainScrollPosition then
            self.scrollbar:SetValue(position)
        end
    end
do
    local function ShouldAddCollectible(filterType, id)
        local unlocked, _, _, _, _, isPlaceholder = select(5 , GetCollectibleInfo(id))
        if not isPlaceholder then
            if filterType == SI_COLLECTIONS_BOOK_FILTER_SHOW_ALL then
                return true 
            end
            if(unlocked) then
                return filterType == SI_COLLECTIONS_BOOK_FILTER_SHOW_UNLOCKED
            else
                return filterType == SI_COLLECTIONS_BOOK_FILTER_SHOW_LOCKED
            end
        else
            return false
        end
    end
    function CollectionsBook:LayoutCollection(...)
        self.collectibleStickerPool:ReleaseAllObjects()
        self.collectibles = {}
        ZO_Scroll_ResetToTop(self.contentList)
        local numStickersCreated = 0
        local previous
        for i=1, select("#", ...) do
            local id = select(i, ...)
            if(ShouldAddCollectible(self.categoryFilter.filterType, id)) then
                local collectible = self.collectibleStickerPool:AcquireObject()
                self.collectibles[id] = collectible
                collectible:Show(id, previous)
                previous = collectible
                numStickersCreated = numStickersCreated + 1
            end
        end
        --Fill out the rest of the grid
        local minRows = zo_floor(self.contentList:GetHeight() / (COLLECTIBLE_STICKER_SINGLE_HEIGHT + COLLECTIBLE_PADDING))
        local minStickers = minRows * COLLECTIBLE_STICKER_ROW_STRIDE
        if numStickersCreated > minStickers then
            --Round out the last row
            local remainder = numStickersCreated % COLLECTIBLE_STICKER_ROW_STRIDE
            if remainder > 0 then
                extra = COLLECTIBLE_STICKER_ROW_STRIDE - remainder
                minStickers = numStickersCreated + extra
            end
        end
        for i = numStickersCreated + 1, minStickers do
            local collectible = self.collectibleStickerPool:AcquireObject()
            collectible:ShowBlank(previous)
            previous = collectible
        end
    end
end
function CollectionsBook:OnCollectionUpdated()
end
function CollectionsBook:UpdateCollectionLater()
    self.refreshGroups:RefreshAll("FullUpdate")
end
function CollectionsBook:UpdateCollection()
    self.collectibleStickerPool:ReleaseAllObjects()
    self.collectibles = {}
    if self.searchString == "" or NonContiguousCount(self.searchResults) > 0 then
        self.categoryInset:SetHidden(false)
        self.noMatches:SetHidden(true)
        self:UpdateSummary()
    else
        self.categoryInset:SetHidden(true)
        self.noMatches:SetHidden(false)
        self.contentList:SetHidden(true)
        self.summaryInset:SetHidden(true)
    end
end
function CollectionsBook:OnCollectibleUpdated(collectibleId)
    self.refreshGroups:RefreshSingle("CollectibleUpdated", collectibleId)
end
function CollectionsBook:UpdateCollectible(collectibleId)
    if self:IsSummaryOpen() then
        self:UpdateSummary()
    else
        local category, subcategory = GetCategoryInfoFromCollectibleId(collectibleId)
        local categoryNode = self:GetLookupNodeByCategory(category, subcategory)
        if categoryNode then
            local data = self.categoryTree:GetSelectedData()
            if data.node == categoryNode then
                self:UpdateCategoryLabels(data, RETAIN_SCROLL_POSITION)
            end
        end
    end
end
function CollectionsBook:BrowseToCollectible(collectibleId, categoryIndex, subcategoryIndex)
    --Select the category or subcategory of the collectible
    local categoryNode = self:GetLookupNodeByCategory(categoryIndex, subcategoryIndex)
    if categoryNode then
        self.categoryTree:SelectNode(categoryNode)
    end
    --TODO: Scroll the collectibles list to show the collectible
    SCENE_MANAGER:Show("collectionsBook")
end
--[[Search]]--
--------------
function CollectionsBook:SearchStart(searchString)
    self.searchString = searchString
    StartCollectibleSearch(searchString)
end
--[[Global functions]]--
------------------------
    COLLECTIONS_BOOK = CollectionsBook:New(control)
end
function ZO_CollectionsBook_BeginSearch(editBox)
    editBox:TakeFocus()
end
function ZO_CollectionsBook_EndSearch(editBox)
    editBox:LoseFocus()
end
    COLLECTIONS_BOOK:SearchStart(editBox:GetText())
end
    COLLECTIONS_BOOK:SearchStart(editBox:GetText())
    editBox:LoseFocus()
end