Back to Home

ESO Lua File v100031

internalingame/market/keyboard/marketclasses_keyboard.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
ZO_MARKET_PRODUCT_WIDTH = 302
ZO_MARKET_PRODUCT_COLUMN_PADDING = 10
ZO_MARKET_PRODUCT_BUNDLE_WIDTH = 2 * ZO_MARKET_PRODUCT_WIDTH + ZO_MARKET_PRODUCT_COLUMN_PADDING
ZO_MARKET_PRODUCT_HEIGHT = 200
ZO_MARKET_PRODUCT_INSET = 20
ZO_MARKET_DEFAULT_BACKGROUND_COLOR = ZO_ColorDef:New(1, 1, 1)
ZO_MARKET_MOUSE_OVER_BACKGROUND_COLOR = ZO_ColorDef:New(.8, .8, .8)
ZO_MARKET_PURCHASED_BACKGROUND_COLOR = ZO_ColorDef:New(.6, .6, .6)
--
--[[ Keyboard MarketProduct ]]--
--
local MarketProduct_Keyboard = ZO_MarketProductBase:Subclass()
function MarketProduct_Keyboard:New(...)
    return ZO_MarketProductBase.New(self, ...)
end
do
    local TITLE_FONTS =
    {
        {
            font = "ZoFontHeader3",
            lineLimit = 3,
        },
        {
            font = "ZoFontHeader2",
            lineLimit = 4,
        },
        {
            font = "ZoFontHeader",
            lineLimit = 4,
        },
        {
            font = "ZoFontWinH5",
            lineLimit = 5,
        },
    }
    function MarketProduct_Keyboard:Initialize(control, iconPool, owner, ...)
        ZO_MarketProductBase.Initialize(self, control, ...)
        self.control.marketProduct = self
        self.owner = owner
        self.iconPool = ZO_MetaPool:New(iconPool)
        self.activeMarketProductIcon = nil
        self:SetTextCalloutYOffset(-7)
        ZO_FontAdjustingWrapLabel_OnInitialized(self.control.title, TITLE_FONTS, TEXT_WRAP_MODE_ELLIPSIS)
    end
end
function MarketProduct_Keyboard:LayoutBackground()
    ZO_MarketProductBase.LayoutBackground(self)
    if self.hasBackground then
        local backgroundDesaturation = self:GetBackgroundDesaturation(self:IsPurchaseLocked())
        self.control.background:SetDesaturation(backgroundDesaturation)
        local isAvailable = not self:IsPurchaseLocked()
        local backgroundColor = isAvailable and ZO_MARKET_DEFAULT_BACKGROUND_COLOR or ZO_MARKET_PURCHASED_BACKGROUND_COLOR
        self.control.background:SetColor(backgroundColor:UnpackRGB())
    end
end
function MarketProduct_Keyboard:SetupCalloutsDisplay(discountPercent)
    ZO_MarketProductBase.SetupCalloutsDisplay(self, discountPercent)
    local textCalloutBackgroundColor
    local textCalloutTextColor
    if self:IsLimitedTimeProduct() then
        textCalloutBackgroundColor = ZO_BLACK
        textCalloutTextColor = ZO_MARKET_PRODUCT_ON_SALE_COLOR
    elseif self:IsOnSale() then
        textCalloutBackgroundColor = ZO_MARKET_PRODUCT_ON_SALE_COLOR
        textCalloutTextColor = ZO_SELECTED_TEXT
    elseif self.productData:IsNew() then
        textCalloutBackgroundColor = ZO_MARKET_PRODUCT_NEW_COLOR
        textCalloutTextColor = ZO_SELECTED_TEXT
    end
    self:ApplyCalloutColor(textCalloutBackgroundColor, textCalloutTextColor)
end
function MarketProduct_Keyboard:Purchase()
    self.owner:PurchaseMarketProduct(self.productData)
end
function MarketProduct_Keyboard:Gift()
    self.owner:GiftMarketProduct(self.productData)
end
function MarketProduct_Keyboard:Reset()
    ZO_MarketProductBase.Reset(self)
    self.iconPool:ReleaseAllObjects()
    self.parentMarketProductId = nil
    self.control.giftButton:SetHidden(true)
