Back to Home

ESO Lua File v101041

libraries/zo_combobox/zo_combobox_base.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
--[[
Base class for combo box ui widgets.
Subclasses are responsible for the look of the combo box.
--]]
ZO_ComboBox_Base = ZO_InitializingObject:Subclass()
ZO_COMBOBOX_UPDATE_NOW = 1
ZO_COMBOBOX_SUPPRESS_UPDATE = 2
function ZO_ComboBox_Base:ShowDropdownInternal()
    -- this is meant to be overridden by a subclass it's called when the combo dropdown is to be shown
    -- this function should populate the list using the entries in m_sortedItems and make the dropdown visible
end
function ZO_ComboBox_Base:HideDropdownInternal()
    -- this is meant to be overridden by a subclass
    -- this function should clear the list and hide the dropdown
end
function ZO_ComboBox_Base:OnClearItems()
    -- this can optionally be overriden by a subclass and is called when the contents of a combo box are cleared
end
function ZO_ComboBox_Base:OnItemAdded()
    -- this can optionally be overriden by a subclass and is called when a new entry is added to the combo box
end
function ZO_ComboBox_Base:Initialize(control)
    self.m_container = control
    self.m_selectedItemText = control:GetNamedChild("SelectedItemText")
    self.m_selectedItemData = nil
    self.m_openDropdown = control:GetNamedChild("OpenDropdown")
    self.m_selectedColor = { GetInterfaceColor(INTERFACE_COLOR_TYPE_TEXT_COLORS, INTERFACE_TEXT_COLOR_SELECTED) }
    self.m_disabledColor = ZO_ERROR_COLOR
    self.m_sortOrder = ZO_SORT_ORDER_UP
    self.m_sortType = ZO_SORT_BY_NAME
    self.m_sortsItems = true
    self.m_sortedItems = {}
    self.m_isDropdownVisible = false
    self.m_font = nil
    self.m_preshowDropdownFn = nil
    self.m_spacing = 0
    self.m_name = control:GetName()
    self.horizontalAlignment = TEXT_ALIGN_LEFT
    control.m_comboBox = self
end
function ZO_ComboBox_Base:GetContainer()
    return self.m_container
end
function ZO_ComboBox_Base:SetPreshowDropdownCallback(fn)
    -- Called right before the menu is shown.
end
function ZO_ComboBox_Base:SetFont(font)
    self:SetSelectedItemFont(font)
    self:SetDropdownFont(font)
end
function ZO_ComboBox_Base:SetDropdownFont(font)
    self.m_font = font
end
function ZO_ComboBox_Base:GetDropdownFont()
    return self.m_font
end
function ZO_ComboBox_Base:GetDropdownFontObject()
    return _G[self.m_font]
end
function ZO_ComboBox_Base:SetSelectedItemFont(font)
    self.m_selectedItemText:SetFont(font)
end
function ZO_ComboBox_Base:SetSpacing(spacing)
    self.m_spacing = spacing
end
function ZO_ComboBox_Base:GetSpacing()
    return self.m_spacing
end
function ZO_ComboBox_Base:SetSelectedColor(color, colorG, colorB, colorA)
    if type(color) == "table" then
        color, colorG, colorB, colorA = color:UnpackRGBA()
    end
    self.m_selectedColor = { color, colorG, colorB, colorA }
    self.m_selectedItemText:SetColor(color, colorG, colorB, colorA)
end
function ZO_ComboBox_Base:SetDisabledColor(color, colorG, colorB, colorA)
    self.m_disabledColor = ZO_ColorDef:New(color, colorG, colorB, colorA)
end
function ZO_ComboBox_Base:SetNormalColor(color, colorG, colorB, colorA)
    self.m_normalColor = ZO_ColorDef:New(color, colorG, colorB, colorA)
end
function ZO_ComboBox_Base:SetHighlightedColor(color, colorG, colorB, colorA)
    self.m_highlightColor = ZO_ColorDef:New(color, colorG, colorB, colorA)
end
function ZO_ComboBox_Base:SetSelectedItemTextColor(selected)
    if selected then
        self.m_selectedItemText:SetColor(self.m_highlightColor:UnpackRGB())
    else
        self.m_selectedItemText:SetColor(self.m_normalColor:UnpackRGB())
    end
