PropertiesTreeSorterTreeGridSorter
Class CQ.tree.TreeGridSorter
| Package: | CQ.tree |
| Class: | TreeGridSorter |
| Extends: | CQ.Ext.tree.TreeSorter |
| Clientlib: | cq.widgets |
Provides sorting of nodes in a CQ.tree.TreeGrid. The TreeGridSorter automatically monitors events on the
associated TreeGrid that might affect the tree's sort order (beforechildrenrendered, append, insert and textchange).
Example usage:
new CQ.tree.TreeGridSorter(myTreeGrid, {
folderSort: true,
dir: "desc",
sortType: function(node) {
// sort by a custom, typed attribute:
return parseInt(node.id, 10);
}
});Config Options
| Config Options | Defined By | |
|---|---|---|
|
caseSensitive : Boolean
true for case-sensitive sort (defaults to false)
|
TreeSorter | |
|
dir : String
The direction to sort ("asc" or "desc," case-insensitive, defaults to "asc")
|
TreeSorter | |
|
folderSort : Boolean
True to sort leaf nodes under non-leaf nodes (defaults to false)
|
TreeSorter | |
|
leafAttr : String The attribute used to determine leaf nodes when folderSort = true (defaults to "leaf")
The attribute used to determine leaf nodes when folderSort = true (defaults to "leaf")
|
TreeSorter | |
|
property : String The named attribute on the node to sort by (defaults to "text"). Note that this property is only used if no sortType ...
The named attribute on the node to sort by (defaults to "text"). Note that this property is only used if no sortType function is specified, otherwise it is ignored.
|
TreeSorter | |
|
sortAscText : String The text displayed in the 'Sort Ascending' menu item (defaults to 'Sort Ascending')
The text displayed in the 'Sort Ascending' menu item (defaults to 'Sort Ascending')
|
TreeGridSorter | |
|
sortClasses : Array The CSS classes applied to a header when it is sorted. (defaults to ['sort-asc', 'sort-desc'])
The CSS classes applied to a header when it is sorted. (defaults to ['sort-asc', 'sort-desc'])
|
TreeGridSorter | |
|
sortDescText : String The text displayed in the 'Sort Descending' menu item (defaults to 'Sort Descending')
The text displayed in the 'Sort Descending' menu item (defaults to 'Sort Descending')
|
TreeGridSorter | |
|
sortType : Function A custom "casting" function used to convert node values before sorting. The function will be called with a single par...
A custom "casting" function used to convert node values before sorting. The function will be called with a single parameter (the CQ.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.
|
TreeSorter | |
Public Properties
This class has no public properties.
Public Methods
| Method | Defined By | |
|---|---|---|
TreeGridSorter( TreeGrid tree, Object config )
Parameters:
|
TreeGridSorter | |
Public Events
This class has no public events.