end
function MarketProduct_Keyboard:Refresh()
    -- need to release the icons before we refresh, because Show() will grab a new icon
    self.iconPool:ReleaseAllObjects()
    self.activeMarketProductIcon = nil
    -- make sure to refresh the mouse over state for the tile as well
    local mouseOverControl = WINDOW_MANAGER:GetMouseOverControl()
    local isMousedOver = false
    if mouseOverControl and mouseOverControl == self.control then
        isMousedOver = true
    end
    local ANIMATE_INSTANTLY = true
    if isMousedOver then
        self:OnMouseExit(ANIMATE_INSTANTLY)
    end
    ZO_MarketProductBase.Refresh(self)
    if isMousedOver then
        self:OnMouseEnter(ANIMATE_INSTANTLY)
    end
end
function MarketProduct_Keyboard:RefreshAsChild()
    -- need to release the icons before we refresh, because Show() will grab a new icon
    self.iconPool:ReleaseAllObjects()
    self.activeMarketProductIcon = nil
    -- make sure to refresh the mouse over state for the tile as well
    local mouseOverControl = WINDOW_MANAGER:GetMouseOverControl()
    local isMousedOver = false
    if mouseOverControl and mouseOverControl == self.control then
        isMousedOver = true
    end
    local ANIMATE_INSTANTLY = true
    if isMousedOver then
        self:OnMouseExit(ANIMATE_INSTANTLY)
    end
    self:ShowAsChild(self.productData, self.parentMarketProductId)
    if isMousedOver then
        self:OnMouseEnter(ANIMATE_INSTANTLY)
    end
end
function MarketProduct_Keyboard:InitializeMarketProductIcon(marketProductId, purchased)
    local marketProductIcon = self.iconPool:AcquireObject()
    marketProductIcon:Show(self, marketProductId, purchased)
    return marketProductIcon
end
function MarketProduct_Keyboard:EndPreview()
    self.owner:EndCurrentPreview()
end
function MarketProduct_Keyboard:HasActiveIcon()
    return self.activeMarketProductIcon ~= nil
end
-- MarketProduct mouse functions
function MarketProduct_Keyboard:OnIconMouseEnter(activeIcon)
    self.activeMarketProductIcon = activeIcon
    -- call the normal on mouse enter because entering the icon
    -- means the mouse has already left the MarketProduct_Keyboard
    self:OnMouseEnter()
end
do
    local g_fadeInAnimationProvider = ZO_ReversibleAnimationProvider:New("ZO_KeyboardMarketProductFadeInAnimation")
    local g_fadeOutAnimationProvider = ZO_ReversibleAnimationProvider:New("ZO_KeyboardMarketProductFadeOutAnimation")
    function MarketProduct_Keyboard:OnMouseEnter(animateInstantly)
        if not self:IsPurchaseLocked() then
            -- only show the highlight if the product is purchasable
            self:SetHighlightHidden(false)
        end
        if self.hasBackground and not self:IsPurchaseLocked() then
            self.control.background:SetColor(ZO_MARKET_MOUSE_OVER_BACKGROUND_COLOR:UnpackRGB())
        end
        -- layout tooltip
        InitializeTooltip(ItemTooltip, self.control, RIGHT, -15, 0, LEFT)
        if self:HasActiveIcon() then
            local marketProductId = self.activeMarketProductIcon:GetMarketProductId()
            ItemTooltip:SetMarketProduct(marketProductId)
        else
            ItemTooltip:SetMarketProductListing(self:GetId(), self:GetPresentationIndex())
        end
        if self:IsGiftable() then
            if not self.control.purchaseLabelControl:IsHidden() then
                g_fadeOutAnimationProvider:PlayForward(self.control.purchaseLabelControl, animateInstantly)
            end
            if not self.control.esoPlusDealLabelControl:IsHidden() then
                g_fadeOutAnimationProvider:PlayForward(self.control.esoPlusDealLabelControl, animateInstantly)
            end
            if not self.control.bundledProductsItemsLabel:IsHidden() then
                g_fadeOutAnimationProvider:PlayForward(self.control.bundledProductsItemsLabel, animateInstantly)
            end
            if not self.control.numBundledProductsLabel:IsHidden() then
                g_fadeOutAnimationProvider:PlayForward(self.control.numBundledProductsLabel, animateInstantly)
            end
            self.control.giftButton:SetHidden(false)
            g_fadeInAnimationProvider:PlayForward(self.control.giftButton, animateInstantly)
        end
        self.owner:MarketProductSelected(self)
    end
    function MarketProduct_Keyboard:OnMouseExit(animateInstantly)
        self.activeMarketProductIcon = nil
        -- always hide the highlight on mouse exit
        -- sometimes market products are set to show
        -- their highlight outside of mouse behavior
        self:SetHighlightHidden(true)
        if self.hasBackground and not self:IsPurchaseLocked() then
            self.control.background:SetColor(ZO_MARKET_DEFAULT_BACKGROUND_COLOR:UnpackRGB())
        end
        self:ClearTooltip()
        -- it's possible in some situations that the mouse exit event processes after we have
        -- hidden the control and reset the class which would cause self:IsGiftable() to error
        -- so we'll try to do all the mouse exit things we can but skip this part
        if not self.control:IsHidden() then
            if self:IsGiftable() then
                local shouldShowPurchaseLabel = not self:CanBePurchased()
                if shouldShowPurchaseLabel then
                    g_fadeOutAnimationProvider:PlayBackward(self.control.purchaseLabelControl, animateInstantly)
                elseif self:HasEsoPlusCost() then
                    g_fadeOutAnimationProvider:PlayBackward(self.control.esoPlusDealLabelControl, animateInstantly)
                end
                if self:IsBundle() then
                    g_fadeOutAnimationProvider:PlayBackward(self.control.bundledProductsItemsLabel, animateInstantly)
                end
                local hideBundledProductsLabel = not self:IsBundle() or self.productData:GetNumBundledProducts() <= 1
                if not hideBundledProductsLabel then
                    g_fadeOutAnimationProvider:PlayBackward(self.control.numBundledProductsLabel, animateInstantly)
                end
                g_fadeInAnimationProvider:PlayBackward(self.control.giftButton, animateInstantly)
            end
        end
        self.owner:MarketProductSelected(nil)
    end
