d74529387f5689a1c3426c92ddc9c23781ad49dfLuke SmithYUI.add('datatable-sort-deprecated', function(Y) {
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * Plugs DataTable with sorting functionality.
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * @module datatable
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * @submodule datatable-sort
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * Adds column sorting to DataTable.
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * @class DataTableSort
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * @extends Plugin.Base
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smithvar YgetClassName = Y.ClassNameManager.getClassName,
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith //TODO: Don't use hrefs - use tab/arrow/enter
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith TEMPLATE = '<a class="{link_class}" title="{link_title}" href="{link_href}">{value}</a>';
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith DataTableSort.superclass.constructor.apply(this, arguments);
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith/////////////////////////////////////////////////////////////////////////////
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith// STATIC PROPERTIES
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith/////////////////////////////////////////////////////////////////////////////
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * The namespace for the plugin. This will be the property on the host which
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * references the plugin instance.
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * @property NS
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * @type String
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * @value "sort"
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * Class name.
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * @property NAME
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * @type String
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * @value "dataTableSort"
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith/////////////////////////////////////////////////////////////////////////////
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith// ATTRIBUTES
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith/////////////////////////////////////////////////////////////////////////////
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * @attribute trigger
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * @description Defines the trigger that causes a column to be sorted:
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * {event, selector}, where "event" is an event type and "selector" is
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * is a node query selector.
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * @type Object
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * @default {event:"click", selector:"th"}
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * @writeOnce "initOnly"
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * @attribute lastSortedBy
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * @description Describes last known sort state: {key,dir}, where
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * "key" is column key and "dir" is either "asc" or "desc".
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * @type Object
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * @attribute template
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * @description Tokenized markup template for TH sort element.
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * @type String
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * @default '<a class="{link_class}" title="{link_title}" href="{link_href}">{value}</a>'
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * Strings used in the UI elements.
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * The strings used are defaulted from the datatable-sort language pack
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * for the language identified in the YUI "lang" configuration (which
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * defaults to "en").
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * Configurable strings are "sortBy" and "reverseSortBy", which are
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * assigned to the sort link's title attribute.
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * @attribute strings
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * @type {Object}
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith valueFn: function () { return Y.Intl.get('datatable-sort-deprecated'); }
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith/////////////////////////////////////////////////////////////////////////////
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith/////////////////////////////////////////////////////////////////////////////
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith /////////////////////////////////////////////////////////////////////////////
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith /////////////////////////////////////////////////////////////////////////////
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * Initializer.
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * @method initializer
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * @param config {Object} Config object.
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith dt.get("recordset").plug(Y.Plugin.RecordsetSort, {dt: dt});
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith // Wrap link around TH value
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith this.doBefore("_createTheadThNode", this._beforeCreateTheadThNode);
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith // Add class
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith this.doBefore("_attachTheadThNode", this._beforeAttachTheadThNode);
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith this.doBefore("_attachTbodyTdNode", this._beforeAttachTbodyTdNode);
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith // Attach trigger handlers
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith dt.delegate(trigger.event, Y.bind(this._onEventSortColumn,this), trigger.selector);
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith // Attach UI hooks
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith this._uiSetLastSortedBy(e.prevVal, e.newVal, dt);
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith //dt.after("recordset:mutation", function() {//reset lastSortedBy});
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith //add Column sortFn ATTR
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith // Update UI after the fact (render-then-plug case)
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith this._uiSetLastSortedBy(null, this.get("lastSortedBy"), dt);
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * @method _setLastSortedBy
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * @description Normalizes lastSortedBy
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * @param val {String | Object} {key, dir} or "key"
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * @return {key, dir, notdir}
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith return null;
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * Updates sort UI.
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * @method _uiSetLastSortedBy
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * @param val {Object} New lastSortedBy object {key,dir}.
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * @param dt {Y.DataTable.Base} Host.
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * @protected
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith _uiSetLastSortedBy: function(prevVal, newVal, dt) {
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith prevClass = prevVal && dt.getClassName(prevVal.dir),
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith newClass = newVal && dt.getClassName(newVal.dir),
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith // Clear previous UI
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith sortArrow.set('title', fromTemplate(strings.sortBy, {
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith tbodyNode.all("." + YgetClassName(COLUMN, prevColumn.get("id")))
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith // Add new sort UI
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith sortLabel = (newVal.dir === ASC) ? "reverseSortBy" : "sortBy";
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith sortArrow.set('title', fromTemplate(strings[sortLabel], {
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith tbodyNode.all("." + YgetClassName(COLUMN, newColumn.get("id")))
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * Before header cell element is created, inserts link markup around {value}.
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * @method _beforeCreateTheadThNode
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * @param o {Object} {value, column, tr}.
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * @protected
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith link_title: Y.Lang.sub(this.get('strings.' + sortLabel), {
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * Before header cell element is attached, sets applicable class names.
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * @method _beforeAttachTheadThNode
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * @param o {Object} {value, column, tr}.
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * @protected
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith // This Column is sortable
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith o.th.addClass(YgetClassName(DATATABLE, "sortable"));
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith // This Column is currently sorted
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith o.th.replaceClass(YgetClassName(DATATABLE, notdir), YgetClassName(DATATABLE, dir));
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * Before header cell element is attached, sets applicable class names.
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * @method _beforeAttachTbodyTdNode
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * @param o {Object} {record, column, tr, headers, classnames, value}.
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * @protected
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith // This Column is sortable
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith o.td.addClass(YgetClassName(DATATABLE, "sortable"));
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith // This Column is currently sorted
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith o.td.replaceClass(YgetClassName(DATATABLE, notdir), YgetClassName(DATATABLE, dir));
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * In response to the "trigger" event, sorts the underlying Recordset and
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * updates the lastSortedBy attribute.
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * @method _onEventSortColumn
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * @param o {Object} {value, column, tr}.
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith * @protected
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith //TODO: normalize e.currentTarget to TH
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith column = table.get("columnset").idHash[e.currentTarget.get("id")],
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith desc = (lastSort.key === key && lastSort.dir === ASC);
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith table.get("recordset").sort.sort(field, desc, sorter);
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke SmithY.namespace("Plugin").DataTableSort = DataTableSort;
d74529387f5689a1c3426c92ddc9c23781ad49dfLuke Smith}, '@VERSION@' ,{requires:['datatable-base-deprecated','plugin','recordset-sort'], lang:['en']});