ScrollListExample & Dropdown Windows

[stAjora]

I'm having trouble understanding how ScrollListExample add on functions. I'm completely lost on the ZO_ScrollList and ZO_SortFilteredList functions. I can't even determine how/where the add on finds/inserts data into the window.

This seems a little more complex than a simple drop down but even that I'm having trouble. Looking at the GuildSelector.xml in the game files, I see a function call ZO_ComboBox_DropdownClicked(self:GetParent()), I don't see how this window is being populated with information.

[Baertram]

I'm not sure if I'm telling you bull**** about the guildselector combobox but I'll try to explain what I understood how it works

The combobox in the guildselector.xml is named "$(parent)ComboBox". As the $parent is a placeholder for the "parent" control, which is the TopLevelControl "ZO_GuildSelector", this full name will be:
ZO_GuildSelectorComboBox

You could use the ZGOO addon inagme, go to the guild roster e.g where you can see the guild selector combobox.
Now enter /zgoo ZO_GuildSelectorComboBox into the chat.
You'll see a list of all functions and controls, children etc. of this combobox.
At the function GetChildren(), if you expand it by the small ":" button, you can see 2 children where one is a label control and the other one is a button.
The label will show the text/name of the guild, the button is the small triangel button right to the selector combobox.

Hint:
You can always use the function A__ZGoo_ToggleHidden() to toggle the visibility of elements to see which element you are currently looking at

So where does the data of the combobox come from?
You can see a table "m_comboBox" beyond the combobox control ZO_GuildSelectorComboBox.
In there you'll find different functions and other tables, where one is holding the entries of the combobox:
m_sortedItems

The entries here must be somwhow "loaded" into the table. This must be done after the box has been created.
Inside the XML file you'll find the following part beyond the combobox control:

<OnInitialized>
                        ZO_ComboBox:New(self)
                    </OnInitialized>

This will call the standard creation methods of this combobox.

->
Somwhere this will trigger an event "EVENT_GUILD_DATA_LOADED", or at least this event will be used later on to populate the guild data. Maybe it is triggered as you open the guild roster.
YoU'll have to search the other guild files for the event name to check in detail-

lua file
Together with the XML file there is a lua file in the same directory, with the same name: "guildselector.lua".

In here you fnd additional source code, like the creation of the guild selector subclass (OO coding).
At the cretion of this subclass the combobox will be assigned to the subclass, in function "function GuildSelector:New(control)" at line 7ff

local comboBoxControl = GetControl(control, "ComboBox")
    selector.comboBox = ZO_ComboBox_ObjectFromContainer(comboBoxControl)
    selector.comboBox:SetSortsItems(false)
    selector.comboBox:SetSelectedItemFont("ZoFontWindowTitle")
    selector.comboBox:SetDropdownFont("ZoFontHeader2")
    selector.comboBox:SetSpacing(8)

In additon here is added an event listener for this event that we have talked about above,
event "EVENT_GUILD_DATA_LOADED", see line 29:

EVENT_MANAGER:RegisterForEvent("GuildsSelector", EVENT_GUILD_DATA_LOADED, function() selector:InitializeGuilds() end)

As the event gets triggered the callback function InitializeGuilds() will be executed and this function is filling the combobox then finally for the first time.

See lines 68ff:

function GuildSelector:InitializeGuilds()
    if(not self.scenesCreated) then return end
 
    local selectedEntry
    local lastGuildId = self.guildId
    
    self.guildId = nil
    self.comboBox:ClearItems() -- cler the combobox
    
    local numGuilds = GetNumGuilds() -- get the total number of guilds that you joined
    for i = 1, numGuilds do -- loop every guild now
--Get guild information, name, fraction, etc.
        local guildId = GetGuildId(i)
        local guildName = GetGuildName(guildId)
        local guildAlliance = GetGuildAlliance(guildId)
-_Add the fraction icon + text together to a string
        local entryText = zo_strformat(SI_GUILD_SELECTOR_FORMAT, GetAllianceBannerIcon(guildAlliance), i, guildName)
 