end
function MarketProduct_Keyboard:OnClicked(button)
    if button == MOUSE_BUTTON_INDEX_LEFT then
        -- We don't use CanPreviewMarketProductPreviewType here because we don't want clicking on bundles to actually preview, lest we wouldn't be able to double click
        if self.owner:IsReadyToPreview() then
            self:Preview()
        end
    elseif button == MOUSE_BUTTON_INDEX_RIGHT then
        ClearMenu()
        if self:HasValidPresentationIndex() and self:CanBePurchased() then
            local function PurchaseCallback() self:Purchase() end
            if self:IsBundle() then
                AddMenuItem(GetString(SI_MARKET_ACTION_PURCHASE_BUNDLE), PurchaseCallback)
            else
                AddMenuItem(GetString(SI_MARKET_ACTION_PURCHASE), PurchaseCallback)
            end
        end
        if self:HasValidPresentationIndex() and self:IsGiftable() then
            local function GiftCallback() self:Gift() end
            if self:IsBundle() then
                AddMenuItem(GetString(SI_MARKET_GIFT_BUNDLE_KEYBIND_TEXT), GiftCallback)
            else
                AddMenuItem(GetString(SI_MARKET_GIFT_KEYBIND_TEXT), GiftCallback)
            end
        end
        local previewType = self:GetMarketProductPreviewType()
        local canPreview = self.owner:CanPreviewMarketProductPreviewType(previewType)
        if canPreview then
            local function PreviewFunction() self:Preview() end
            if previewType == ZO_MARKET_PREVIEW_TYPE_BUNDLE or previewType == ZO_MARKET_PREVIEW_TYPE_BUNDLE_HIDES_CHILDREN then
                AddMenuItem(GetString(SI_MARKET_BUNDLE_DETAILS_KEYBIND_TEXT), PreviewFunction)
            else -- ZO_MARKET_PREVIEW_TYPE_CROWN_CRATE, ZO_MARKET_PREVIEW_TYPE_PREVIEWABLE
                AddMenuItem(GetString(SI_MARKET_ACTION_PREVIEW), PreviewFunction)
            end
        elseif self:IsActivelyPreviewing() then
            AddMenuItem(GetString(SI_MARKET_ACTION_END_PREVIEW), function() self:EndPreview() end)
        end
        ShowMenu(self.control)
    end
