ESOUI - ZO_Templates ScrollTemplates

ESOUI (https://www.esoui.com/forums/index.php)

- Lua/XML Help (https://www.esoui.com/forums/forumdisplay.php?f=175)

- - ZO_Templates ScrollTemplates (https://www.esoui.com/forums/showthread.php?t=5124)

ZO_Templates ScrollTemplates

Hello,

Does anyone have recommendations for me change my Scroll lists in TradesMan? It looks like they have removed or deprecated the Filter ScrollList base I was relying on to build my addon. any feedback/suggestions are appreciated! below is the message i'm getting since the new update.

You're either passing nil instead of proper list control to ZO_ScrollList_AddDataType, or it hasn't been initialized properly with ZO_ScrollList_Initialize.

Ok, read some more.

In order to be used as ZO_SortFilterList, CustomerListContainer must contain a control named "$(parent)List" that inherits="ZO_ScrollList".

Delete all your X:New functions, they're not needed, and wrong. ZO_SortFilterList.New itself calls :Initialize, you don't want to call it a second time. Fix your :Initialize functions to call the base as the very first thing.

Quote:

Originally Posted by merlight (Post 23292)

cool thanks for the information. So I should remove the calls in TradesMan when calling new? on line 1277 I have TRADESMAN.CustomerList = CustomerList:New() which then calls Initialize, then I have these for my x:New functions.

Code:

function CustomerList:New()

        local customers = ZO_SortFilterList.New(self, CustomerListContainer)

        customers:Initialize()

        return customers

end

Remove the function CustomerList:New(), it's overriding the base with nothing "new" to add ;)

TRADESMAN.CustomerList = CustomerList:New(CustomerListContainer)
will work just fine without it, because CustomerList is already defined as ZO_SortFilterList:Subclass(), so it will call the correct New and YOUR Initialize (that's why you need to call ZO_SortFilterList.Initialize from there)

Example: (I combined your New & Initialize functions)

Lua Code:

function CustomerList:New()
    local manager = ZO_SortFilterList.New(self, CustomerListContainer)
    manager.masterList = {}
    
    ZO_ScrollList_AddDataType(manager.list, 1, "CustomerUnitRow", 30, function(control, data) manager:SetupUnitRow(control, data) end)
    ZO_ScrollList_EnableHighlight(manager.list, "ZO_ThinListHighlight") 
    manager.sortFunction = function(listEntry1, listEntry2) return ZO_TableOrderingFunction(listEntry1.data, listEntry2.data, manager.currentSortKey, CustomerList.SORT_KEYS, manager.currentSortOrder) end
    manager.sortHeaderGroup:SelectHeaderByKey("name")
    manager:RefreshData()
    
    return manager
end
 
TRADESMAN.CustomerList = CustomerList:New()

Quote:

Originally Posted by circonian (Post 23297)

Example: (I combined your New & Initialize functions)

Lua Code:

function CustomerList:New()
    local manager = ZO_SortFilterList.New(self, CustomerListContainer)
    manager.masterList = {}
    
    ZO_ScrollList_AddDataType(manager.list, 1, "CustomerUnitRow", 30, function(control, data) manager:SetupUnitRow(control, data) end)
    ZO_ScrollList_EnableHighlight(manager.list, "ZO_ThinListHighlight") 
    manager.sortFunction = function(listEntry1, listEntry2) return ZO_TableOrderingFunction(listEntry1.data, listEntry2.data, manager.currentSortKey, CustomerList.SORT_KEYS, manager.currentSortOrder) end
    manager.sortHeaderGroup:SelectHeaderByKey("name")
    manager:RefreshData()
    
    return manager
end
 
TRADESMAN.CustomerList = CustomerList:New()

AWESOME!! thanks so much man! thats big time. I really appreciate.. I'm a Newb at Lua... just live in the asp.net world so i'm learning as I go... I really appreciate it! thanks for the quick resolution.

Quote:

Originally Posted by merlight (Post 23296)

thanks for the quick responses! I really appreciate it Mer!

Should've posted more concrete code -- but it was way too late, sorry :D -- to show why overriding New isn't needed at all thanks to how it's written (it passes all arguments to Initialize).

Lua Code:

function CustomerList:Initialize(control)
    ZO_SortFilterList.Initialize(self, control)
    self.masterList = {}
    ZO_ScrollList_AddDataType(self.list, 1, "CustomerUnitRow", 30, function(control, data) self:SetupUnitRow(control, data) end)
    ZO_ScrollList_EnableHighlight(self.list, "ZO_ThinListHighlight")
    self.sortFunction = function(listEntry1, listEntry2) return ZO_TableOrderingFunction(listEntry1.data, listEntry2.data, self.currentSortKey, CustomerList.SORT_KEYS, self.currentSortOrder) end
    self.sortHeaderGroup:SelectHeaderByKey("name")
    self:RefreshData()
end
 
TRADESMAN.CustomerList = CustomerList:New(CustomerListContainer)

This way CustomerListContainer is not hard-coded in the class, thus you could create multiple instances (on different container controls). Not really useful in your case, I know, but still cleaner IMO.

Another little suggestion that's good getting used to. In BuildMasterList(), don't create a new table, discarding the old one -- unless you have a million items in there and really want to free the memory and only insert a thousand ;) -- just clear the existing table with

Lua Code:

ZO_ClearNumericallyIndexedTable(self.masterList)

Quote:

Originally Posted by merlight (Post 23304)

Should've posted more concrete code -- but it was way too late, sorry :D -- to show why overriding New isn't needed at all thanks to how it's written (it passes all arguments to Initialize).

Lua Code:

function CustomerList:Initialize(control)
    ZO_SortFilterList.Initialize(self, control)
    self.masterList = {}
    ZO_ScrollList_AddDataType(self.list, 1, "CustomerUnitRow", 30, function(control, data) self:SetupUnitRow(control, data) end)
    ZO_ScrollList_EnableHighlight(self.list, "ZO_ThinListHighlight")
    self.sortFunction = function(listEntry1, listEntry2) return ZO_TableOrderingFunction(listEntry1.data, listEntry2.data, self.currentSortKey, CustomerList.SORT_KEYS, self.currentSortOrder) end
    self.sortHeaderGroup:SelectHeaderByKey("name")
    self:RefreshData()
end
 
TRADESMAN.CustomerList = CustomerList:New(CustomerListContainer)

Lua Code:

ZO_ClearNumericallyIndexedTable(self.masterList)

I really like this suggestion. I have been wanting to clean up tradesman for a while now. I think making a reusable constructor would be a step in the right direction. Below is a shorter version of my "BuildMasterList"

Code:

function CustomerList:New()

        local customers = ZO_SortFilterList.New(self, CustomerListContainer)

        

        customers.masterList = {}

        

        ZO_ScrollList_AddDataType(customers.list, 1, "CustomerUnitRow", 30, function(control, data) customers:SetupUnitRow(control, data) end)

        ZO_ScrollList_EnableHighlight(customers.list, "ZO_ThinListHighlight")        

        customers.sortFunction = function(listEntry1, listEntry2) return ZO_TableOrderingFunction(listEntry1.data, listEntry2.data, customers.currentSortKey, CustomerList.SORT_KEYS, customers.currentSortOrder) end

        customers.sortHeaderGroup:SelectHeaderByKey("name")

        customers:RefreshData()

                

        return customers

end



function CustomerList:BuildMasterList()

        self.masterList = {}        

            local transactions = TRADESMAN.savedVariables.Transactions

        table.insert(self.masterList, transactions)

    end                

end

Have you looked at the code for tradesman? I have 4-5 of these scroll lists, and basically the same code to create each except for the container control and the sort keys that are needed to be unique, then after that when buildmasterlist, I access the saved variables to populate the scroll lists. I wonder how I could have all of my scroll lists share the same initialization code but have unique sort keys, and build master list, passing in unique containers you explained well.

Quote:

Originally Posted by Argusus (Post 23306)

I have 4-5 of these scroll lists, and basically the same code to create each except for the container control and the sort keys that are needed to be unique, then after that when buildmasterlist, I access the saved variables to populate the scroll lists. I wonder how I could have all of my scroll lists share the same initialization code but have unique sort keys, and build master list, passing in unique containers you explained well.

Well, they have different row control template, default sort header, vastly different BuildMasterList, I think they deserve being separate classes. You can move a few things to a common base, like FilterScrollList and SortScrollList which are identical, and derive your special classes from that base.

Lua Code:

local StuffListBase = ZO_SortFilterList:Subclass()
local CustomerList = StuffListBase:Subclass()
local XTradeItemsList = StuffListBase:Subclass()
...

My/TheirTradeItemsList look like they could be merged. Just pass the things that differ as additional arguments to initialize, and store them in the instance.

Lua Code:

function XTradeItemsList:Initialize(control, itemsKey)
    StuffListBase.Initialize(self, control)
    self.itemsKey = itemsKey
    ...
end
 
function XTradeItemsList:BuildMasterList()
    ...
    for key, itemObject in pairs(selectedTrade[self.itemsKey]) do
        ...
    end
end
 
TRADESMAN.MyTradeItemsList = XTradeItemsList:New(MyTradeItemsContainer, "MyItems")
TRADESMAN.TheirTradeItemsList = XTradeItemsList:New(TheirTradeItemsContainer, "TheirItems")

Quote:

Originally Posted by merlight (Post 23307)

Lua Code:

local StuffListBase = ZO_SortFilterList:Subclass()
local CustomerList = StuffListBase:Subclass()
local XTradeItemsList = StuffListBase:Subclass()
...

My/TheirTradeItemsList look like they could be merged. Just pass the things that differ as additional arguments to initialize, and store them in the instance.

Lua Code:

function XTradeItemsList:Initialize(control, itemsKey)
    StuffListBase.Initialize(self, control)
    self.itemsKey = itemsKey
    ...
end
 
function XTradeItemsList:BuildMasterList()
    ...
    for key, itemObject in pairs(selectedTrade[self.itemsKey]) do
        ...
    end
end
 
TRADESMAN.MyTradeItemsList = XTradeItemsList:New(MyTradeItemsContainer, "MyItems")
TRADESMAN.TheirTradeItemsList = XTradeItemsList:New(TheirTradeItemsContainer, "TheirItems")

Cool, thank you! Let me look this over and get my head around it... I really appreciate this!

One thing I want to point out to hopefully eliminate any confusion I may have caused (maybe I should have just stayed out of it & let him answer :P)

I know merlight kept saying don't overwrite CustomerList:New() ...but, yet that's exactly what I did.
It looks like we both did the same thing, but with a different approach.

Since:

Lua Code:

CustomerList = ZO_SortFilterList:Subclass()

CustomerList already has a New() & an Initialize() function (from ZO_SortFilterList:Subclass()).

I overwrote the CustomerList:New() (from ZO_SortFilterList:Subclass()) function, but then called it in MY New() function.
I call the :New() function I created, which calls the original :New() function, which then calls the original Initialize() function so both the original :New() & :Initialize() both still run.

Lua Code:

function CustomerList:New()
   -- ZO_SortFilterList:New(...) is the function I'm overwriting
   -- So I call it here
   local manager = ZO_SortFilterList.New(self, CustomerListContainer)
...
end

Merlight left the original CustomerList:New() function (from ZO_SortFilterList:Subclass()) and overwrote the CutomerList:Initialize() function, but then he manually called it in his Initialize()
He calls the Original :New() function, which automatically calls the :Initialize() function that he wrote and it calls the original :Initialize() function. So again both the original :New() & :Initialize() functions get ran.

Lua Code:

function CustomerList:Initialize(control)
   -- ZO_SortFilterList:Initialize() is the function he is overwriting
   -- So he calls it here
   ZO_SortFilterList.Initialize(self, control)
...
end

He is right about the hard coding of CustomerListContainer in the code. I didn't think about it, but the same could have been accomplished this way by just passing it to the new function

Lua Code:

function CustomerList:New(control)
    local manager = ZO_SortFilterList.New(self, control)
...
end
TRADESMAN.CustomerList = CustomerList:New(CustomerListContainer)