slickgrid 2.4.5 → 2.4.14

data/vendor/assets/javascripts/slickgrid/groupitemmetadataprovider.js

@@ -38,7 +38,8 @@
       toggleCollapsedCssClass: "collapsed",
       enableExpandCollapse: true,
       groupFormatter: defaultGroupCellFormatter,
-      totalsFormatter: defaultTotalsCellFormatter
+      totalsFormatter: defaultTotalsCellFormatter,
+      includeHeaderTotals: false
     };
 
     options = $.extend(true, {}, _defaults, options);
@@ -137,13 +138,15 @@
     }
 
     function getGroupRowMetadata(item) {
+      var groupLevel = item && item.level;
       return {
         selectable: false,
         focusable: options.groupFocusable,
-        cssClasses: options.groupCssClass,
+        cssClasses: options.groupCssClass + ' slick-group-level-' + groupLevel,
+        formatter: options.includeHeaderTotals && options.totalsFormatter,
         columns: {
           0: {
-            colspan: "*",
+            colspan: options.includeHeaderTotals?"1":"*",
             formatter: options.groupFormatter,
             editor: null
           }
@@ -152,10 +155,11 @@
     }
 
     function getTotalsRowMetadata(item) {
+      var groupLevel = item && item.group && item.group.level;      
       return {
         selectable: false,
         focusable: options.totalsFocusable,
-        cssClasses: options.totalsCssClass,
+        cssClasses: options.totalsCssClass + ' slick-group-level-' + groupLevel,
         formatter: options.totalsFormatter,
         editor: null
       };

data/vendor/assets/javascripts/slickgrid/plugins/cellcopymanager.js

@@ -35,7 +35,7 @@
 
         if (e.which == 67 && (e.ctrlKey || e.metaKey)) {
           ranges = _grid.getSelectionModel().getSelectedRanges();
-          if (ranges.length != 0) {
+          if (ranges.length !== 0) {
             e.preventDefault();
             _copiedRanges = ranges;
             markCopySelection(ranges);

data/vendor/assets/javascripts/slickgrid/plugins/cellexternalcopymanager.js

@@ -149,14 +149,14 @@
       var clipText = ta.value;
       var clipRows = clipText.split(/[\n\f\r]/);
       // trim trailing CR if present
-      if (clipRows[clipRows.length - 1]=="") { clipRows.pop(); }
+      if (clipRows[clipRows.length - 1]==="") { clipRows.pop(); }
       
       var clippedRange = [];
       var j = 0;
       
       _bodyElement.removeChild(ta);
       for (var i=0; i<clipRows.length; i++) {
-        if (clipRows[i]!="")
+        if (clipRows[i]!=="")
           clippedRange[j++] = clipRows[i].split("\t");
           else
           clippedRange[i] = [""];
@@ -264,7 +264,7 @@
             'fromRow': activeRow,
             'toCell': activeCell+this.w-1,
             'toRow': activeRow+this.h-1
-          }
+          };
 
           this.markCopySelection([bRange]);
           _grid.getSelectionModel().setSelectedRanges([bRange]);
@@ -300,7 +300,7 @@
             'fromRow': activeRow,
             'toCell': activeCell+this.w-1,
             'toRow': activeRow+this.h-1
-          }
+          };
 
           this.markCopySelection([bRange]);
           _grid.getSelectionModel().setSelectedRanges([bRange]);
@@ -342,7 +342,7 @@
             _onCopyInit.call();
           }
           ranges = _grid.getSelectionModel().getSelectedRanges();
-          if (ranges.length != 0) {
+          if (ranges.length !== 0) {
             _copiedRanges = ranges;
             markCopySelection(ranges);
             _self.onCopyCells.notify({ranges: ranges});
@@ -357,7 +357,7 @@
                     var clipTextCells = [];
                     var dt = _grid.getDataItem(i);
                     
-                    if (clipTextRows == "" && _options.includeHeaderWhenCopying) {
+                    if (clipTextRows === "" && _options.includeHeaderWhenCopying) {
                         var clipTextHeaders = [];
                         for (var j = range.fromCell; j < range.toCell + 1 ; j++) {
                             if (columns[j].name.length > 0)

data/vendor/assets/javascripts/slickgrid/plugins/checkboxselectcolumn.js

@@ -26,6 +26,11 @@
 
     var _options = $.extend(true, {}, _defaults, options);
 
+    // user could override the checkbox icon logic from within the options or after instantiating the plugin
+    if(typeof _options.selectableOverride === 'function') {
+      selectableOverride(_options.selectableOverride);
+    }
+
     function init(grid) {
       _grid = grid;
       _handler
@@ -37,7 +42,7 @@
         addCheckboxToFilterHeaderRow(grid);
       }
       if (!_options.hideInColumnTitleRow) {
-        _handler.subscribe(_grid.onHeaderClick, handleHeaderClick)
+        _handler.subscribe(_grid.onHeaderClick, handleHeaderClick);
       }
     }
 
@@ -83,7 +88,7 @@
 
     function handleSelectedRowsChanged(e, args) {
       var selectedRows = _grid.getSelectedRows();
-      var lookup = {}, row, i;
+      var lookup = {}, row, i, k;
       var disabledCount = 0;
       if (typeof _selectableOverride === 'function') {
         for (k = 0; k < _grid.getDataLength(); k++) {
@@ -173,7 +178,7 @@
 
       if (_selectedRowsLookup[row]) {
         _grid.setSelectedRows($.grep(_grid.getSelectedRows(), function (n) {
-          return n != row
+          return n != row;
         }));
       } else {
         _grid.setSelectedRows(_grid.getSelectedRows().concat(row));
@@ -199,7 +204,7 @@
         }
       }
       _grid.setSelectedRows($.grep(_grid.getSelectedRows(), function (n) {
-        return removeRows.indexOf(n) < 0
+        return removeRows.indexOf(n) < 0;
       }));
     }
 
@@ -267,7 +272,7 @@
           $("<span id='filter-checkbox-selectall-container'><input id='header-filter-selector" + _selectAll_UID + "' type='checkbox'><label for='header-filter-selector" + _selectAll_UID + "'></label></span>")
             .appendTo(args.node)
             .on('click', function (evnt) {
-              handleHeaderClick(evnt, args)
+              handleHeaderClick(evnt, args);
             });
         }
       });

data/vendor/assets/javascripts/slickgrid/plugins/draggablegrouping.js

@@ -81,11 +81,11 @@
         var node = args.node;
         if (!$.isEmptyObject(column.grouping)) {
           var groupableIcon = $("<span class='slick-column-groupable' />");
-          if(options.groupIconCssClass) groupableIcon.addClass(options.groupIconCssClass)
-          if(options.groupIconImage) groupableIcon.css("background", "url(" + options.groupIconImage + ") no-repeat center center");
+        if(options.groupIconCssClass) { groupableIcon.addClass(options.groupIconCssClass); }
+          if(options.groupIconImage) { groupableIcon.css("background", "url(" + options.groupIconImage + ") no-repeat center center"); }
           $(node).css('cursor', 'pointer').append(groupableIcon);
         }
-      })
+      });
 
       for (var i = 0; i < _gridColumns.length; i++) {
         var columnId = _gridColumns[i].field;
@@ -227,9 +227,9 @@
           if (e.id == columnid) {
             if (e.grouping != null && !$.isEmptyObject(e.grouping)) {
               var entry = $("<div id='" + _gridUid + e.id + "_entry' data-id='" + e.id + "' class='slick-dropped-grouping'>");
-              var groupText = $("<div style='display: inline-flex'>" + column.text() + "</div>")
+              var groupText = $("<div style='display: inline-flex'>" + column.text() + "</div>");
               groupText.appendTo(entry);
-              var groupRemoveIcon = $("<div class='slick-groupby-remove'>&nbsp;</div>")
+              var groupRemoveIcon = $("<div class='slick-groupby-remove'>&nbsp;</div>");
               if(options.deleteIconCssClass) groupRemoveIcon.addClass(options.deleteIconCssClass);
               if(options.deleteIconImage) groupRemoveIcon.css("background", "url(" + options.deleteIconImage + ") no-repeat center right");
               if(!options.deleteIconCssClass && !options.deleteIconImage) groupRemoveIcon.addClass('slick-groupby-remove-image');
@@ -260,8 +260,8 @@
     }
 
     function setDroppedGroups(groupingInfo) {
-      groupingInfos = (groupingInfo instanceof Array) ? groupingInfo : [groupingInfo];
-      dropboxPlaceholder.hide()
+      var groupingInfos = (groupingInfo instanceof Array) ? groupingInfo : [groupingInfo];
+      dropboxPlaceholder.hide();
       for (var i = 0; i < groupingInfos.length; i++) {
         var column = $(_grid.getHeaderColumn(groupingInfos[i]));
         handleGroupByDrop(dropbox, column);
@@ -272,7 +272,7 @@
       updateGroupBy("clear-all");
       dropbox.find(".slick-dropped-grouping").remove();
       groupToggler.css("display", "none");
-      dropboxPlaceholder.show()
+      dropboxPlaceholder.show();
     }
 
     function removeFromArray(arr) {
@@ -295,14 +295,14 @@
         groupby[e.id] = e;
       });
       removeFromArray(columnsGroupBy, groupby[id]);
-      if(columnsGroupBy.length == 0){
+      if(columnsGroupBy.length === 0){
         dropboxPlaceholder.show();
       }
       updateGroupBy("remove-group");
     }
 
     function updateGroupBy(originator) {
-      if (columnsGroupBy.length == 0) {
+      if (columnsGroupBy.length === 0) {
         _dataView.setGrouping([]);
         onGroupChanged.notify({ caller: originator, groupColumns: [] });
         return;
@@ -315,7 +315,7 @@
       /*
       collapseAllGroups();
       */
-      onGroupChanged.notify({ caller: originator, groupColumns: groupingArray})
+      onGroupChanged.notify({ caller: originator, groupColumns: groupingArray});
     }
     
     // Public API

data/vendor/assets/javascripts/slickgrid/plugins/headermenu.js

@@ -275,7 +275,7 @@
 
       hideMenu();
 
-      if (command != null && command != '') {
+      if (command != null && command !== '') {
         _self.onCommand.notify({
             "grid": _grid,
             "column": columnDef,

data/vendor/assets/javascripts/slickgrid/plugins/rowdetailview.js

@@ -10,19 +10,21 @@
  * AVAILABLE ROW DETAIL OPTIONS:
  *    cssClass:               A CSS class to be added to the row detail
  *    expandedClass:          Extra classes to be added to the expanded Toggle
+ *    expandableOverride:     callback method that user can override the default behavior of making every row an expandable row (the logic to show or not the expandable icon).
  *    collapsedClass:         Extra classes to be added to the collapse Toggle
  *    loadOnce:               Defaults to false, when set to True it will load the data once and then reuse it.
  *    preTemplate:            Template that will be used before the async process (typically used to show a spinner/loading)
  *    postTemplate:           Template that will be loaded once the async function finishes
  *    process:                Async server function call
  *    panelRows:              Row count to use for the template panel
+ *    singleRowExpand:        Defaults to false, limit expanded row to 1 at a time.
  *    useRowClick:            Boolean flag, when True will open the row detail on a row click (from any column), default to False
  *    keyPrefix:              Defaults to '_', prefix used for all the plugin metadata added to the item object (meta e.g.: padding, collapsed, parent)
  *    collapseAllOnSort:      Defaults to true, which will collapse all row detail views when user calls a sort. Unless user implements a sort to deal with padding
  *    saveDetailViewOnScroll: Defaults to true, which will save the row detail view in a cache when it detects that it will become out of the viewport buffer
  *    useSimpleViewportCalc:  Defaults to false, which will use simplified calculation of out or back of viewport visibility
  *
- * AVAILABLE PUBLIC OPTIONS:
+ * AVAILABLE PUBLIC METHODS:
  *    init:                 initiliaze the plugin
  *    expandableOverride:   callback method that user can override the default behavior of making every row an expandable row (the logic to show or not the expandable icon).
  *    destroy:              destroy the plugin and it's events
@@ -92,6 +94,7 @@
     var _grid;
     var _gridOptions;
     var _gridUid;
+    var _dataView;
     var _expandableOverride = null;
     var _self = this;
     var _lastRange = null;
@@ -108,6 +111,7 @@
       loadOnce: false,
       collapseAllOnSort: true,
       saveDetailViewOnScroll: true,
+      singleRowExpand: false,
       useSimpleViewportCalc: false,
       alwaysRenderColumn: true,
       toolTip: '',
@@ -119,6 +123,11 @@
     var _rowIdsOutOfViewport = [];
     var _options = $.extend(true, {}, _defaults, options);
 
+    // user could override the expandable icon logic from within the options or after instantiating the plugin
+    if(typeof _options.expandableOverride === 'function') {
+      expandableOverride(_options.expandableOverride);
+    }
+
     /**
      * Initialize the plugin, which requires user to pass the SlickGrid Grid object
      * @param grid: SlickGrid Grid object
@@ -192,6 +201,9 @@
     /** set or change some of the plugin options */
     function setOptions(options) {
       _options = $.extend(true, {}, _options, options);
+      if (_options && _options.singleRowExpand) {
+        collapseAll();
+      }
     }
 
     /** Find a value in an array and return the index when (or -1 when not found) */
@@ -453,6 +465,10 @@
 
     /** Expand a row given the dataview item that is to be expanded */
     function expandDetailView(item) {
+      if (_options && _options.singleRowExpand) {
+        collapseAll();
+      }
+
       item[_keyPrefix + 'collapsed'] = false;
       _expandedRows.push(item);
 
@@ -499,7 +515,7 @@
     function subscribeToOnAsyncResponse() {
       _self.onAsyncResponse.subscribe(function (e, args) {
         if (!args || (!args.item && !args.itemDetail)) {
-          throw 'Slick.RowDetailView plugin requires the onAsyncResponse() to supply "args.item" property.'
+          throw 'Slick.RowDetailView plugin requires the onAsyncResponse() to supply "args.item" property.';
         }
 
         // we accept item/itemDetail, just get the one which has data
@@ -554,7 +570,7 @@
       item[_keyPrefix + 'offset'] = offset;
 
       return item;
-    }
+    };
 
     //////////////////////////////////////////////////////////////
     // create the detail ctr node. this belongs to the dev & can be custom-styled as per
@@ -596,20 +612,20 @@
     }
 
     /** The Formatter of the toggling icon of the Row Detail */
-    function detailSelectionFormatter(row, cell, value, columnDef, dataContext) {
+    function detailSelectionFormatter(row, cell, value, columnDef, dataContext, grid) {
       if (!checkExpandableOverride(row, dataContext, grid)) {
         return null;
       } else {
         if (dataContext[_keyPrefix + 'collapsed'] == undefined) {
-          dataContext[_keyPrefix + 'collapsed'] = true,
-            dataContext[_keyPrefix + 'sizePadding'] = 0,     //the required number of pading rows
-            dataContext[_keyPrefix + 'height'] = 0,     //the actual height in pixels of the detail field
-            dataContext[_keyPrefix + 'isPadding'] = false,
-            dataContext[_keyPrefix + 'parent'] = undefined,
-            dataContext[_keyPrefix + 'offset'] = 0
+          dataContext[_keyPrefix + 'collapsed'] = true;
+          dataContext[_keyPrefix + 'sizePadding'] = 0;     //the required number of pading rows
+          dataContext[_keyPrefix + 'height'] = 0;     //the actual height in pixels of the detail field
+          dataContext[_keyPrefix + 'isPadding'] = false;
+          dataContext[_keyPrefix + 'parent'] = undefined;
+          dataContext[_keyPrefix + 'offset'] = 0;
         }
 
-        if (dataContext[_keyPrefix + 'isPadding'] == true) {
+        if (dataContext[_keyPrefix + 'isPadding']) {
           // render nothing
         }
         else if (dataContext[_keyPrefix + 'collapsed']) {
@@ -645,7 +661,7 @@
           html.push('<div class="dynamic-cell-detail cellDetailView_', dataContext.id, '" ');   //apply custom css to detail
           html.push('style="height:', outterHeight, 'px;'); //set total height of padding
           html.push('top:', rowHeight, 'px">');             //shift detail below 1st row
-          html.push('<div class="detail-container detailViewContainer_', dataContext.id, '" style="min-height:' + dataContext[_keyPrefix + 'height'] + 'px">'); //sub ctr for custom styling
+          html.push('<div class="detail-container detailViewContainer_', dataContext.id, '">'); //sub ctr for custom styling
           html.push('<div class="innerDetailView_', dataContext.id, '">', dataContext[_keyPrefix + 'detailContent'], '</div></div>');
           // &omit a final closing detail container </div> that would come next
 

data/vendor/assets/javascripts/slickgrid/plugins/rowmovemanager.js

@@ -52,7 +52,7 @@
 
       var selectedRows = _grid.getSelectedRows();
 
-      if (selectedRows.length == 0 || $.inArray(cell.row, selectedRows) == -1) {
+      if (selectedRows.length === 0 || $.inArray(cell.row, selectedRows) == -1) {
         selectedRows = [cell.row];
         _grid.setSelectedRows(selectedRows);
       }

data/vendor/assets/javascripts/slickgrid/plugins/rowselectionmodel.js

@@ -104,7 +104,7 @@
       && (e.which == Slick.keyCode.UP || e.which == Slick.keyCode.DOWN)) {
         var selectedRows = getSelectedRows();
         selectedRows.sort(function (x, y) {
-          return x - y
+          return x - y;
         });
 
         if (!selectedRows.length) {

data/vendor/assets/javascripts/slickgrid/plugins/state.js

@@ -0,0 +1,153 @@
+(function ($) {
+  // register namespace
+  $.extend(true, window, {
+    Slick: {
+      State: State
+    }
+  });
+
+  var localStorageWrapper = function() {
+    var localStorage = window.localStorage;
+
+    if (typeof localStorage === 'undefined') {
+      console.error('localStorage is not available. slickgrid statepersistor disabled.');
+    }
+
+    return {
+      get: function(key) {
+        return $.Deferred(function(dfd) {
+          if (!localStorage) return dfd.reject("missing localStorage");
+          try {
+            var d = localStorage.getItem(key);
+            if (d) {
+              return dfd.resolve(JSON.parse(d));
+            }
+            dfd.resolve();
+          }
+          catch (exc) {
+            dfd.reject(exc);
+          }
+        });
+      },
+      set: function(key, obj) {
+        if (!localStorage) return;
+        if (typeof obj !== 'undefined') {
+          obj = JSON.stringify(obj);
+        }
+        localStorage.setItem(key, obj);
+      }
+    };
+  };
+
+  var defaults = {
+    key_prefix: "slickgrid:",
+    storage: new localStorageWrapper()
+  };
+
+  function State(options) {
+    options = $.extend(true, {}, defaults, options);
+
+    var _grid, _cid,
+      _store = options.storage,
+      onStateChanged = new Slick.Event();
+
+    function init(grid) {
+      _grid = grid;
+      _cid = grid.cid || options.cid;
+      if (_cid) {
+        grid.onColumnsResized.subscribe(save);
+        grid.onColumnsReordered.subscribe(save);
+        grid.onSort.subscribe(save);
+      } else {
+        console.warn("grid has no client id. state persisting is disabled.");
+      }
+    }
+
+    function destroy() {
+      grid.onSort.unsubscribe(save);
+      grid.onColumnsReordered.unsubscribe(save);
+      grid.onColumnsResized.unsubscribe(save);
+      save();
+    }
+
+    function save() {
+      if (_cid && _store) {
+        var state = {
+          sortcols: getSortColumns(),
+          viewport: _grid.getViewport(),
+          columns: getColumns()
+        };
+        onStateChanged.notify(state);
+        return _store.set(options.key_prefix + _cid, state);
+      }
+    }
+
+    function restore() {
+      return $.Deferred(function(dfd) {
+        if (!_cid) { return dfd.reject("missing client id"); }
+        if (!_store) { return dfd.reject("missing store"); }
+
+        _store.get(options.key_prefix + _cid)
+          .then(function success(state) {
+            if (state) {
+              if (state.sortcols) {
+                _grid.setSortColumns(state.sortcols);
+              }
+              if (state.viewport) {
+                _grid.scrollRowIntoView(state.viewport.top, true);
+              }
+              if (state.columns) {
+                var defaultColumns = options.defaultColumns;
+                if (defaultColumns) {
+                  var defaultColumnsLookup = {};
+                  $.each(defaultColumns, function(idx, colDef) {
+                    defaultColumnsLookup[colDef.id] = colDef;
+                  });
+
+                  var cols = [];
+                  $.each(state.columns, function(idx, columnDef) {
+                    if (defaultColumnsLookup[columnDef.id]) {
+                      cols.push($.extend(true, {}, defaultColumnsLookup[columnDef.id], {
+                        width: columnDef.width,
+                        headerCssClass: columnDef.headerCssClass
+                      }));
+                    }
+                  });
+
+                  state.columns = cols;
+                }
+
+                _grid.setColumns(state.columns);
+              }
+            }
+            dfd.resolve(state);
+          }, dfd.reject);
+      });
+    }
+
+    function getColumns() {
+      return $.map(_grid.getColumns(), function(col) {
+        return {
+          id: col.id,
+          width: col.width
+        };
+      });
+    }
+
+    function getSortColumns() {
+      var sortCols = _grid.getSortColumns();
+      return sortCols;
+    }
+
+    /*
+     *  API
+     */
+    $.extend(this, {
+      "init": init,
+      "destroy": destroy,
+      "save": save,
+      "restore": restore,
+      "onStateChanged": onStateChanged
+    });
+  }
+})(jQuery);