end
function MarketProduct_Keyboard:OnDoubleClicked(button)
    if button == MOUSE_BUTTON_INDEX_LEFT then
        if self:CanBePurchased() and self:HasValidPresentationIndex() then
            self:Purchase()
        end
    end
end
function MarketProduct_Keyboard:ClearTooltip()
    ClearTooltip(ItemTooltip)
end
-- override of ZO_MarketProductBase:GetBackground()
function MarketProduct_Keyboard:GetBackground()
end
-- override of ZO_MarketProductBase:GetEsoPlusIcon()
function MarketProduct_Keyboard:GetEsoPlusIcon()
    return zo_iconFormatInheritColor("EsoUI/Art/Market/Keyboard/ESOPlus_Chalice_WHITE_32.dds", 32, 32)
end
function MarketProduct_Keyboard:IsActivelyPreviewing()
    -- To Be Overridden
end
function MarketProduct_Keyboard:GetMarketProductDisplayState()
    if self.parentMarketProductId then
        local parentDisplayState = ZO_GetMarketProductDisplayState(self.parentMarketProductId)
        if parentDisplayState == MARKET_PRODUCT_DISPLAY_STATE_PURCHASED then
            return parentDisplayState
        end
    end
    return ZO_MarketProductBase.GetMarketProductDisplayState(self)
end
function MarketProduct_Keyboard:ShowAsChild(marketProductData, parentMarketProductId)
    self.parentMarketProductId = parentMarketProductId
    self:Show(marketProductData)
    local allCollectiblesOwned = self:AreAllCollectiblesUnlocked()
    self.control.purchaseLabelControl:SetHidden(not allCollectiblesOwned)
    if allCollectiblesOwned then
        self.control.purchaseLabelControl:SetText(GetString("SI_COLLECTIBLEUNLOCKSTATE", COLLECTIBLE_UNLOCK_STATE_UNLOCKED_OWNED))
    end
    -- hide all the price info
    self.control.cost:SetHidden(true)
    self.control.previousCost:SetHidden(true)
    self.control.textCallout:SetHidden(true)
