[CLOSED][2.2] TreeSorter's "caseSensitive" must be set for "property" to work

[cornyflake]

If you set the TreeSorter config's "property" to a non-string node attribute, it will throw an error. To fix this you must set "caseSensitive" to true.

Example:

var tree = new Ext.tree.TreePanel({
  root: new Ext.tree.TreeNode({text: 'Kill Babies', children: [
    {valueToSortOn: 1},
    {valueToSortOn: 2}
  ]})
});
// Example 1: Doesn't work
new Ext.tree.TreeSorter(tree, {property: 'valueToSortOn'});
// Example 2: Works!
new Ext.tree.TreeSorter(tree, {property: 'valueToSortOn', caseSensitive: true});

Why?

TreeSorter.js Lines 75-76:

// Note: cs = caseSensitive
var v1 = sortType ? sortType(n1) : (cs ? n1.attributes[p] : n1.attributes[p].toUpperCase());
var v2 = sortType ? sortType(n2) : (cs ? n2.attributes[p] : n2.attributes[p].toUpperCase());

As you can see, without caseSensitive set to true, it calls toUpperCase() on whatever the value is. If it's an integer, etc. which doesn't have that method, it'll crap out.

This has been discussed in the 1.x forums (https://extjs.com/forum/showthread.php?t=9733), but continues into 2.0.

Having to set an unrelated config property to get another to work is unset. Please either fix the code or at least put it in the API documentation.

Thanks!

Blake

[Condor]

I would suggest:

var v1 = sortType ? sortType(n1) : (cs ? n1.attributes[p] : String(n1.attributes[p]).toUpperCase());
var v2 = sortType ? sortType(n2) : (cs ? n2.attributes[p] : String(n2.attributes[p]).toUpperCase());

Note: The code for the sortFn function should be moved from the constructor to the doSort method. That way you can change the sorting options without having to create a new TreeSorter.

[cornyflake]

I would suggest:

var v1 = sortType ? sortType(n1) : (cs ? n1.attributes[p] : String(n1.attributes[p]).toUpperCase());
var v2 = sortType ? sortType(n2) : (cs ? n2.attributes[p] : String(n2.attributes[p]).toUpperCase());

Note: The code for the sortFn function should be moved from the constructor to the doSort method. That way you can change the sorting options without having to create a new TreeSorter.

Condor,

Dates, etc. converted to strings do not sort properly. Thank you for your prompt reply!

[Condor]

That is to be expected. The API docs should also mention that you should set caseSensitive:true if you want to sort on the actualy type.

Or maybe the caseSensitive default should be changed to:

var cs = this.caseSensitive !== false;

[evant]

I think it would be nice to pass in a SortType, same as for a field. Also, a custom sortFn would be good, as the previous poster suggested.

I'll put this as a possible improvement.

[evant]

After reviewing this again, I don't think this is a bug. The TreeSorter provides the opportunity for you to cast the value appropriately, as it says in the docs:

A custom "casting" function used to convert node values before sorting. The function will be called with a single parameter (the Ext.tree.TreeNode being evaluated) and is expected to return the node's sort value cast to the specific data type required for sorting. This could be used, for example, when a node's text (or other attribute) should be sorted as a date or numeric value. See the class description for example usage. Note that if a sortType is specified, any property config will be ignored.

It could be a possible enhancement to allow a Ext.data.SortType, but I'll close this one off for now.

[Condor]

True, I also don't think it's a bug, but I would still recommend changing:

var v1 = sortType ? sortType(n1) : (cs ? n1.attributes[p] : String(n1.attributes[p]).toUpperCase());
var v2 = sortType ? sortType(n2) : (cs ? n2.attributes[p] : String(n2.attributes[p]).toUpperCase());

because otherwise caseSensitive:false could throw a javascript error when the attribute isn't a string.

ps. And the API docs could also use a note that caseSensitive:true causes the attribute to be converted to string before sorting.

[ejatin]

for my app, i am using sortType for my tree.
function in sortType returns me folder's name (records's display_name property), on which i want to sort.
but

var v1 = sortType ? sortType(n1) : (cs ? n1.attributes[p] : ...

will ignore config caseSensitive.

Why shouldnt i use property config is : text property of folder consist number (unread counter of mails)

and if string contains a number, it will be placed at top, and parent tree wont be sorted. (like drafts will be place above Inbox. but inbox(10) will be place above drafts) so property config cannot be used.

hence, when you are using sortType, caseSensitive config is for no use.
this looks like a bug, isnt it ???

[ejatin]

addition to above post

to display unread counter beside folder name, we have to use <span>

so in comparing string with text (if you use property config) symobs '>', '<' will destroy sorting manner.