Back to Home

ESO Lua File v101050

libraries/zo_pagenavigation/zo_pagenavigation.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
-----------------
-- ZO_PageNavigationIndicator
-----------------
-- TODO: Consider supporting disabled indicators
ZO_PageNavigationIndicator = ZO_InitializingObject:Subclass()
function ZO_PageNavigationIndicator:Initialize(control, parent)
    self.control = control
    control.owner = self
    self.parent = parent
    self.numberLabel = control:GetNamedChild("Number")
    self.iconControl = control:GetNamedChild("Icon")
    self.selectedTexture = control:GetNamedChild("Selected")
    self.highlightedTexture = control:GetNamedChild("Highlighted")
end
function ZO_PageNavigationIndicator:GetControl()
    return self.control
end
function ZO_PageNavigationIndicator:GetNumberLabelControl()
    return self.numberLabel
end
function ZO_PageNavigationIndicator:GetIconTextureControl()
    return self.iconControl
end
function ZO_PageNavigationIndicator:GetSelectedTextureControl()
    return self.selectedTexture
end
function ZO_PageNavigationIndicator:GetHighlightedTextureControl()
    return self.highlightedTexture
end
function ZO_PageNavigationIndicator:GetData()
    return self.data
end
function ZO_PageNavigationIndicator:GetIconTexture()
    return self.data.icon
end
function ZO_PageNavigationIndicator:GetFocusColor()
    return self.data.focusColor and self.data.focusColor or ZO_HIGHLIGHT_TEXT
end
function ZO_PageNavigationIndicator:GetNormalColor()
    return self.data.color and self.data.color or ZO_NORMAL_TEXT
end
function ZO_PageNavigationIndicator:GetSelectedColor()
    return self.data.selectedColor and self.data.selectedColor or ZO_SELECTED_TEXT
end
function ZO_PageNavigationIndicator:GetColor()
    if self:IsSelected() then
        return self:GetSelectedColor()
    end
    if self:IsFocused() then
        return self:GetFocusColor()
    end
    return self:GetNormalColor()
end
function ZO_PageNavigationIndicator:GetDefaultFont()
    return self.parent:GetDefaultIndicatorFont()
end
function ZO_PageNavigationIndicator:GetFont()
    return self.data.font or self:GetDefaultFont()
end
function ZO_PageNavigationIndicator:GetHighlightedTexture()
    return self.data.highlightedTexture
end
function ZO_PageNavigationIndicator:GetSelectedTexture()
    return self.data.selectedTexture
end
-- indicatorData - a table of various options to modify the indicator
-- icon = texture to show instead of page number
-- color = the color of the indicator text when not selected
-- selectedColor = the color of the indicator text when selected
-- TODO: support options like selectedIcon, mouseOverIcon, iconColor, iconSelectedColor, etc.
function ZO_PageNavigationIndicator:SetData(pageNumber, indicatorData)
    self.pageNumber = pageNumber
    self.data = indicatorData or {}
    self:Refresh()
end
function ZO_PageNavigationIndicator:IsHidden()
    return self.control:IsHidden()
end
function ZO_PageNavigationIndicator:SetHidden(isHidden)
    self.control:SetHidden(isHidden)
end
function ZO_PageNavigationIndicator:GetPageNumber()
    return self.pageNumber
end
function ZO_PageNavigationIndicator:GetParent()
    return self.parent
end
function ZO_PageNavigationIndicator:IsFocused()
    return self.pageNumber == self.parent:GetFocusPage()
end
function ZO_PageNavigationIndicator:IsHighlighted()
    return self.parent:IsPageHighlighted(self.pageNumber)
end
function ZO_PageNavigationIndicator:IsSelected()
    return self.pageNumber == self.parent:GetCurrentPage()
end
function ZO_PageNavigationIndicator:Select()
    self.parent:SelectPage(self.pageNumber)
end
function ZO_PageNavigationIndicator:Refresh()
    local iconTexture = self:GetIconTexture()
    local hasIcon = iconTexture ~= nil
    self.iconControl:SetHidden(not hasIcon)
    self.numberLabel:SetHidden(hasIcon)
    local color = self:GetColor()
    if hasIcon then
        self.iconControl:SetTexture(iconTexture)
        self.iconControl:SetColor(color:UnpackRGBA())
    else
        self.numberLabel:SetFont(self:GetFont())
        self.numberLabel:SetColor(color:UnpackRGBA())
        self.numberLabel:SetText(self:GetPageNumber())
    end
    local selectedTexture = self:GetSelectedTexture()
    if selectedTexture and self:IsSelected() then
        self.selectedTexture:SetTexture(selectedTexture)
        self.selectedTexture:SetHidden(false)
    else
        self.selectedTexture:SetHidden(true)
    end
    local highlightedTexture = self:GetHighlightedTexture()
    if highlightedTexture and self:IsHighlighted() then
        self.highlightedTexture:SetTexture(highlightedTexture)
        self.highlightedTexture:SetHidden(false)
    else
        self.highlightedTexture:SetHidden(true)
    end
