ZO_Helpers

[Argusus]

I saw in Zgoo that there was a "Zo_BinarySearch" is there anywhere to find more docs on this or example uses?

[merlight]

I remember when I wanted to use it I read the code and concluded it was broken. So I wrote my own. Well, it might be me having a bad day and reading the code wrong.

But even if it actually worked, it's badly designed. Unlike table.sort, which expects a comparator that takes 2 arguments and returns a boolean (basically operator '<'; you need to have a sorted table in order to use binary search), zo_binarysearch expects a comparator that takes 3 arguments and returns numeric difference (similar to perl's operator '<=>'; the third argument is index, which is totally irrelevant, but they still use it in their default broken comparator instead of the right-hand value). So in the end, you'd need to write two comparators - one for sorting and another for searching - awful design.

[Argusus]

Originally Posted by merlight I remember when I wanted to use it I read the code and concluded it was broken. So I wrote my own. Well, it might be me having a bad day and reading the code wrong. But even if it actually worked, it's badly designed. Unlike table.sort, which expects a comparator that takes 2 arguments and returns a boolean (basically operator '<'; you need to have a sorted table in order to use binary search), zo_binarysearch expects a comparator that takes 3 arguments and returns numeric difference (similar to perl's operator '<=>'; the third argument is index, which is totally irrelevant, but they still use it in their default broken comparator instead of the right-hand value). So in the end, you'd need to write two comparators - one for sorting and another for searching - awful design.

Ah, doesn't surprise me... too much mystery in the addon world right now. The post really relates to me wanting to sort the "masterList" alphabetically by a column when the BuildMasterList is called. it doesn't seem to be doing this by default so maybe i'm missing something there. I was thinking I could sort the table THEN add the items to the masterList object so it sorted by my first column (UnitName) by default.

[merlight]

You don't need to sort anything in BuildMasterList. There's SortScrollList for that, it's called after the list is filtered to sort only items that pass the filter; and also when sort order changes, the list is not rebuilt, just sorted again. I'm looking into SLE and it looks like everything's in place.

Try this in UnitList:Initialize():

units.sortHeaderGroup:SelectHeaderByKey("name", ZO_SortHeaderGroup.SUPPRESS_CALLBACKS)

edited: wrong member name

[Argusus]

Originally Posted by merlight You don't need to sort anything in BuildMasterList. There's SortScrollList for that, it's called after the list is filtered to sort only items that pass the filter; and also when sort order changes, the list is not rebuilt, just sorted again. I'm looking into SLE and it looks like everything's in place. Try this in UnitList:Initialize(): units.sortHeaderGroup:SelectHeaderByKey("name", ZO_SortHeaderGroup.SUPPRESS_CALLBACKS) edited: wrong member name

function UnitList:Initialize()
 	self.masterList = {}
 	ZO_ScrollList_AddDataType(self.list, 1, "UnitRow", 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, UnitList.SORT_KEYS, self.currentSortOrder) end
	self:RefreshData()
end

My Current code looks like the attached image, should I put this at the end of the method or where?

[merlight]

I should read more carefully before pasting lines from different places. Now I think it should not suppress the callback, because it sets currentSortKey and currentSortOrder, which are then used in sortFunction.

I'd place it right before RefreshData call, without SUPPRESS_CALLBACK:

function UnitList:Initialize()
    self.masterList = {}
    ZO_ScrollList_AddDataType(self.list, 1, "UnitRow", 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, UnitList.SORT_KEYS, self.currentSortOrder) end
    self.sortHeaderGroup:SelectHeaderByKey("name")
    self:RefreshData()
end

I'm still wondering how it could work without setting a sort key. I'd expect it to throw a "nil used as table key" error when there are 2 or more items in the list.

[Argusus]

Originally Posted by merlight I should read more carefully before pasting lines from different places. Now I think it should not suppress the callback, because it sets currentSortKey and currentSortOrder, which are then used in sortFunction. I'd place it right before RefreshData call, without SUPPRESS_CALLBACK: function UnitList:Initialize()     self.masterList = {}     ZO_ScrollList_AddDataType(self.list, 1, "UnitRow", 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, UnitList.SORT_KEYS, self.currentSortOrder) end     self.sortHeaderGroup:SelectHeaderByKey("name")     self:RefreshData() end I'm still wondering how it could work without setting a sort key. I'd expect it to throw a "nil used as table key" error when there are 2 or more items in the list.

Worked like a charm! thank you.

[Argusus]