--Add the string into the combobox
        local entry = self.comboBox:CreateItemEntry(entryText, self.OnGuildChanged)
        entry.guildId = guildId
        entry.selectedText = guildName
        self.comboBox:AddItem(entry)
 
        if(not selectedEntry or (lastGuildId and guildId == lastGuildId)) then
            selectedEntry = entry
        end
 
        if(not playerIsGuildMaster) then
            local guildPlayerIndex = GetPlayerGuildMemberIndex(guildId)
            local _, _, rankIndex = GetGuildMemberInfo(guildId, guildPlayerIndex)
            if(IsGuildRankGuildMaster(guildId, rankIndex)) then
                playerIsGuildMaster = true
            end
        end
    end
 
    local CREATE_WINDOW_TITLE = GetString(SI_GUILD_CREATE_TITLE)
    local entry = self.comboBox:CreateItemEntry(CREATE_WINDOW_TITLE, self.OnGuildChanged)
    entry.selectedText = CREATE_WINDOW_TITLE
    self.comboBox:AddItem(entry)
 
    if(numGuilds == 0) then
        self.comboBox:SetSelectedItem(CREATE_WINDOW_TITLE)
        self.OnGuildChanged(nil, CREATE_WINDOW_TITLE, entry)
    else
        self.comboBox:SetSelectedItem(selectedEntry.selectedText)
        self.OnGuildChanged(nil, selectedEntryText, selectedEntry)
    end
end

[stAjora]

Holy crap that is a lot of functionality...

I'm going to attempt to create a simple example, create a combo box and make it display the data of a hard coded table. If someone more experienced beats me to it, please post it. I know im going to spend 80 years on this.

[Baertram]

Basically you only need to create the combobox that you need, anchor it somehwhere to a parent control to show it and give it some entries.

You said you wish to have a table for this, let's call it myTable.
And your combobox is named, let's say, myComboBox (created by help of XML or lua code):

local myTable = {
[1] ="Hello",
[2] = "World",
}
 
--Im not sure what the first parameter is. I guesss the selected index, or maybe it is the control (combobox) itsself. If the chat output will tell oyu it's a table then it's probably the combobox control :-)
local function myCallbackFunction(amItheSelectedIndex, entryText, entry)
   d("[" .. tostring(amItheSelectedIndex) .. "] Combobox entry " .. entryText .. " callback function is executed")
end
 
for index, text in pairs(myTable) do
        local entry = myComboBox.comboBox:CreateItemEntry(text, myCallbackFunction)
        entry.selectedText = text
        myComboBox.comboBox:AddItem(entry) 
end

[stAjora]

I know LAM is supposed to be used for addon settings menus but couldn't it be used in an add on just the same outside a settings option window to do the things I requested in this thread?

edit

I still couldn't get a functional drop down.

[Ayantir]

Look at autoInvite he pushed it's lam2 panel into its window xml.

[circonian]

Originally Posted by stAjora I'm going to attempt to create a simple example, create a combo box and make it display the data of a hard coded table. If someone more experienced beats me to it, please post it. I know im going to spend 80 years on this.

Originally Posted by stAjora I still couldn't get a functional drop down.

I'm not sure what you want, the thread is posted as scrollList, but everyone is talking about a combo box.
Did you want something like this?

Code to create top level window, a background, & the comboBox:

Warning: Spoiler

local function CreateDropDown()
    local tlw = CreateTopLevelWindow("testComboBoxWin")
    tlw:SetDimensions(300, 80)
    tlw:SetAnchor(CENTER, GuiRoot, CENTER, 0, 0)
    
    local bd = WINDOW_MANAGER:CreateControlFromVirtual("testComboBoxWinBackdrop", tlw, "ZO_DefaultBackdrop")
    bd:SetAnchorFill()
    
    local comboBox = WINDOW_MANAGER:CreateControlFromVirtual("testComboBox", tlw, "ZO_ComboBox")
    comboBox:SetDimensions(250, 30)
    comboBox:ClearAnchors()
    comboBox:SetAnchor(CENTER, tlw, CENTER, 0, 0)
    
    -- tooltip text
    comboBox.data = { tooltipText = "Tooltip Text" }
    
    -- tooltip handlers
    comboBox:SetHandler("OnMouseEnter", ZO_Options_OnMouseEnter)
    comboBox:SetHandler("OnMouseExit", ZO_Options_OnMouseExit)
    
    local m_comboBox = comboBox.m_comboBox
    m_comboBox:SetSortsItems(false)
    
    -- easy access references from tlw
    tlw.backdrop = bd
    tlw.comboBox = comboBox
    tlw.m_comboBox = m_comboBox
    
    return tlw
end

Code to populate the comboBox:

There are a lot of ways to populate the comboBox, you can loop through a table and use CreateItemEntry to create the item entries for you like this:

Warning: Spoiler

local function PopulateComboBox(m_comboBox)
    m_comboBox:ClearItems()
    
    local function ItemSelectCallback(comboBox, itemName, item, selectionChanged)
        d("item selected")
        -- Do whatever
    end
 
