Properties Methods Events Config Options Direct Link

# Class Ext.tree.TreeSorter

Package: | Ext.tree
Defined In: | TreeSorter.js
Class: | TreeSorter
Extends: | Object

Provides sorting of nodes in a Ext.tree.TreePanel. The TreeSorter automatically monitors events on the associated TreePanel that might affect the tree's sort order (beforechildrenrendered, append, insert and textchange). Example usage:

    new Ext.tree.TreeSorter(myTree, {
        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") | 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
| 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 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
--- | ---
| TreeSorter( `TreePanel tree`, `Object config` ) Parameters: `tree` : TreePanel `config` : Object Returns: `` | TreeSorter

## Public Events

This class has no public events.