end
local ROW_PADDING = 5
local COLUMN_PADDING = 5
local NUM_ROWS = 2
function MarketProduct_Keyboard:LayoutIcons(iconControls)
    local numControls = #iconControls
    local topRowControls
    local bottomRowControls
    if numControls == 2 then
        topRowControls = iconControls
        bottomRowControls = {}
    else
        topRowControls = {}
        bottomRowControls = {}
        local numTopRow = zo_ceil(#iconControls / NUM_ROWS)
        for index, control in ipairs(iconControls) do
            if index <= numTopRow then
                table.insert(topRowControls, control)
            else
                table.insert(bottomRowControls, control)
            end
        end
    end
    local previousControl
    local previousRowControl
    for index, control in ipairs(topRowControls) do
        control:ClearAnchors()
        if index == 1 then
            control:SetAnchor(TOPRIGHT, nil, nil, -10, 20)
            previousRowControl = control
        else
            control:SetAnchor(TOPRIGHT, previousControl, TOPLEFT, -COLUMN_PADDING, 0)
        end
        previousControl = control
    end
    previousControl = nil
    for index, control in ipairs(bottomRowControls) do
        control:ClearAnchors()
        if index == 1 then
            -- offset the bottom row if we have fewer items in the bottom row
            local rowIsSmaller = #topRowControls - #bottomRowControls >= 1
            if rowIsSmaller then
                control:SetAnchor(TOPRIGHT, previousRowControl, BOTTOM, 0, ROW_PADDING)
            else
                control:SetAnchor(TOPRIGHT, previousRowControl, BOTTOMRIGHT, 0, ROW_PADDING)
            end
        else
            control:SetAnchor(TOPRIGHT, previousControl, TOPLEFT, -COLUMN_PADDING, 0)
        end
        previousControl = control
    end
end
do
    local g_highlightAnimationProvider = ZO_ReversibleAnimationProvider:New("ZO_KeyboardMarketProductHighlightAnimation")
    function MarketProduct_Keyboard:SetHighlightHidden(hidden)
        if hidden then
            g_highlightAnimationProvider:PlayBackward(self.control.highlight)
        else
            g_highlightAnimationProvider:PlayForward(self.control.highlight)
        end
    end
    function MarketProduct_Keyboard:PlayHighlightAnimationToEnd()
        local ANIMATE_INSTANTLY = true
        g_highlightAnimationProvider:PlayForward(self.control.highlight, ANIMATE_INSTANTLY)
    end
    function MarketProduct_Keyboard:PlayHighlightAnimationToBeginning()
        local ANIMATE_INSTANTLY = true
        g_highlightAnimationProvider:PlayBackward(self.control.highlight, ANIMATE_INSTANTLY)
    end
end
--
--[[ ZO_MarketProductBundle ]]--
--
ZO_MarketProductBundle = MarketProduct_Keyboard:Subclass()
function ZO_MarketProductBundle:New(...)
    return MarketProduct_Keyboard.New(self, ...)
end
function ZO_MarketProductBundle:Initialize(control, iconPool, owner)
    MarketProduct_Keyboard.Initialize(self, control, iconPool, owner)
end
function ZO_MarketProductBundle:PerformLayout()
    local iconControls = self:CreateChildIconControlTable(self:IsPurchaseLocked())
    self:LayoutIcons(iconControls)
end
local MAX_VISIBLE_ICONS = 8
function ZO_MarketProductBundle:CreateChildIconControlTable(purchased)
    local iconControls = {}
    local numChildren = self:GetNumChildren()
    if not self:GetHidesChildProducts() and numChildren <= MAX_VISIBLE_ICONS then
        for childIndex = 1, numChildren do
            local childMarketProductId = self:GetChildMarketProductId(childIndex)
            local marketProductIcon = self:InitializeMarketProductIcon(childMarketProductId, purchased)
            marketProductIcon:SetFrameHidden(false)
            table.insert(iconControls, marketProductIcon:GetControl())
        end
        -- Sort the child tiles alphabetically
        table.sort(iconControls, function(a,b)
                                        return a.marketProductIcon:GetDisplayName() < b.marketProductIcon:GetDisplayName()
                                    end)
    end
    return iconControls
end
function ZO_MarketProductBundle:IsActivelyPreviewing()
    if self:HasActiveIcon() then
        return IsPreviewingMarketProduct(self.activeMarketProductIcon:GetMarketProductId())
    end
    return false
end
function ZO_MarketProductBundle:HasPreview()
    if self:HasActiveIcon() then
        return CanPreviewMarketProduct(self.activeMarketProductIcon:GetMarketProductId())
    end
end
function ZO_MarketProductBundle:Preview(icon)
    local activeIcon = icon or self.activeMarketProductIcon
    -- make sure we have a valid icon to preview
    if activeIcon then
        local attachmentId = activeIcon:GetMarketProductId()
        if CanPreviewMarketProduct(attachmentId) then
            self.owner:PreviewMarketProduct(attachmentId)
        end
    else
        if self:GetHidesChildProducts() then
            self.owner:ShowBundleContentsAsList(self:GetMarketProductData())
        else
            self.owner:ShowBundleContents(self:GetMarketProductData())
        end
    end
end
--
--[[ MarketProductIndividual ]]--
--
ZO_MarketProductIndividual = MarketProduct_Keyboard:Subclass()
function ZO_MarketProductIndividual:New(...)
    return MarketProduct_Keyboard.New(self, ...)
end
function ZO_MarketProductIndividual:Initialize(control, iconPool, owner)
    MarketProduct_Keyboard.Initialize(self, control, iconPool, owner)
end
function ZO_MarketProductIndividual:PerformLayout(background)
    local iconControls = {}
    local productType = self:GetMarketProductType()
    if productType ~= MARKET_PRODUCT_TYPE_NONE then
        local marketProductIcon = self:InitializeMarketProductIcon(self:GetId(), self:IsPurchaseLocked())
        --only show the icon if we have no background or it's an item that has a stack
        local showIcon = background == ZO_NO_TEXTURE_FILE or marketProductIcon.hasStack
        marketProductIcon:SetHidden(not showIcon)
        -- only show the frame when the icon is being shown on top of a background
        local showFrame = background ~= ZO_NO_TEXTURE_FILE and showIcon
        marketProductIcon:SetFrameHidden(not showFrame)
        local iconControl = marketProductIcon:GetControl()
        iconControls = { iconControl }
    end
    self:LayoutIcons(iconControls)
end
function ZO_MarketProductIndividual:IsActivelyPreviewing()
end
function ZO_MarketProductIndividual:Preview()
end
function ZO_MarketProductIndividual:Reset()
    MarketProduct_Keyboard.Reset(self)
    self.productIcon = nil
end
--
--[[ MarketProductIcon ]]--
--
ZO_MarketProductIcon = ZO_Object:Subclass()
function ZO_MarketProductIcon:New(...)
    local marketProductIcon = ZO_Object.New(self)
    marketProductIcon:Initialize(...)
    return marketProductIcon
end
local SURFACE_SELECTED_INDEX = 2
function ZO_MarketProductIcon:Initialize(controlId, parent)
    local TEMPLATE_NAME = "ZO_MarketProductIconTemplate_Keyboard"
    local control = CreateControlFromVirtual(TEMPLATE_NAME, parent, TEMPLATE_NAME, controlId)
    control.marketProductIcon = self
    self.control = control
    self.icon = control:GetNamedChild("Icon")
    self.frame = control:GetNamedChild("Frame")
    self.frame:SetSurfaceHidden(SURFACE_SELECTED_INDEX, true)
    self.stackCount = self.icon:GetNamedChild("StackCount")
    self.hasStack = false
end
function ZO_MarketProductIcon:Show(marketProduct, marketProductId, showAsPurchased)
    self.control:SetParent(marketProduct.control)
    self.parentMarketProduct = marketProduct
    self.marketProductId = marketProductId
    self.hasStack = false
    self.displayName = GetMarketProductDisplayName(marketProductId)
    local productType = GetMarketProductType(marketProductId)
    if productType == MARKET_PRODUCT_TYPE_COLLECTIBLE then
        local collectibleId = GetMarketProductCollectibleId(marketProductId)
        -- even if a bundle isn't marked as purchased, a collectible may still be unlocked/purchased unlike items
        if not showAsPurchased then
            showAsPurchased = IsCollectibleOwnedByDefId(collectibleId)
        end
    elseif productType == MARKET_PRODUCT_TYPE_BUNDLE then
        if not showAsPurchased then
            showAsPurchased = CouldAcquireMarketProduct(marketProductId) == MARKET_PURCHASE_RESULT_COLLECTIBLE_ALREADY
        end
    end
    local stackCount = GetMarketProductStackCount(marketProductId)
    if stackCount > 1 then
        self.hasStack = true
        self.stackCount:SetText(stackCount)
    end
    local iconFile = GetMarketProductIcon(marketProductId)
    self.icon:SetTexture(iconFile)
    local iconDesaturation = marketProduct:GetBackgroundDesaturation(showAsPurchased)
    self.icon:SetDesaturation(iconDesaturation)
    self.control:SetHidden(false)
    self.stackCount:SetHidden(not self.hasStack)
end
function ZO_MarketProductIcon:GetControl()
    return self.control
end
function ZO_MarketProductIcon:GetParentMarketProduct()
    return self.parentMarketProduct
end
function ZO_MarketProductIcon:GetMarketProductId()
    return self.marketProductId
end
function ZO_MarketProductIcon:Reset()
    self.control:SetHidden(true)
end
function ZO_MarketProductIcon:SetActive(isActive)
    self.frame:SetSurfaceHidden(SURFACE_SELECTED_INDEX, not isActive)
end
function ZO_MarketProductIcon:SetFrameHidden(isHidden)
    self.frame:SetHidden(isHidden)
end
function ZO_MarketProductIcon:SetHidden(isHidden)
    self.control:SetHidden(isHidden)
end
function ZO_MarketProductIcon:GetDisplayName()
    return self.displayName
end
-- ZO_MarketProductIcon mouse functions
function ZO_MarketProductIcon:OnMouseEnter()
    self.parentMarketProduct:OnIconMouseEnter(self)
end
function ZO_MarketProductIcon:OnMouseExit()
    self.parentMarketProduct:OnMouseExit()
end
function ZO_MarketProductIcon:OnClicked(button)
    if button == MOUSE_BUTTON_INDEX_LEFT then
        self.parentMarketProduct:OnClicked(button)
    elseif button == MOUSE_BUTTON_INDEX_RIGHT then
        ClearMenu()
        local marketProduct = self.parentMarketProduct
        if marketProduct:HasValidPresentationIndex() and marketProduct:CanBePurchased() then
            local function PurchaseCallback() marketProduct:Purchase() end
            if marketProduct:IsBundle() then
                AddMenuItem(GetString(SI_MARKET_ACTION_PURCHASE_BUNDLE), PurchaseCallback)
            else
                AddMenuItem(GetString(SI_MARKET_ACTION_PURCHASE), PurchaseCallback)
            end
        end
        if marketProduct:HasValidPresentationIndex() and marketProduct:IsGiftable() then
            local function GiftCallback() marketProduct:Gift() end
            if marketProduct:IsBundle() then
                AddMenuItem(GetString(SI_MARKET_GIFT_BUNDLE_KEYBIND_TEXT), GiftCallback)
            else
                AddMenuItem(GetString(SI_MARKET_GIFT_KEYBIND_TEXT), GiftCallback)
            end
        end
        if IsPreviewingMarketProduct(self.marketProductId) then
            AddMenuItem(GetString(SI_MARKET_ACTION_END_PREVIEW), function() marketProduct:EndPreview() end)
        elseif CanPreviewMarketProduct(self.marketProductId) and IsCharacterPreviewingAvailable() then
            AddMenuItem(GetString(SI_MARKET_ACTION_PREVIEW), function() marketProduct:Preview(self) end)
        end
        ShowMenu(self.control)
    end
end
--
--[[ XML Handlers ]]--
--
    control.highlight = control:GetNamedChild("Highlight")
    control.giftButton = control:GetNamedChild("Gift")
end
    local marketProduct = control.marketProduct
    marketProduct:OnMouseEnter()
end
    local marketProduct = control.marketProduct
    marketProduct:OnMouseExit()
end
    WINDOW_MANAGER:SetMouseCursor(MOUSE_CURSOR_DO_NOT_CARE)
end
end
    local marketProduct = control.marketProduct
    marketProduct:Gift()
end
    local marketProductIcon = control.marketProductIcon
    marketProductIcon:OnMouseEnter()
end
    local marketProductIcon = control.marketProductIcon
    marketProductIcon:OnMouseExit()
end
do
    local TEXTURE_WIDTH = 256
    local TEXTURE_HEIGHT = 256
    local FRAME_WIDTH = 64
    local FRAME_HEIGHT = 64
    local FRAME_SLICE_WIDTH = 64
    local FRAME_SLICE_HEIGHT = 64
    local FRAME_PADDING_X = (FRAME_SLICE_WIDTH - FRAME_WIDTH)
    local FRAME_PADDING_Y = (FRAME_SLICE_HEIGHT - FRAME_HEIGHT)
    local FRAME_WIDTH_TEX_COORD = FRAME_WIDTH / TEXTURE_WIDTH
    local FRAME_HEIGHT_TEX_COORD = FRAME_HEIGHT / TEXTURE_HEIGHT
    local FRAME_PADDING_X_TEX_COORD = FRAME_PADDING_X / TEXTURE_WIDTH
    local FRAME_PADDING_Y_TEX_COORD = FRAME_PADDING_Y / TEXTURE_HEIGHT
    local FRAME_START_TEXCOORD_X = 0.0 + FRAME_PADDING_X_TEX_COORD * .5
    local FRAME_START_TEXCOORD_Y = 0.0 + FRAME_PADDING_Y_TEX_COORD * .5
    local FRAME_NUM_COLS = 4
    local FRAME_NUM_ROWS = 2
    local SURFACE_FRAME_INDEX = 3
    local function PickRandomFrame(self)
        local col = zo_random(FRAME_NUM_COLS)
        local row = zo_random(FRAME_NUM_ROWS)
        local left = FRAME_START_TEXCOORD_X + (col - 1) * (FRAME_WIDTH_TEX_COORD + FRAME_PADDING_X_TEX_COORD)
        local right = left + FRAME_WIDTH_TEX_COORD 
        local top = FRAME_START_TEXCOORD_Y + (row - 1) * (FRAME_HEIGHT_TEX_COORD + FRAME_PADDING_Y_TEX_COORD)
        local bottom = top + FRAME_HEIGHT_TEX_COORD
        self:SetTextureCoords(SURFACE_FRAME_INDEX, left, right, top, bottom)
    end
        PickRandomFrame(self)
    end
end