--===============================================================--
--====== Population Code  ============--
--===============================================================--
    local tItemData = {
        [1] = "Item 1",
        [2] = "Item 2",
    }
 
    for k,name in ipairs(tItemData) do
        local itemEntry = m_comboBox:CreateItemEntry(name, ItemSelectCallback)
        
        -- suppress update until were done adding items
        m_comboBox:AddItem(itemEntry, ZO_COMBOBOX_SUPRESS_UPDATE)
    end
--===============================================================--
    
    -- Update & select first item
    m_comboBox:UpdateItems()
    m_comboBox:SelectFirstItem()
end

Code to call those functions to create the window/box, & populate it:

Warning: Spoiler

local function InitializeComboBox()
    local tlw = CreateDropDown()
    PopulateComboBox(tlw.m_comboBox)
end

Other ways to populate it:

CreateItemEntry just creates a table from the data you pass it that looks like this:

Warning: Spoiler

function ZO_ComboBox_Base:CreateItemEntry(name, callback)
    return { name = name, callback = callback }
end

So if you wanted to store extra data with each item, you could create the entry yourself & just add the extra data like this:

Warning: Spoiler

local tItemData = {
    [1]     = {name = "Item 1", callback = ItemSelectCallback, someOtherData = "something"},
    [2]     = {name = "Item 2", callback = ItemSelectCallback, someOtherData = "something"},
}
 
for k,itemData in ipairs(tItemData) do
    -- suppress update until were done adding items
    m_comboBox:AddItem(itemData, ZO_COMBOBOX_SUPRESS_UPDATE)
end

or if you create the itemEntries yourself you could let the game handle the loop & addItem(...) calls for you with:

Warning: Spoiler

local tItemData = {
    [1]     = {name = "Item 1", callback = ItemSelectCallback, someOtherData = "something"},
    [2]     = {name = "Item 2", callback = ItemSelectCallback, someOtherData = "something"},
}
 
m_comboBox:AddItems(tItemData)

[Sasky]

Originally Posted by stAjora I know LAM is supposed to be used for addon settings menus but couldn't it be used in an add on just the same outside a settings option window to do the things I requested in this thread? edit I still couldn't get a functional drop down.

Yeah, you use the LAMCreateControl functionality as indicated here:
https://github.com/sirinsidiator/ESO...ethods-on-LAM2

I use that extensively for the UI controls in AutoInvite. The group list and some of the buttons are separate, but most of the options are using LAM creation. This file has most of the control creation:
http://git.esoui.com/?a=viewblob&p=A...s_fragment.lua

For dropdown, it should be something like:

local myDropdown = LAMCreateControl.dropdown(PARENT_CONTROL, {
    type = "dropdown",
    name = "My Dropdown",
    tooltip = "Dropdown's tooltip text.",
    choices = {"table", "of", "choices"},
    sort = "name-up", --or "name-down", "numeric-up", "numeric-down" (optional) - if not provided, list will not be sorted
    getFunc = function() return db.var end,
    setFunc = function(var) db.var = var doStuff() end,
    width = "full", --or "half" (optional)
    disabled = function() return db.someBooleanSetting end, --or boolean (optional)
    warning = "Will need to reload the UI.",    --(optional)
    default = defaults.var, --(optional)
    reference = "MyAddonDropdown"   --(optional) unique global reference to control
})
--Table contents taken from documentation at top of the dropdown.lua control in LAM
 
--You will need to set an anchor after creating the control. 
myDropdown:SetAnchor(TOPLEFT, PARENT_CONTROL, TOPLEFT, 0, 25)

If you're familiar with LAM, it's (much) easier to setup this way. The only window manager stuff you need to get into is making sure you have a parent control and setting the anchor. On the downside, you don't have as much flexibility in terms of sizing. If the option-styling of LAM works for you, though, it's much easier to setup.

[Argusus]

Is this something like you are looking for?

http://www.esoui.com/downloads/info5...stExample.html

Basically the data is
assigned via tables in the initialization functions. I can't remember which one but it's either New or Initialize. I'll have to double check when I'm on a pc.

Originally Posted by stAjora I'm having trouble understanding how ScrollListExample add on functions. I'm completely lost on the ZO_ScrollList and ZO_SortFilteredList functions. I can't even determine how/where the add on finds/inserts data into the window. This seems a little more complex than a simple drop down but even that I'm having trouble. Looking at the GuildSelector.xml in the game files, I see a function call ZO_ComboBox_DropdownClicked(self:GetParent()), I don't see how this window is being populated with information.