end
function ZO_ComboBox_Base:SetSortsItems(sortsItems)
    self.m_sortsItems = sortsItems
end
function ZO_ComboBox_Base:SetSortOrder(sortOrder, sortType)
    self.m_sortOrder = sortOrder or ZO_SORT_ORDER_UP
    self.m_sortType = sortType or ZO_SORT_BY_NAME
    self:UpdateItems()
end
function ZO_ComboBox_Base:IsDropdownVisible()
    return self.m_isDropdownVisible
end
function ZO_ComboBox_Base:SetVisible(visible)
    self.m_isDropdownVisible = visible
end
function ZO_ComboBox_Base:CreateItemEntry(name, callback, enabled)
    local isEnabled = enabled
    if isEnabled == nil then
        -- Evaluate nil to be equivalent to true for backwards compatibility.
        isEnabled = true
    end
    local itemEntry =
    {
        name = name,
        callback = callback,
        enabled = isEnabled,
    }
    return itemEntry
end
function ZO_ComboBox_Base:AddItem(itemEntry, updateOptions)
    table.insert(self.m_sortedItems, itemEntry)
    
    if updateOptions ~= ZO_COMBOBOX_SUPPRESS_UPDATE then
        self:UpdateItems()
    end
    self:OnItemAdded()
end
function ZO_ComboBox_Base:ShowDropdown()
    -- Let the caller know that this is about to be shown...
    if self.m_preshowDropdownFn then
        self.m_preshowDropdownFn(self)
    end
end
function ZO_ComboBox_Base:HideDropdown()
    if self:IsDropdownVisible() then
        self:HideDropdownInternal()
    end
end
function ZO_ComboBox_Base:ClearItems()
    ZO_ClearNumericallyIndexedTable(self.m_sortedItems)
    self.m_selectedItemData = nil
    self:OnClearItems()
end
function ZO_ComboBox_Base:GetItems()
    return self.m_sortedItems
end
function ZO_ComboBox_Base:GetNumItems()
    return #self.m_sortedItems
end
function ZO_ComboBox_Base:AddItems(items)
    for k, v in pairs(items) do
        self:AddItem(v, ZO_COMBOBOX_SUPPRESS_UPDATE)
    end
    
    self:UpdateItems()
end
local function ComboBoxSortHelper(item1, item2, comboBoxObject)
    return ZO_TableOrderingFunction(item1, item2, "name", comboBoxObject.m_sortType, comboBoxObject.m_sortOrder)
end
function ZO_ComboBox_Base:UpdateItems()
    if self.m_sortOrder and self.m_sortsItems then
        table.sort(self.m_sortedItems, function(item1, item2) return ComboBoxSortHelper(item1, item2, self) end)
    end
    
    if self:IsDropdownVisible() then
        self:ShowDropdown()
    end
end
--This is used if selection of an entry should go through some other avenue to determine the correct display text (e.g.: Chat System)
function ZO_ComboBox_Base:SetDontSetSelectedTextOnSelection(dontSetSelectedTextOnSelection)
    self.dontSetSelectedTextOnSelection = dontSetSelectedTextOnSelection
end
function ZO_ComboBox_Base:SetSelectedItemText(itemText)
    if self.m_selectedItemText then
        self.m_selectedItemText:SetText(itemText)
        self.currentSelectedItemText = itemText
    end
end
--Maintain this for addons, but use the better named SetSelectedItemText
function ZO_ComboBox_Base:SetSelectedItem(itemText)
    self:SetSelectedItemText(itemText)
end
function ZO_ComboBox_Base:ItemSelectedClickHelper(item, ignoreCallback)
    if item.enabled == false then
        return false
    end
    local oldItem = self.m_selectedItemData
    if self.dontSetSelectedTextOnSelection ~= true then
        self:SetSelectedItemText(item.name)
    end
    self.m_selectedItemData = item
    if item.callback and not ignoreCallback then
        local selectionChanged = (oldItem ~= item)
        if not selectionChanged and oldItem and item then
            selectionChanged = item.name ~= oldItem.name
        end
        item.callback(self, item.name, item, selectionChanged, oldItem)
    end
    return true
