-<html>
-<head>
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
- <title>The source code</title>
- <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
- <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
-</head>
-<body onload="prettyPrint();">
- <pre class="prettyprint lang-js">/*!
- * Ext JS Library 3.3.1
- * Copyright(c) 2006-2010 Sencha Inc.
- * licensing@sencha.com
- * http://www.sencha.com/license
+<!DOCTYPE html><html><head><title>Sencha Documentation Project</title><link rel="stylesheet" href="../reset.css" type="text/css"><link rel="stylesheet" href="../prettify.css" type="text/css"><link rel="stylesheet" href="../prettify_sa.css" type="text/css"><script type="text/javascript" src="../prettify.js"></script></head><body onload="prettyPrint()"><pre class="prettyprint"><pre><span id='Ext-util.Sorter'>/**
+</span> * @class Ext.util.Sorter
+ * @extends Object
+ * Represents a single sorter that can be applied to a Store
*/
-<div id="cls-Ext.list.Sorter"></div>/**
- * @class Ext.list.Sorter
- * @extends Ext.util.Observable
- * <p>Supporting Class for Ext.list.ListView</p>
- * @constructor
- * @param {Object} config
- */
-Ext.list.Sorter = Ext.extend(Ext.util.Observable, {
- <div id="cfg-Ext.list.Sorter-sortClasses"></div>/**
- * @cfg {Array} sortClasses
- * The CSS classes applied to a header when it is sorted. (defaults to <tt>["sort-asc", "sort-desc"]</tt>)
- */
- sortClasses : ["sort-asc", "sort-desc"],
+Ext.define('Ext.util.Sorter', {
- constructor: function(config){
- Ext.apply(this, config);
- Ext.list.Sorter.superclass.constructor.call(this);
+<span id='Ext-util.Sorter-cfg-property'> /**
+</span> * @cfg {String} property The property to sort by. Required unless {@link #sorter} is provided
+ */
+
+<span id='Ext-util.Sorter-cfg-sorterFn'> /**
+</span> * @cfg {Function} sorterFn A specific sorter function to execute. Can be passed instead of {@link #property}
+ */
+
+<span id='Ext-util.Sorter-cfg-root'> /**
+</span> * @cfg {String} root Optional root property. This is mostly useful when sorting a Store, in which case we set the
+ * root to 'data' to make the filter pull the {@link #property} out of the data object of each item
+ */
+
+<span id='Ext-util.Sorter-cfg-transform'> /**
+</span> * @cfg {Function} transform A function that will be run on each value before
+ * it is compared in the sorter. The function will receive a single argument,
+ * the value.
+ */
+
+<span id='Ext-util.Sorter-cfg-direction'> /**
+</span> * @cfg {String} direction The direction to sort by. Defaults to ASC
+ */
+ direction: "ASC",
+
+ constructor: function(config) {
+ var me = this;
+
+ Ext.apply(me, config);
+
+ //<debug>
+ if (me.property == undefined && me.sorterFn == undefined) {
+ Ext.Error.raise("A Sorter requires either a property or a sorter function");
+ }
+ //</debug>
+
+ me.updateSortFunction();
},
-
- init : function(listView){
- this.view = listView;
- listView.on('render', this.initEvents, this);
+
+<span id='Ext-util.Sorter-method-createSortFunction'> /**
+</span> * @private
+ * Creates and returns a function which sorts an array by the given property and direction
+ * @return {Function} A function which sorts by the property/direction combination provided
+ */
+ createSortFunction: function(sorterFn) {
+ var me = this,
+ property = me.property,
+ direction = me.direction || "ASC",
+ modifier = direction.toUpperCase() == "DESC" ? -1 : 1;
+
+ //create a comparison function. Takes 2 objects, returns 1 if object 1 is greater,
+ //-1 if object 2 is greater or 0 if they are equal
+ return function(o1, o2) {
+ return modifier * sorterFn.call(me, o1, o2);
+ };
},
+
+<span id='Ext-util.Sorter-method-defaultSorterFn'> /**
+</span> * @private
+ * Basic default sorter function that just compares the defined property of each object
+ */
+ defaultSorterFn: function(o1, o2) {
+ var me = this,
+ transform = me.transform,
+ v1 = me.getRoot(o1)[me.property],
+ v2 = me.getRoot(o2)[me.property];
+
+ if (transform) {
+ v1 = transform(v1);
+ v2 = transform(v2);
+ }
- initEvents : function(view){
- view.mon(view.innerHd, 'click', this.onHdClick, this);
- view.innerHd.setStyle('cursor', 'pointer');
- view.mon(view.store, 'datachanged', this.updateSortState, this);
- this.updateSortState.defer(10, this, [view.store]);
+ return v1 > v2 ? 1 : (v1 < v2 ? -1 : 0);
},
-
- updateSortState : function(store){
- var state = store.getSortState();
- if(!state){
- return;
- }
- this.sortState = state;
- var cs = this.view.columns, sortColumn = -1;
- for(var i = 0, len = cs.length; i < len; i++){
- if(cs[i].dataIndex == state.field){
- sortColumn = i;
- break;
- }
- }
- if(sortColumn != -1){
- var sortDir = state.direction;
- this.updateSortIcon(sortColumn, sortDir);
- }
+
+<span id='Ext-util.Sorter-method-getRoot'> /**
+</span> * @private
+ * Returns the root property of the given item, based on the configured {@link #root} property
+ * @param {Object} item The item
+ * @return {Object} The root property of the object
+ */
+ getRoot: function(item) {
+ return this.root == undefined ? item : item[this.root];
},
-
- updateSortIcon : function(col, dir){
- var sc = this.sortClasses;
- var hds = this.view.innerHd.select('em').removeClass(sc);
- hds.item(col).addClass(sc[dir == "DESC" ? 1 : 0]);
+
+ // @TODO: Add docs for these three methods
+ setDirection: function(direction) {
+ var me = this;
+ me.direction = direction;
+ me.updateSortFunction();
},
-
- onHdClick : function(e){
- var hd = e.getTarget('em', 3);
- if(hd && !this.view.disableHeaders){
- var index = this.view.findHeaderIndex(hd);
- this.view.store.sort(this.view.columns[index].dataIndex);
- }
+
+ toggle: function() {
+ var me = this;
+ me.direction = Ext.String.toggle(me.direction, "ASC", "DESC");
+ me.updateSortFunction();
+ },
+
+ updateSortFunction: function() {
+ var me = this;
+ me.sort = me.createSortFunction(me.sorterFn || me.defaultSorterFn);
}
-});
-
-// Backwards compatibility alias
-Ext.ListView.Sorter = Ext.list.Sorter;</pre>
-</body>
-</html>
\ No newline at end of file
+});</pre></pre></body></html>
\ No newline at end of file
git.ithinksw.org / extjs.git / blobdiff