Originally Posted by merlight I should read more carefully before pasting lines from different places. Now I think it should not suppress the callback, because it sets currentSortKey and currentSortOrder, which are then used in sortFunction. I'd place it right before RefreshData call, without SUPPRESS_CALLBACK: function UnitList:Initialize()     self.masterList = {}     ZO_ScrollList_AddDataType(self.list, 1, "UnitRow", 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, UnitList.SORT_KEYS, self.currentSortOrder) end     self.sortHeaderGroup:SelectHeaderByKey("name")     self:RefreshData() end I'm still wondering how it could work without setting a sort key. I'd expect it to throw a "nil used as table key" error when there are 2 or more items in the list.

is there a "descending" version of that by chance?

[Garkin]

Originally Posted by skobyjay is there a "descending" version of that by chance?

sort order is the last argument passed to the:
ZO_TableOrderingFunction(entry1, entry2, sortKey, sortKeys, sortOrder)

sortOrder can be either ZO_SORT_ORDER_UP (true) or ZO_SORT_ORDER_DOWN (false)

In the ScrollListExample sort order could be set directly:

self.sortOrder = ZO_SORT_ORDER_DOWN

or using the OnSortHeaderClicked(key, order) method inherited from the main class ZO_SortFilterList:

self:OnSortHeaderClicked("name", ZO_SORT_ORDER_DOWN)

Changed code to use direct access to sort order:

function UnitList:Initialize()
    self.masterList = {}
    ZO_ScrollList_AddDataType(self.list, 1, "UnitRow", 30, function(control, data) self:SetupUnitRow(control, data) end)
    ZO_ScrollList_EnableHighlight(self.list, "ZO_ThinListHighlight")
    self.currentSortKey = "name"
    self.currentSortOrder = ZO_SORT_ORDER_DOWN
    self.sortFunction = function(listEntry1, listEntry2) return ZO_TableOrderingFunction(listEntry1.data, listEntry2.data, self.currentSortKey, UnitList.SORT_KEYS, self.currentSortOrder) end
    self:RefreshData()
end

Changed code to use OnSortHeaderClicked:

function UnitList:Initialize()
    self.masterList = {}
    ZO_ScrollList_AddDataType(self.list, 1, "UnitRow", 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, UnitList.SORT_KEYS, self.currentSortOrder) end
    self:SetLockedForUpdates(true) --lock for updates, so list will be refreshed only once
    self:OnSortHeaderClicked("name", ZO_SORT_ORDER_DOWN)
    self:RefreshData()
    self:SetLockedForUpdates(false) --when unlocked, all pending refresh functions will be called
end

[Argusus]

Originally Posted by Garkin sort order is the last argument passed to the: ZO_TableOrderingFunction(entry1, entry2, sortKey, sortKeys, sortOrder) sortOrder can be either ZO_SORT_ORDER_UP (true) or ZO_SORT_ORDER_DOWN (false)

if i change it there does that break the sort for the headers? I just want a "default" decending sort. The code below gives me asc sorting, is there a "decending" equivalent of the statement below I can use in the Initialize method.

self.sortHeaderGroup:SelectHeaderByKey("name")

[Garkin]

I have edited my post to add some sample code. Descending order will be probably ZO_SORT_ORDER_DOWN.

[Argusus]

Originally Posted by Garkin I have edited my post to add some sample code. Descending order will be probably ZO_SORT_ORDER_DOWN.

great, I will give that a shot! thanks.

[merlight]

I did not suggest direct assignment because I was not sure the headers control would not get confused.

Originally Posted by skobyjay The code below gives me asc sorting, is there a "decending" equivalent of the statement below I can use in the Initialize method. self.sortHeaderGroup:SelectHeaderByKey("name")

SelectHeaderByKey calls the same handler that's called when you click a header. If you click the same header again, it alternates between ascending/descending order.

-- setup sortHeaderGroup to order by name, without telling the owner (suppress callbacks)
self.sortHeaderGroup:SelectHeaderByKey("name", ZO_SortHeaderGroup.SUPPRESS_CALLBACKS)
-- switch to descending order and tell the owner
self.sortHeaderGroup:SelectHeaderByKey("name")

[Argusus]

Originally Posted by Garkin I have edited my post to add some sample code. Descending order will be probably ZO_SORT_ORDER_DOWN.

Looks like the XML defintion of the ZO_SORT_ORDER_DOWN is honored when the sort is called. Via self.sortHeaderGroup:SelectHeaderByKey("name")

[merlight]

Originally Posted by skobyjay Looks like the XML defintion of the ZO_SORT_ORDER_DOWN is honored when the sort is called. Via self.sortHeaderGroup:SelectHeaderByKey("name")

You nailed it. I didn't expect that to be set in the XML.

ZO_SortHeader_Initialize(self, "Name", "name", ZO_SORT_ORDER_UP, TEXT_ALIGN_LEFT, "ZoFontGameLargeBold")

ZO_SortHeader_Initialize is certainly the best place to set the default order. That way when you click on another header, and later go back to Name, it'll use your desired default.