end
function ZO_PageNavigationIndicator:Reset()
    self:SetHidden(true)
    self.data = nil
    self.pageNumber = nil
    self.iconControl:SetTexture(nil)
    self.numberLabel:SetText("")
end
function ZO_PageNavigationIndicator:OnClicked()
    self:Select()
end
function ZO_PageNavigationIndicator:OnMouseEnter()
    self.parent:OnMouseEnter(self)
end
function ZO_PageNavigationIndicator:OnMouseExit()
    self.parent:OnMouseExit(self)
end
-----------------
-- ZO_PageNavigation
-----------------
ZO_PAGE_NAVIGATION_NEXT_PAGE = 1
ZO_PAGE_NAVIGATION_PREVIOUS_PAGE = -1
ZO_PageNavigation = ZO_InitializingCallbackObject:Subclass()
function ZO_PageNavigation:Initialize(control)
    self.control = control
    control.owner = self
    self.nextPageControl = self.control:GetNamedChild("NextPage")
    self.nextPageControl.owner = self
    self.previousPageControl = self.control:GetNamedChild("PreviousPage")
    self.previousPageControl.owner = self
    self.highlightedPages = {}
    local function CreatePageIndicator(objectPool)
        local pageIndicatorControl = ZO_ObjectPool_CreateNamedControl("$(parent)Indicator", "ZO_PageNavigationIndicator", objectPool, control)
        return ZO_PageNavigationIndicator:New(pageIndicatorControl, self)
    end
    self.pageIndicatorPool = ZO_ObjectPool:New(CreatePageIndicator, ZO_ObjectPool_DefaultResetObject)
    self.pageIndicatorPool:SetCustomAcquireBehavior(function(pageIndicator)
        pageIndicator:SetHidden(false)
    end)
    self.allowWrapping = false
    self.startingPageNumber = 1
    self.currentPage = nil
    self.focusPage = nil
    self.indicatorInfos = {}
    self.indicatorSpacing = 5
    self.pageChangeSound = SOUNDS.DEFAULT_CLICK
    self.pageIndicators = {}
    self.hidePageIndicators = false
    self.showTooltip = true
end
function ZO_PageNavigation:GetAllowWrapping()
    return self.allowWrapping
end
function ZO_PageNavigation:SetAllowWrapping(allowWrapping)
    self.allowWrapping = allowWrapping
end
function ZO_PageNavigation:GetIndicatorSpacing()
    return self.indicatorSpacing
end
function ZO_PageNavigation:SetIndicatorSpacing(spacing)
    self.indicatorSpacing = spacing
end
function ZO_PageNavigation:GetDefaultIndicatorFont(font)
    return self.defaultFont
end
function ZO_PageNavigation:SetDefaultIndicatorFont(font)
    if font == self.defaultFont then
        return
    end
    self.defaultFont = font
end
function ZO_PageNavigation:SetHidePageIndicators(hide)
    if self.hidePageIndicators == hide then
        return
    end
    self.hidePageIndicators = hide
    self.pageIndicatorPool:ReleaseAllObjects()
    self:Commit()
end
function ZO_PageNavigation:GetShowTooltips()
    return self.showTooltip
end
function ZO_PageNavigation:SetShowTooltips(show)
    self.showTooltip = show