end
--Maintain for addons
function ZO_ComboBox_Base_ItemSelectedClickHelper(comboBox, item, ignoreCallback)
    return comboBox:ItemSelectedClickHelper(item, ignoreCallback)
end
function ZO_ComboBox_Base:SelectItem(item, ignoreCallback)
    if item then
        return self:ItemSelectedClickHelper(item, ignoreCallback)
    end
end
function ZO_ComboBox_Base:SelectItemByIndex(index, ignoreCallback)
    return self:SelectItem(self.m_sortedItems[index], ignoreCallback)
end
function ZO_ComboBox_Base:SelectFirstItem(ignoreCallback)
    return self:SelectItemByIndex(1, ignoreCallback)
end
function ZO_ComboBox_Base:GetIndexByEval(eval)
    for i, item in ipairs(self.m_sortedItems) do
        if eval(item) then
            return i
        end
    end
    return nil
end
function ZO_ComboBox_Base:SetSelectedItemByEval(eval, ignoreCallback)
    local index = self:GetIndexByEval(eval)
    if index then
        return self:SelectItemByIndex(index, ignoreCallback)
    end
    return false
end
function ZO_ComboBox_Base:GetSelectedItem()
    return self.m_selectedItemText:GetText()
end
function ZO_ComboBox_Base:GetSelectedItemData()
    return self.m_selectedItemData
end
function ZO_ComboBox_Base:EnumerateEntries(functor)
    for index, data in ipairs(self.m_sortedItems) do
        if functor(index, data) then
            break -- once the enumeration is complete, returning true means stop enumerating
        end
    end
end
function ZO_ComboBox_Base:GetSelectedTextColor(enabledState)
    if enabledState then
        return unpack(self.m_selectedColor)
    else
        return GetInterfaceColor(INTERFACE_COLOR_TYPE_TEXT_COLORS, INTERFACE_TEXT_COLOR_DISABLED)
    end
end
function ZO_ComboBox_Base:GetItemNormalColor(item)
    if item.enabled == false then
        return item.m_disabledColor or self.m_disabledColor
    end
    return item.m_normalColor or self.m_normalColor
end
function ZO_ComboBox_Base:GetItemHighlightColor(item)
    if item.enabled == false then
        return item.m_disabledColor or self.m_disabledColor
    end
    return item.m_highlightColor or self.m_highlightColor
end
function ZO_ComboBox_Base:SetEnabled(enabled)
    self.m_container:SetMouseEnabled(enabled)
    self.m_openDropdown:SetEnabled(enabled)
    self.m_selectedItemText:SetColor(self:GetSelectedTextColor(enabled))
    self:HideDropdown()
end
function ZO_ComboBox_Base:SetItemEnabled(item, enabled)
    local isEnabled = enabled
    if isEnabled == nil then
        -- Evaluate nil to be equivalent to true for backwards compatibility.
        isEnabled = true
    end
    item.enabled = isEnabled
end
function ZO_ComboBox_Base:SetItemOnEnter(item, handler)
    item.onEnter = handler
end
function ZO_ComboBox_Base:SetItemOnExit(item, handler)
    item.onExit = handler
end
function ZO_ComboBox_Base:GetControl()
    return self.m_container
end
function ZO_ComboBox_Base:SetHorizontalAlignment(alignment)
    self.horizontalAlignment = alignment
    self.m_selectedItemText:SetHorizontalAlignment(alignment)
end
--[[
Utilities to obtain the combo box from the container.
--]]
function ZO_ComboBox_ObjectFromContainer(container)
    return container.m_comboBox
end
function ZO_ComboBox_OpenDropdown(container)
    local comboBox = ZO_ComboBox_ObjectFromContainer(container)
    if not comboBox:IsDropdownVisible() then
        comboBox:ShowDropdown()
    end
end
function ZO_ComboBox_HideDropdown(container)
    local comboBox = ZO_ComboBox_ObjectFromContainer(container)
    if comboBox then
        comboBox:HideDropdown()
    end
end
function ZO_ComboBox_Enable(container)
end
function ZO_ComboBox_Disable(container)
    ZO_ComboBox_ObjectFromContainer(container):SetEnabled(false)
end