end
function ZO_PageNavigation:SetStartingPageNumber(pageNumber)
    if not internalassert(#self.indicatorInfos == 0, "ZO_PageNavigation must be cleared before a min page number can be set") then
        return
    end
    self.startingPageNumber = pageNumber
end
function ZO_PageNavigation:RefreshPageIndicators()
    if self.hidePageIndicators then
        return
    end
    if not internalassert(self.defaultFont, "ZO_PageNavigation requires a platform-specific DefaultIndicatorFont.") then
        return
    end
    for _, pageIndicator in pairs(self.pageIndicators) do
        pageIndicator:Refresh()
    end
end
function ZO_PageNavigation:Clear()
    self.currentPage = nil
    self.focusPage = nil
    self.numPages = nil
    self.pageIndicatorPool:ReleaseAllObjects()
    ZO_ClearTable(self.pageIndicators)
    ZO_ClearNumericallyIndexedTable(self.indicatorInfos)
end
-- Adds a single page.
function ZO_PageNavigation:AddPage(indicatorInfo)
    if not indicatorInfo then
        indicatorInfo = {}
    end
    table.insert(self.indicatorInfos, indicatorInfo)
end
-- Adds 'numPages' additional pages.
-- Note that the pages that are added will share the same indicatorInfo instance.
function ZO_PageNavigation:AddPages(numPages, indicatorInfo)
    if not indicatorInfo then
        indicatorInfo = {}
    end
    for page = 1, numPages do
        self:AddPage(indicatorInfo)
    end
end
function ZO_PageNavigation:Commit(selectedPage)
    self.numPages = #self.indicatorInfos
    local previousControl = nil
    local pageNumber = self.startingPageNumber
    if not self.hidePageIndicators then
        for indicatorIndex, indicatorInfo in ipairs(self.indicatorInfos) do
            local pageIndicator = self.pageIndicatorPool:AcquireObject()
            pageIndicator:SetData(pageNumber, indicatorInfo)
            self.pageIndicators[pageNumber] = pageIndicator
            local pageIndicatorControl = pageIndicator:GetControl()
            if pageNumber == self.startingPageNumber then
                pageIndicatorControl:SetAnchor(TOPLEFT)
            else
                pageIndicatorControl:SetAnchor(TOPLEFT, previousControl, TOPRIGHT, self.indicatorSpacing, 0)
            end
            previousControl = pageIndicatorControl
            pageNumber = pageNumber + 1
        end
    end
    if selectedPage or not self.currentPage then
        local pageToSelect = selectedPage or self.startingPageNumber
        local SUPPRESS_SOUND = true
        self:SelectPage(pageToSelect, SUPPRESS_SOUND)
    end
end
function ZO_PageNavigation:UpdateNavigationButtons()
    local numPages = self:GetNumPages()
    local showNavigation = numPages and numPages > 1
    self.nextPageControl:SetHidden(not showNavigation)
    self.previousPageControl:SetHidden(not showNavigation)
    if showNavigation then
        local currentPage = self:GetCurrentPage()
        local canMoveNext = false
        local canMovePrevious = false
        if currentPage then
            canMoveNext = self.allowWrapping or currentPage < numPages
            canMovePrevious = self.allowWrapping or currentPage > self.startingPageNumber
        end
        self.nextPageControl:SetEnabled(canMoveNext)
        self.previousPageControl:SetEnabled(canMovePrevious)
    end
end
function ZO_PageNavigation:IsHidden()
    return self.control:IsHidden()
end
function ZO_PageNavigation:SetHidden(isHidden)
    self.control:SetHidden(isHidden)
end
function ZO_PageNavigation:IsVisible()
    return not self:IsHidden()
end
function ZO_PageNavigation:GetNumPages()
    return self.numPages or 0
end
function ZO_PageNavigation:GetHighestPageNumber()
    return self:GetNumPages() + self.startingPageNumber - 1
end
function ZO_PageNavigation:GetPageChangeSound()
    return self.pageChangeSound
end
function ZO_PageNavigation:GetPageChangeNextSound()
    return self.pageChangeNextSound
end
function ZO_PageNavigation:GetPageChangePreviousSound()
    return self.pageChangePreviousSound
end
function ZO_PageNavigation:SetPageChangeSound(sound)
    self.pageChangeSound = sound
end
function ZO_PageNavigation:SetPageChangeNextSound(sound)
    self.pageChangeNextSound = sound
end
function ZO_PageNavigation:SetPageChangePreviousSound(sound)
    self.pageChangePreviousSound = sound
end
function ZO_PageNavigation:GetCurrentPage()
    return self.currentPage
end
function ZO_PageNavigation:GetFocusPage()
    return self.focusPage
end
function ZO_PageNavigation:ClearHighlightedPages()
    ZO_ClearTable(self.highlightedPages)
end
function ZO_PageNavigation:IsPageHighlighted(pageNumber)
    return self.highlightedPages[pageNumber]
end
function ZO_PageNavigation:SetHighlightedPage(pageNumber, isHighlighted)
    self.highlightedPages[pageNumber] = isHighlighted
end
function ZO_PageNavigation:ChangePage(direction)
    local currentPage = self:GetCurrentPage()
    local pageToSelect = currentPage + direction
    if self.allowWrapping then
        local highestPageNumber = self:GetHighestPageNumber()
        if pageToSelect < self.startingPageNumber then
            pageToSelect = highestPageNumber
        elseif pageToSelect > highestPageNumber then
            pageToSelect = self.startingPageNumber
        end
    elseif pageToSelect < self.startingPageNumber then
        pageToSelect = self.startingPageNumber
    elseif pageToSelect > self:GetHighestPageNumber() then
        pageToSelect = self:GetHighestPageNumber()
    end
    if pageToSelect ~= currentPage then
        local DONT_SUPPRESS_SOUND = false
        self:SelectPage(pageToSelect, DONT_SUPPRESS_SOUND, direction)
    end
end
-- Sets the current page number.
function ZO_PageNavigation:SetCurrentPage(pageNumber)
    local newPageNumber = zo_clamp(pageNumber or self.startingPageNumber, self.startingPageNumber, self:GetHighestPageNumber())
    -- Order matters
    self.currentPage = newPageNumber
    return self.currentPage
end
-- Sets the current page number, plays the associated sound (if any) and fires the PageChanged callback.
function ZO_PageNavigation:SelectPage(pageNumber, suppressSound, direction)
    local previousPage = self.currentPage or self.startingPageNumber or 1
    pageNumber = self:SetCurrentPage(pageNumber)
    if direction == nil then
        -- Infer the direction of the page change.
        if previousPage == pageNumber then
            direction = 0
        else
            direction = previousPage < pageNumber and 1 or -1
        end
    end
    if not suppressSound then
        if direction < 0 then
            PlaySound(self.pageChangePreviousSound or self.pageChangeSound)
        elseif direction > 0 then
            PlaySound(self.pageChangeNextSound or self.pageChangeSound)
        end
    end
    self:FireCallbacks("PageChanged", pageNumber, direction)
end
function ZO_PageNavigation:GetPreviousPageKeybindDescriptor()
    if self.previousPageControl.GetKeybindButtonDescriptorReference then
        return self.previousPageControl:GetKeybindButtonDescriptorReference()
    end
    return nil
end
function ZO_PageNavigation:GetNextPageKeybindDescriptor()
    if self.nextPageControl.GetKeybindButtonDescriptorReference then
        return self.nextPageControl:GetKeybindButtonDescriptorReference()
    end
    return nil
end
function ZO_PageNavigation:OnMouseEnter(pageIndicator)
    self.focusPage = pageIndicator:GetPageNumber()
end
function ZO_PageNavigation:OnMouseExit(pageIndicator)
    self.focusPage = nil
end
--[[ Xml Functions ]]--
function ZO_PageNavigation.PreviousPage_OnMouseClicked(control)
    control.owner:ChangePage(ZO_PAGE_NAVIGATION_PREVIOUS_PAGE)
end
function ZO_PageNavigation.PreviousPage_OnMouseEnter(control)
    if control.owner:GetShowTooltips() then
        InitializeTooltip(InformationTooltip, control, BOTTOM, 0, -10, TOP)
        SetTooltipText(InformationTooltip, GetString(SI_PAGE_NAVIGATION_PREVIOUS_PAGE_LABEL))
    end
end
function ZO_PageNavigation.PreviousPage_OnMouseExit(control)
    ClearTooltip(InformationTooltip)
end
function ZO_PageNavigation.NextPage_OnMouseClicked(control)
    control.owner:ChangePage(ZO_PAGE_NAVIGATION_NEXT_PAGE)
end
function ZO_PageNavigation.NextPage_OnMouseEnter(control)
    if control.owner:GetShowTooltips() then
        InitializeTooltip(InformationTooltip, control, BOTTOM, 0, -10, TOP)
        SetTooltipText(InformationTooltip, GetString(SI_PAGE_NAVIGATION_NEXT_PAGE_LABEL))
    end
end
function ZO_PageNavigation.NextPage_OnMouseExit(control)
    ClearTooltip(InformationTooltip)
end
function ZO_PageNavigationIndicator.OnMouseUp(control, upInside)
    if upInside then
        control.owner:OnClicked()
    end
end
function ZO_PageNavigation.InitializePreviousPageKeybindControl(control)
    local descriptor = {
        name = GetString(SI_PAGE_NAVIGATION_PREVIOUS_PAGE_ACTION),
        keybind = "UI_SHORTCUT_LEFT_SHOULDER",
        ethereal = true,
        callback = function()
            control.owner:ChangePage(ZO_PAGE_NAVIGATION_PREVIOUS_PAGE)
        end
    }
end
function ZO_PageNavigation.InitializeNextPageKeybindControl(control)
    local descriptor = {
        name = GetString(SI_PAGE_NAVIGATION_NEXT_PAGE_ACTION),
        keybind = "UI_SHORTCUT_RIGHT_SHOULDER",
        ethereal = true,
        callback = function()
            control.owner:ChangePage(ZO_PAGE_NAVIGATION_NEXT_PAGE)
        end
    }
end