/slick.grid.js

https://github.com/peterlevi/SlickGrid · JavaScript · 3372 lines · 2734 code · 494 blank · 144 comment · 734 complexity · a1581a679a0c9a79bd5b33ac218916a0 MD5 · raw file

  1. /**
  2. * @license
  3. * (c) 2009-2013 Michael Leibman
  4. * michael{dot}leibman{at}gmail{dot}com
  5. * http://github.com/mleibman/slickgrid
  6. *
  7. * Distributed under MIT license.
  8. * All rights reserved.
  9. *
  10. * SlickGrid v2.2
  11. *
  12. * NOTES:
  13. * Cell/row DOM manipulations are done directly bypassing jQuery's DOM manipulation methods.
  14. * This increases the speed dramatically, but can only be done safely because there are no event handlers
  15. * or data associated with any cell/row DOM nodes. Cell editors must make sure they implement .destroy()
  16. * and do proper cleanup.
  17. */
  18. // make sure required JavaScript modules are loaded
  19. if (typeof jQuery === "undefined") {
  20. throw "SlickGrid requires jquery module to be loaded";
  21. }
  22. if (!jQuery.fn.drag) {
  23. throw "SlickGrid requires jquery.event.drag module to be loaded";
  24. }
  25. if (typeof Slick === "undefined") {
  26. throw "slick.core.js not loaded";
  27. }
  28. (function ($) {
  29. // Slick.Grid
  30. $.extend(true, window, {
  31. Slick: {
  32. Grid: SlickGrid
  33. }
  34. });
  35. // shared across all grids on the page
  36. var scrollbarDimensions;
  37. var maxSupportedCssHeight; // browser's breaking point
  38. //////////////////////////////////////////////////////////////////////////////////////////////
  39. // SlickGrid class implementation (available as Slick.Grid)
  40. /**
  41. * Creates a new instance of the grid.
  42. * @class SlickGrid
  43. * @constructor
  44. * @param {Node} container Container node to create the grid in.
  45. * @param {Array,Object} data An array of objects for databinding.
  46. * @param {Array} columns An array of column definitions.
  47. * @param {Object} options Grid options.
  48. **/
  49. function SlickGrid(container, data, columns, options) {
  50. // settings
  51. var defaults = {
  52. explicitInitialization: false,
  53. rowHeight: 25,
  54. defaultColumnWidth: 80,
  55. enableAddRow: false,
  56. leaveSpaceForNewRows: false,
  57. editable: false,
  58. autoEdit: true,
  59. enableCellNavigation: true,
  60. enableColumnReorder: true,
  61. asyncEditorLoading: false,
  62. asyncEditorLoadDelay: 100,
  63. forceFitColumns: false,
  64. enableAsyncPostRender: false,
  65. asyncPostRenderDelay: 50,
  66. autoHeight: false,
  67. editorLock: Slick.GlobalEditorLock,
  68. showHeaderRow: false,
  69. headerRowHeight: 25,
  70. showTopPanel: false,
  71. topPanelHeight: 25,
  72. formatterFactory: null,
  73. editorFactory: null,
  74. cellFlashingCssClass: "flashing",
  75. selectedCellCssClass: "selected",
  76. multiSelect: true,
  77. enableTextSelectionOnCells: false,
  78. dataItemColumnValueExtractor: null,
  79. fullWidthRows: false,
  80. multiColumnSort: false,
  81. defaultFormatter: defaultFormatter,
  82. forceSyncScrolling: false
  83. };
  84. var columnDefaults = {
  85. name: "",
  86. resizable: true,
  87. sortable: false,
  88. minWidth: 30,
  89. rerenderOnResize: false,
  90. headerCssClass: null,
  91. defaultSortAsc: true,
  92. focusable: true,
  93. selectable: true
  94. };
  95. // scroller
  96. var th; // virtual height
  97. var h; // real scrollable height
  98. var ph; // page height
  99. var n; // number of pages
  100. var cj; // "jumpiness" coefficient
  101. var page = 0; // current page
  102. var offset = 0; // current page offset
  103. var vScrollDir = 1;
  104. // private
  105. var initialized = false;
  106. var $container;
  107. var uid = "slickgrid_" + Math.round(1000000 * Math.random());
  108. var self = this;
  109. var $focusSink, $focusSink2;
  110. var $headerScroller;
  111. var $headers;
  112. var $headerRow, $headerRowScroller, $headerRowSpacer;
  113. var $topPanelScroller;
  114. var $topPanel;
  115. var $viewport;
  116. var $canvas;
  117. var $style;
  118. var $boundAncestors;
  119. var stylesheet, columnCssRulesL, columnCssRulesR;
  120. var viewportH, viewportW;
  121. var canvasWidth;
  122. var viewportHasHScroll, viewportHasVScroll;
  123. var headerColumnWidthDiff = 0, headerColumnHeightDiff = 0, // border+padding
  124. cellWidthDiff = 0, cellHeightDiff = 0;
  125. var absoluteColumnMinWidth;
  126. var numberOfRows = 0;
  127. var tabbingDirection = 1;
  128. var activePosX;
  129. var activeRow, activeCell;
  130. var activeCellNode = null;
  131. var currentEditor = null;
  132. var serializedEditorValue;
  133. var editController;
  134. var rowsCache = {};
  135. var renderedRows = 0;
  136. var numVisibleRows;
  137. var prevScrollTop = 0;
  138. var scrollTop = 0;
  139. var lastRenderedScrollTop = 0;
  140. var lastRenderedScrollLeft = 0;
  141. var prevScrollLeft = 0;
  142. var scrollLeft = 0;
  143. var selectionModel;
  144. var selectedRows = [];
  145. var plugins = [];
  146. var cellCssClasses = {};
  147. var columnsById = {};
  148. var sortColumns = [];
  149. var columnPosLeft = [];
  150. var columnPosRight = [];
  151. // async call handles
  152. var h_editorLoader = null;
  153. var h_render = null;
  154. var h_postrender = null;
  155. var postProcessedRows = {};
  156. var postProcessToRow = null;
  157. var postProcessFromRow = null;
  158. // perf counters
  159. var counter_rows_rendered = 0;
  160. var counter_rows_removed = 0;
  161. //////////////////////////////////////////////////////////////////////////////////////////////
  162. // Initialization
  163. function init() {
  164. $container = $(container);
  165. if ($container.length < 1) {
  166. throw new Error("SlickGrid requires a valid container, " + container + " does not exist in the DOM.");
  167. }
  168. // calculate these only once and share between grid instances
  169. maxSupportedCssHeight = maxSupportedCssHeight || getMaxSupportedCssHeight();
  170. scrollbarDimensions = scrollbarDimensions || measureScrollbar();
  171. options = $.extend({}, defaults, options);
  172. validateAndEnforceOptions();
  173. columnDefaults.width = options.defaultColumnWidth;
  174. columnsById = {};
  175. for (var i = 0; i < columns.length; i++) {
  176. var m = columns[i] = $.extend({}, columnDefaults, columns[i]);
  177. columnsById[m.id] = i;
  178. if (m.minWidth && m.width < m.minWidth) {
  179. m.width = m.minWidth;
  180. }
  181. if (m.maxWidth && m.width > m.maxWidth) {
  182. m.width = m.maxWidth;
  183. }
  184. }
  185. // validate loaded JavaScript modules against requested options
  186. if (options.enableColumnReorder && !$.fn.sortable) {
  187. throw new Error("SlickGrid's 'enableColumnReorder = true' option requires jquery-ui.sortable module to be loaded");
  188. }
  189. editController = {
  190. "commitCurrentEdit": commitCurrentEdit,
  191. "cancelCurrentEdit": cancelCurrentEdit
  192. };
  193. $container
  194. .empty()
  195. .css("overflow", "hidden")
  196. .css("outline", 0)
  197. .addClass(uid)
  198. .addClass("ui-widget");
  199. // set up a positioning container if needed
  200. if (!/relative|absolute|fixed/.test($container.css("position"))) {
  201. $container.css("position", "relative");
  202. }
  203. $focusSink = $("<div tabIndex='0' hideFocus style='position:fixed;width:0;height:0;top:0;left:0;outline:0;'></div>").appendTo($container);
  204. $headerScroller = $("<div class='slick-header ui-state-default' style='overflow:hidden;position:relative;' />").appendTo($container);
  205. $headers = $("<div class='slick-header-columns' style='left:-1000px' />").appendTo($headerScroller);
  206. $headers.width(getHeadersWidth());
  207. $headerRowScroller = $("<div class='slick-headerrow ui-state-default' style='overflow:hidden;position:relative;' />").appendTo($container);
  208. $headerRow = $("<div class='slick-headerrow-columns' />").appendTo($headerRowScroller);
  209. $headerRowSpacer = $("<div style='display:block;height:1px;position:absolute;top:0;left:0;'></div>")
  210. .css("width", getCanvasWidth() + scrollbarDimensions.width + "px")
  211. .appendTo($headerRowScroller);
  212. $topPanelScroller = $("<div class='slick-top-panel-scroller ui-state-default' style='overflow:hidden;position:relative;' />").appendTo($container);
  213. $topPanel = $("<div class='slick-top-panel' style='width:10000px' />").appendTo($topPanelScroller);
  214. if (!options.showTopPanel) {
  215. $topPanelScroller.hide();
  216. }
  217. if (!options.showHeaderRow) {
  218. $headerRowScroller.hide();
  219. }
  220. $viewport = $("<div class='slick-viewport' style='width:100%;overflow:auto;outline:0;position:relative;;'>").appendTo($container);
  221. $viewport.css("overflow-y", options.autoHeight ? "hidden" : "auto");
  222. $canvas = $("<div class='grid-canvas' />").appendTo($viewport);
  223. $focusSink2 = $focusSink.clone().appendTo($container);
  224. if (!options.explicitInitialization) {
  225. finishInitialization();
  226. }
  227. }
  228. function finishInitialization() {
  229. if (!initialized) {
  230. initialized = true;
  231. viewportW = parseFloat($.css($container[0], "width", true));
  232. // header columns and cells may have different padding/border skewing width calculations (box-sizing, hello?)
  233. // calculate the diff so we can set consistent sizes
  234. measureCellPaddingAndBorder();
  235. // for usability reasons, all text selection in SlickGrid is disabled
  236. // with the exception of input and textarea elements (selection must
  237. // be enabled there so that editors work as expected); note that
  238. // selection in grid cells (grid body) is already unavailable in
  239. // all browsers except IE
  240. disableSelection($headers); // disable all text selection in header (including input and textarea)
  241. if (!options.enableTextSelectionOnCells) {
  242. // disable text selection in grid cells except in input and textarea elements
  243. // (this is IE-specific, because selectstart event will only fire in IE)
  244. $viewport.bind("selectstart.ui", function (event) {
  245. return $(event.target).is("input,textarea");
  246. });
  247. }
  248. updateColumnCaches();
  249. createColumnHeaders();
  250. setupColumnSort();
  251. createCssRules();
  252. resizeCanvas();
  253. bindAncestorScrollEvents();
  254. $container
  255. .bind("resize.slickgrid", resizeCanvas);
  256. $viewport
  257. .bind("click", handleClick)
  258. .bind("scroll", handleScroll);
  259. $headerScroller
  260. .bind("contextmenu", handleHeaderContextMenu)
  261. .bind("click", handleHeaderClick)
  262. .delegate(".slick-header-column", "mouseenter", handleHeaderMouseEnter)
  263. .delegate(".slick-header-column", "mouseleave", handleHeaderMouseLeave);
  264. $headerRowScroller
  265. .bind("scroll", handleHeaderRowScroll);
  266. $focusSink.add($focusSink2)
  267. .bind("keydown", handleKeyDown);
  268. $canvas
  269. .bind("keydown", handleKeyDown)
  270. .bind("click", handleClick)
  271. .bind("dblclick", handleDblClick)
  272. .bind("contextmenu", handleContextMenu)
  273. .bind("draginit", handleDragInit)
  274. .bind("dragstart", {distance: 3}, handleDragStart)
  275. .bind("drag", handleDrag)
  276. .bind("dragend", handleDragEnd)
  277. .delegate(".slick-cell", "mouseenter", handleMouseEnter)
  278. .delegate(".slick-cell", "mouseleave", handleMouseLeave);
  279. }
  280. }
  281. function registerPlugin(plugin) {
  282. plugins.unshift(plugin);
  283. plugin.init(self);
  284. }
  285. function unregisterPlugin(plugin) {
  286. for (var i = plugins.length; i >= 0; i--) {
  287. if (plugins[i] === plugin) {
  288. if (plugins[i].destroy) {
  289. plugins[i].destroy();
  290. }
  291. plugins.splice(i, 1);
  292. break;
  293. }
  294. }
  295. }
  296. function setSelectionModel(model) {
  297. if (selectionModel) {
  298. selectionModel.onSelectedRangesChanged.unsubscribe(handleSelectedRangesChanged);
  299. if (selectionModel.destroy) {
  300. selectionModel.destroy();
  301. }
  302. }
  303. selectionModel = model;
  304. if (selectionModel) {
  305. selectionModel.init(self);
  306. selectionModel.onSelectedRangesChanged.subscribe(handleSelectedRangesChanged);
  307. }
  308. }
  309. function getSelectionModel() {
  310. return selectionModel;
  311. }
  312. function getCanvasNode() {
  313. return $canvas[0];
  314. }
  315. function measureScrollbar() {
  316. var $c = $("<div style='position:absolute; top:-10000px; left:-10000px; width:100px; height:100px; overflow:scroll;'></div>").appendTo("body");
  317. var dim = {
  318. width: $c.width() - $c[0].clientWidth,
  319. height: $c.height() - $c[0].clientHeight
  320. };
  321. $c.remove();
  322. return dim;
  323. }
  324. function getHeadersWidth() {
  325. var headersWidth = 0;
  326. for (var i = 0, ii = columns.length; i < ii; i++) {
  327. var width = columns[i].width;
  328. headersWidth += width;
  329. }
  330. headersWidth += scrollbarDimensions.width;
  331. return Math.max(headersWidth, viewportW) + 1000;
  332. }
  333. function getCanvasWidth() {
  334. var availableWidth = viewportHasVScroll ? viewportW - scrollbarDimensions.width : viewportW;
  335. var rowWidth = 0;
  336. var i = columns.length;
  337. while (i--) {
  338. rowWidth += columns[i].width;
  339. }
  340. return options.fullWidthRows ? Math.max(rowWidth, availableWidth) : rowWidth;
  341. }
  342. function updateCanvasWidth(forceColumnWidthsUpdate) {
  343. var oldCanvasWidth = canvasWidth;
  344. canvasWidth = getCanvasWidth();
  345. if (canvasWidth != oldCanvasWidth) {
  346. $canvas.width(canvasWidth);
  347. $headerRow.width(canvasWidth);
  348. $headers.width(getHeadersWidth());
  349. viewportHasHScroll = (canvasWidth > viewportW - scrollbarDimensions.width);
  350. }
  351. $headerRowSpacer.width(canvasWidth + (viewportHasVScroll ? scrollbarDimensions.width : 0));
  352. if (canvasWidth != oldCanvasWidth || forceColumnWidthsUpdate) {
  353. applyColumnWidths();
  354. }
  355. }
  356. function disableSelection($target) {
  357. if ($target && $target.jquery) {
  358. $target
  359. .attr("unselectable", "on")
  360. .css("MozUserSelect", "none")
  361. .bind("selectstart.ui", function () {
  362. return false;
  363. }); // from jquery:ui.core.js 1.7.2
  364. }
  365. }
  366. function getMaxSupportedCssHeight() {
  367. var supportedHeight = 1000000;
  368. // FF reports the height back but still renders blank after ~6M px
  369. var testUpTo = navigator.userAgent.toLowerCase().match(/firefox/) ? 6000000 : 1000000000;
  370. var div = $("<div style='display:none' />").appendTo(document.body);
  371. while (true) {
  372. var test = supportedHeight * 2;
  373. div.css("height", test);
  374. if (test > testUpTo || div.height() !== test) {
  375. break;
  376. } else {
  377. supportedHeight = test;
  378. }
  379. }
  380. div.remove();
  381. return supportedHeight;
  382. }
  383. // TODO: this is static. need to handle page mutation.
  384. function bindAncestorScrollEvents() {
  385. var elem = $canvas[0];
  386. while ((elem = elem.parentNode) != document.body && elem != null) {
  387. // bind to scroll containers only
  388. if (elem == $viewport[0] || elem.scrollWidth != elem.clientWidth || elem.scrollHeight != elem.clientHeight) {
  389. var $elem = $(elem);
  390. if (!$boundAncestors) {
  391. $boundAncestors = $elem;
  392. } else {
  393. $boundAncestors = $boundAncestors.add($elem);
  394. }
  395. $elem.bind("scroll." + uid, handleActiveCellPositionChange);
  396. }
  397. }
  398. }
  399. function unbindAncestorScrollEvents() {
  400. if (!$boundAncestors) {
  401. return;
  402. }
  403. $boundAncestors.unbind("scroll." + uid);
  404. $boundAncestors = null;
  405. }
  406. function updateColumnHeader(columnId, title, toolTip) {
  407. if (!initialized) { return; }
  408. var idx = getColumnIndex(columnId);
  409. if (idx == null) {
  410. return;
  411. }
  412. var columnDef = columns[idx];
  413. var $header = $headers.children().eq(idx);
  414. if ($header) {
  415. if (title !== undefined) {
  416. columns[idx].name = title;
  417. }
  418. if (toolTip !== undefined) {
  419. columns[idx].toolTip = toolTip;
  420. }
  421. trigger(self.onBeforeHeaderCellDestroy, {
  422. "node": $header[0],
  423. "column": columnDef
  424. });
  425. $header
  426. .attr("title", toolTip || "")
  427. .children().eq(0).html(title);
  428. trigger(self.onHeaderCellRendered, {
  429. "node": $header[0],
  430. "column": columnDef
  431. });
  432. }
  433. }
  434. function getHeaderRow() {
  435. return $headerRow[0];
  436. }
  437. function getHeaderRowColumn(columnId) {
  438. var idx = getColumnIndex(columnId);
  439. var $header = $headerRow.children().eq(idx);
  440. return $header && $header[0];
  441. }
  442. function createColumnHeaders() {
  443. function onMouseEnter() {
  444. $(this).addClass("ui-state-hover");
  445. }
  446. function onMouseLeave() {
  447. $(this).removeClass("ui-state-hover");
  448. }
  449. $headers.find(".slick-header-column")
  450. .each(function() {
  451. var columnDef = $(this).data("column");
  452. if (columnDef) {
  453. trigger(self.onBeforeHeaderCellDestroy, {
  454. "node": this,
  455. "column": columnDef
  456. });
  457. }
  458. });
  459. $headers.empty();
  460. $headers.width(getHeadersWidth());
  461. $headerRow.find(".slick-headerrow-column")
  462. .each(function() {
  463. var columnDef = $(this).data("column");
  464. if (columnDef) {
  465. trigger(self.onBeforeHeaderRowCellDestroy, {
  466. "node": this,
  467. "column": columnDef
  468. });
  469. }
  470. });
  471. $headerRow.empty();
  472. for (var i = 0; i < columns.length; i++) {
  473. var m = columns[i];
  474. var header = $("<div class='ui-state-default slick-header-column' />")
  475. .html("<span class='slick-column-name'>" + m.name + "</span>")
  476. .width(m.width - headerColumnWidthDiff)
  477. .attr("id", "" + uid + m.id)
  478. .attr("title", m.toolTip || "")
  479. .data("column", m)
  480. .addClass(m.headerCssClass || "")
  481. .appendTo($headers);
  482. if (options.enableColumnReorder || m.sortable) {
  483. header
  484. .on('mouseenter', onMouseEnter)
  485. .on('mouseleave', onMouseLeave);
  486. }
  487. if (m.sortable) {
  488. header.addClass("slick-header-sortable");
  489. header.append("<span class='slick-sort-indicator' />");
  490. }
  491. trigger(self.onHeaderCellRendered, {
  492. "node": header[0],
  493. "column": m
  494. });
  495. if (options.showHeaderRow) {
  496. var headerRowCell = $("<div class='ui-state-default slick-headerrow-column l" + i + " r" + i + "'></div>")
  497. .data("column", m)
  498. .appendTo($headerRow);
  499. trigger(self.onHeaderRowCellRendered, {
  500. "node": headerRowCell[0],
  501. "column": m
  502. });
  503. }
  504. }
  505. setSortColumns(sortColumns);
  506. setupColumnResize();
  507. if (options.enableColumnReorder) {
  508. setupColumnReorder();
  509. }
  510. }
  511. function setupColumnSort() {
  512. $headers.click(function (e) {
  513. // temporary workaround for a bug in jQuery 1.7.1 (http://bugs.jquery.com/ticket/11328)
  514. e.metaKey = e.metaKey || e.ctrlKey;
  515. if ($(e.target).hasClass("slick-resizable-handle")) {
  516. return;
  517. }
  518. var $col = $(e.target).closest(".slick-header-column");
  519. if (!$col.length) {
  520. return;
  521. }
  522. var column = $col.data("column");
  523. if (column.sortable) {
  524. if (!getEditorLock().commitCurrentEdit()) {
  525. return;
  526. }
  527. var sortOpts = null;
  528. var i = 0;
  529. for (; i < sortColumns.length; i++) {
  530. if (sortColumns[i].columnId == column.id) {
  531. sortOpts = sortColumns[i];
  532. sortOpts.sortAsc = !sortOpts.sortAsc;
  533. break;
  534. }
  535. }
  536. if (e.metaKey && options.multiColumnSort) {
  537. if (sortOpts) {
  538. sortColumns.splice(i, 1);
  539. }
  540. }
  541. else {
  542. if ((!e.shiftKey && !e.metaKey) || !options.multiColumnSort) {
  543. sortColumns = [];
  544. }
  545. if (!sortOpts) {
  546. sortOpts = { columnId: column.id, sortAsc: column.defaultSortAsc };
  547. sortColumns.push(sortOpts);
  548. } else if (sortColumns.length == 0) {
  549. sortColumns.push(sortOpts);
  550. }
  551. }
  552. setSortColumns(sortColumns);
  553. if (!options.multiColumnSort) {
  554. trigger(self.onSort, {
  555. multiColumnSort: false,
  556. sortCol: column,
  557. sortAsc: sortOpts.sortAsc}, e);
  558. } else {
  559. trigger(self.onSort, {
  560. multiColumnSort: true,
  561. sortCols: $.map(sortColumns, function(col) {
  562. return {sortCol: columns[getColumnIndex(col.columnId)], sortAsc: col.sortAsc };
  563. })}, e);
  564. }
  565. }
  566. });
  567. }
  568. function setupColumnReorder() {
  569. $headers.filter(":ui-sortable").sortable("destroy");
  570. $headers.sortable({
  571. containment: "parent",
  572. distance: 3,
  573. axis: "x",
  574. cursor: "default",
  575. tolerance: "intersection",
  576. helper: "clone",
  577. placeholder: "slick-sortable-placeholder ui-state-default slick-header-column",
  578. start: function (e, ui) {
  579. ui.placeholder.width(ui.helper.outerWidth() - headerColumnWidthDiff);
  580. $(ui.helper).addClass("slick-header-column-active");
  581. },
  582. beforeStop: function (e, ui) {
  583. $(ui.helper).removeClass("slick-header-column-active");
  584. },
  585. stop: function (e) {
  586. if (!getEditorLock().commitCurrentEdit()) {
  587. $(this).sortable("cancel");
  588. return;
  589. }
  590. var reorderedIds = $headers.sortable("toArray");
  591. var reorderedColumns = [];
  592. for (var i = 0; i < reorderedIds.length; i++) {
  593. reorderedColumns.push(columns[getColumnIndex(reorderedIds[i].replace(uid, ""))]);
  594. }
  595. setColumns(reorderedColumns);
  596. trigger(self.onColumnsReordered, {});
  597. e.stopPropagation();
  598. setupColumnResize();
  599. }
  600. });
  601. }
  602. function setupColumnResize() {
  603. var $col, j, c, pageX, columnElements, minPageX, maxPageX, firstResizable, lastResizable;
  604. columnElements = $headers.children();
  605. columnElements.find(".slick-resizable-handle").remove();
  606. columnElements.each(function (i, e) {
  607. if (columns[i].resizable) {
  608. if (firstResizable === undefined) {
  609. firstResizable = i;
  610. }
  611. lastResizable = i;
  612. }
  613. });
  614. if (firstResizable === undefined) {
  615. return;
  616. }
  617. columnElements.each(function (i, e) {
  618. if (i < firstResizable || (options.forceFitColumns && i >= lastResizable)) {
  619. return;
  620. }
  621. $col = $(e);
  622. $("<div class='slick-resizable-handle' />")
  623. .appendTo(e)
  624. .bind("dragstart", function (e, dd) {
  625. if (!getEditorLock().commitCurrentEdit()) {
  626. return false;
  627. }
  628. pageX = e.pageX;
  629. $(this).parent().addClass("slick-header-column-active");
  630. var shrinkLeewayOnRight = null, stretchLeewayOnRight = null;
  631. // lock each column's width option to current width
  632. columnElements.each(function (i, e) {
  633. columns[i].previousWidth = $(e).outerWidth();
  634. });
  635. if (options.forceFitColumns) {
  636. shrinkLeewayOnRight = 0;
  637. stretchLeewayOnRight = 0;
  638. // colums on right affect maxPageX/minPageX
  639. for (j = i + 1; j < columnElements.length; j++) {
  640. c = columns[j];
  641. if (c.resizable) {
  642. if (stretchLeewayOnRight !== null) {
  643. if (c.maxWidth) {
  644. stretchLeewayOnRight += c.maxWidth - c.previousWidth;
  645. } else {
  646. stretchLeewayOnRight = null;
  647. }
  648. }
  649. shrinkLeewayOnRight += c.previousWidth - Math.max(c.minWidth || 0, absoluteColumnMinWidth);
  650. }
  651. }
  652. }
  653. var shrinkLeewayOnLeft = 0, stretchLeewayOnLeft = 0;
  654. for (j = 0; j <= i; j++) {
  655. // columns on left only affect minPageX
  656. c = columns[j];
  657. if (c.resizable) {
  658. if (stretchLeewayOnLeft !== null) {
  659. if (c.maxWidth) {
  660. stretchLeewayOnLeft += c.maxWidth - c.previousWidth;
  661. } else {
  662. stretchLeewayOnLeft = null;
  663. }
  664. }
  665. shrinkLeewayOnLeft += c.previousWidth - Math.max(c.minWidth || 0, absoluteColumnMinWidth);
  666. }
  667. }
  668. if (shrinkLeewayOnRight === null) {
  669. shrinkLeewayOnRight = 100000;
  670. }
  671. if (shrinkLeewayOnLeft === null) {
  672. shrinkLeewayOnLeft = 100000;
  673. }
  674. if (stretchLeewayOnRight === null) {
  675. stretchLeewayOnRight = 100000;
  676. }
  677. if (stretchLeewayOnLeft === null) {
  678. stretchLeewayOnLeft = 100000;
  679. }
  680. maxPageX = pageX + Math.min(shrinkLeewayOnRight, stretchLeewayOnLeft);
  681. minPageX = pageX - Math.min(shrinkLeewayOnLeft, stretchLeewayOnRight);
  682. })
  683. .bind("drag", function (e, dd) {
  684. var actualMinWidth, d = Math.min(maxPageX, Math.max(minPageX, e.pageX)) - pageX, x;
  685. if (d < 0) { // shrink column
  686. x = d;
  687. for (j = i; j >= 0; j--) {
  688. c = columns[j];
  689. if (c.resizable) {
  690. actualMinWidth = Math.max(c.minWidth || 0, absoluteColumnMinWidth);
  691. if (x && c.previousWidth + x < actualMinWidth) {
  692. x += c.previousWidth - actualMinWidth;
  693. c.width = actualMinWidth;
  694. } else {
  695. c.width = c.previousWidth + x;
  696. x = 0;
  697. }
  698. }
  699. }
  700. if (options.forceFitColumns) {
  701. x = -d;
  702. for (j = i + 1; j < columnElements.length; j++) {
  703. c = columns[j];
  704. if (c.resizable) {
  705. if (x && c.maxWidth && (c.maxWidth - c.previousWidth < x)) {
  706. x -= c.maxWidth - c.previousWidth;
  707. c.width = c.maxWidth;
  708. } else {
  709. c.width = c.previousWidth + x;
  710. x = 0;
  711. }
  712. }
  713. }
  714. }
  715. } else { // stretch column
  716. x = d;
  717. for (j = i; j >= 0; j--) {
  718. c = columns[j];
  719. if (c.resizable) {
  720. if (x && c.maxWidth && (c.maxWidth - c.previousWidth < x)) {
  721. x -= c.maxWidth - c.previousWidth;
  722. c.width = c.maxWidth;
  723. } else {
  724. c.width = c.previousWidth + x;
  725. x = 0;
  726. }
  727. }
  728. }
  729. if (options.forceFitColumns) {
  730. x = -d;
  731. for (j = i + 1; j < columnElements.length; j++) {
  732. c = columns[j];
  733. if (c.resizable) {
  734. actualMinWidth = Math.max(c.minWidth || 0, absoluteColumnMinWidth);
  735. if (x && c.previousWidth + x < actualMinWidth) {
  736. x += c.previousWidth - actualMinWidth;
  737. c.width = actualMinWidth;
  738. } else {
  739. c.width = c.previousWidth + x;
  740. x = 0;
  741. }
  742. }
  743. }
  744. }
  745. }
  746. applyColumnHeaderWidths();
  747. if (options.syncColumnCellResize) {
  748. applyColumnWidths();
  749. }
  750. })
  751. .bind("dragend", function (e, dd) {
  752. var newWidth;
  753. $(this).parent().removeClass("slick-header-column-active");
  754. for (j = 0; j < columnElements.length; j++) {
  755. c = columns[j];
  756. newWidth = $(columnElements[j]).outerWidth();
  757. if (c.previousWidth !== newWidth && c.rerenderOnResize) {
  758. invalidateAllRows();
  759. }
  760. }
  761. updateCanvasWidth(true);
  762. render();
  763. trigger(self.onColumnsResized, {});
  764. });
  765. });
  766. }
  767. function getVBoxDelta($el) {
  768. var p = ["borderTopWidth", "borderBottomWidth", "paddingTop", "paddingBottom"];
  769. var delta = 0;
  770. $.each(p, function (n, val) {
  771. delta += parseFloat($el.css(val)) || 0;
  772. });
  773. return delta;
  774. }
  775. function measureCellPaddingAndBorder() {
  776. var el;
  777. var h = ["borderLeftWidth", "borderRightWidth", "paddingLeft", "paddingRight"];
  778. var v = ["borderTopWidth", "borderBottomWidth", "paddingTop", "paddingBottom"];
  779. el = $("<div class='ui-state-default slick-header-column' style='visibility:hidden'>-</div>").appendTo($headers);
  780. headerColumnWidthDiff = headerColumnHeightDiff = 0;
  781. if (el.css("box-sizing") != "border-box" && el.css("-moz-box-sizing") != "border-box" && el.css("-webkit-box-sizing") != "border-box") {
  782. $.each(h, function (n, val) {
  783. headerColumnWidthDiff += parseFloat(el.css(val)) || 0;
  784. });
  785. $.each(v, function (n, val) {
  786. headerColumnHeightDiff += parseFloat(el.css(val)) || 0;
  787. });
  788. }
  789. el.remove();
  790. var r = $("<div class='slick-row' />").appendTo($canvas);
  791. el = $("<div class='slick-cell' id='' style='visibility:hidden'>-</div>").appendTo(r);
  792. cellWidthDiff = cellHeightDiff = 0;
  793. if (el.css("box-sizing") != "border-box" && el.css("-moz-box-sizing") != "border-box" && el.css("-webkit-box-sizing") != "border-box") {
  794. $.each(h, function (n, val) {
  795. cellWidthDiff += parseFloat(el.css(val)) || 0;
  796. });
  797. $.each(v, function (n, val) {
  798. cellHeightDiff += parseFloat(el.css(val)) || 0;
  799. });
  800. }
  801. r.remove();
  802. absoluteColumnMinWidth = Math.max(headerColumnWidthDiff, cellWidthDiff);
  803. }
  804. function createCssRules() {
  805. $style = $("<style type='text/css' rel='stylesheet' />").appendTo($("head"));
  806. var rowHeight = (options.rowHeight - cellHeightDiff);
  807. var rules = [
  808. "." + uid + " .slick-header-column { left: 1000px; }",
  809. "." + uid + " .slick-top-panel { height:" + options.topPanelHeight + "px; }",
  810. "." + uid + " .slick-headerrow-columns { height:" + options.headerRowHeight + "px; }",
  811. "." + uid + " .slick-cell { height:" + rowHeight + "px; }",
  812. "." + uid + " .slick-row { height:" + options.rowHeight + "px; }"
  813. ];
  814. for (var i = 0; i < columns.length; i++) {
  815. rules.push("." + uid + " .l" + i + " { }");
  816. rules.push("." + uid + " .r" + i + " { }");
  817. }
  818. if ($style[0].styleSheet) { // IE
  819. $style[0].styleSheet.cssText = rules.join(" ");
  820. } else {
  821. $style[0].appendChild(document.createTextNode(rules.join(" ")));
  822. }
  823. }
  824. function getColumnCssRules(idx) {
  825. if (!stylesheet) {
  826. var sheets = document.styleSheets;
  827. for (var i = 0; i < sheets.length; i++) {
  828. if ((sheets[i].ownerNode || sheets[i].owningElement) == $style[0]) {
  829. stylesheet = sheets[i];
  830. break;
  831. }
  832. }
  833. if (!stylesheet) {
  834. throw new Error("Cannot find stylesheet.");
  835. }
  836. // find and cache column CSS rules
  837. columnCssRulesL = [];
  838. columnCssRulesR = [];
  839. var cssRules = (stylesheet.cssRules || stylesheet.rules);
  840. var matches, columnIdx;
  841. for (var i = 0; i < cssRules.length; i++) {
  842. var selector = cssRules[i].selectorText;
  843. if (matches = /\.l\d+/.exec(selector)) {
  844. columnIdx = parseInt(matches[0].substr(2, matches[0].length - 2), 10);
  845. columnCssRulesL[columnIdx] = cssRules[i];
  846. } else if (matches = /\.r\d+/.exec(selector)) {
  847. columnIdx = parseInt(matches[0].substr(2, matches[0].length - 2), 10);
  848. columnCssRulesR[columnIdx] = cssRules[i];
  849. }
  850. }
  851. }
  852. return {
  853. "left": columnCssRulesL[idx],
  854. "right": columnCssRulesR[idx]
  855. };
  856. }
  857. function removeCssRules() {
  858. $style.remove();
  859. stylesheet = null;
  860. }
  861. function destroy() {
  862. getEditorLock().cancelCurrentEdit();
  863. trigger(self.onBeforeDestroy, {});
  864. var i = plugins.length;
  865. while(i--) {
  866. unregisterPlugin(plugins[i]);
  867. }
  868. if (options.enableColumnReorder) {
  869. $headers.filter(":ui-sortable").sortable("destroy");
  870. }
  871. unbindAncestorScrollEvents();
  872. $container.unbind(".slickgrid");
  873. removeCssRules();
  874. $canvas.unbind("draginit dragstart dragend drag");
  875. $container.empty().removeClass(uid);
  876. }
  877. //////////////////////////////////////////////////////////////////////////////////////////////
  878. // General
  879. function trigger(evt, args, e) {
  880. e = e || new Slick.EventData();
  881. args = args || {};
  882. args.grid = self;
  883. return evt.notify(args, e, self);
  884. }
  885. function getEditorLock() {
  886. return options.editorLock;
  887. }
  888. function getEditController() {
  889. return editController;
  890. }
  891. function getColumnIndex(id) {
  892. return columnsById[id];
  893. }
  894. function autosizeColumns() {
  895. var i, c,
  896. widths = [],
  897. shrinkLeeway = 0,
  898. total = 0,
  899. prevTotal,
  900. availWidth = viewportHasVScroll ? viewportW - scrollbarDimensions.width : viewportW;
  901. for (i = 0; i < columns.length; i++) {
  902. c = columns[i];
  903. widths.push(c.width);
  904. total += c.width;
  905. if (c.resizable) {
  906. shrinkLeeway += c.width - Math.max(c.minWidth, absoluteColumnMinWidth);
  907. }
  908. }
  909. // shrink
  910. prevTotal = total;
  911. while (total > availWidth && shrinkLeeway) {
  912. var shrinkProportion = (total - availWidth) / shrinkLeeway;
  913. for (i = 0; i < columns.length && total > availWidth; i++) {
  914. c = columns[i];
  915. var width = widths[i];
  916. if (!c.resizable || width <= c.minWidth || width <= absoluteColumnMinWidth) {
  917. continue;
  918. }
  919. var absMinWidth = Math.max(c.minWidth, absoluteColumnMinWidth);
  920. var shrinkSize = Math.floor(shrinkProportion * (width - absMinWidth)) || 1;
  921. shrinkSize = Math.min(shrinkSize, width - absMinWidth);
  922. total -= shrinkSize;
  923. shrinkLeeway -= shrinkSize;
  924. widths[i] -= shrinkSize;
  925. }
  926. if (prevTotal == total) { // avoid infinite loop
  927. break;
  928. }
  929. prevTotal = total;
  930. }
  931. // grow
  932. prevTotal = total;
  933. while (total < availWidth) {
  934. var growProportion = availWidth / total;
  935. for (i = 0; i < columns.length && total < availWidth; i++) {
  936. c = columns[i];
  937. if (!c.resizable || c.maxWidth <= c.width) {
  938. continue;
  939. }
  940. var growSize = Math.min(Math.floor(growProportion * c.width) - c.width, (c.maxWidth - c.width) || 1000000) || 1;
  941. total += growSize;
  942. widths[i] += growSize;
  943. }
  944. if (prevTotal == total) { // avoid infinite loop
  945. break;
  946. }
  947. prevTotal = total;
  948. }
  949. var reRender = false;
  950. for (i = 0; i < columns.length; i++) {
  951. if (columns[i].rerenderOnResize && columns[i].width != widths[i]) {
  952. reRender = true;
  953. }
  954. columns[i].width = widths[i];
  955. }
  956. applyColumnHeaderWidths();
  957. updateCanvasWidth(true);
  958. if (reRender) {
  959. invalidateAllRows();
  960. render();
  961. }
  962. }
  963. function applyColumnHeaderWidths() {
  964. if (!initialized) { return; }
  965. var h;
  966. for (var i = 0, headers = $headers.children(), ii = headers.length; i < ii; i++) {
  967. h = $(headers[i]);
  968. if (h.width() !== columns[i].width - headerColumnWidthDiff) {
  969. h.width(columns[i].width - headerColumnWidthDiff);
  970. }
  971. }
  972. updateColumnCaches();
  973. }
  974. function applyColumnWidths() {
  975. var x = 0, w, rule;
  976. for (var i = 0; i < columns.length; i++) {
  977. w = columns[i].width;
  978. rule = getColumnCssRules(i);
  979. rule.left.style.left = x + "px";
  980. rule.right.style.right = (canvasWidth - x - w) + "px";
  981. x += columns[i].width;
  982. }
  983. }
  984. function setSortColumn(columnId, ascending) {
  985. setSortColumns([{ columnId: columnId, sortAsc: ascending}]);
  986. }
  987. function setSortColumns(cols) {
  988. sortColumns = cols;
  989. var headerColumnEls = $headers.children();
  990. headerColumnEls
  991. .removeClass("slick-header-column-sorted")
  992. .find(".slick-sort-indicator")
  993. .removeClass("slick-sort-indicator-asc slick-sort-indicator-desc");
  994. $.each(sortColumns, function(i, col) {
  995. if (col.sortAsc == null) {
  996. col.sortAsc = true;
  997. }
  998. var columnIndex = getColumnIndex(col.columnId);
  999. if (columnIndex != null) {
  1000. headerColumnEls.eq(columnIndex)
  1001. .addClass("slick-header-column-sorted")
  1002. .find(".slick-sort-indicator")
  1003. .addClass(col.sortAsc ? "slick-sort-indicator-asc" : "slick-sort-indicator-desc");
  1004. }
  1005. });
  1006. }
  1007. function getSortColumns() {
  1008. return sortColumns;
  1009. }
  1010. function handleSelectedRangesChanged(e, ranges) {
  1011. selectedRows = [];
  1012. var hash = {};
  1013. for (var i = 0; i < ranges.length; i++) {
  1014. for (var j = ranges[i].fromRow; j <= ranges[i].toRow; j++) {
  1015. if (!hash[j]) { // prevent duplicates
  1016. selectedRows.push(j);
  1017. hash[j] = {};
  1018. }
  1019. for (var k = ranges[i].fromCell; k <= ranges[i].toCell; k++) {
  1020. if (canCellBeSelected(j, k)) {
  1021. hash[j][columns[k].id] = options.selectedCellCssClass;
  1022. }
  1023. }
  1024. }
  1025. }
  1026. setCellCssStyles(options.selectedCellCssClass, hash);
  1027. trigger(self.onSelectedRowsChanged, {rows: getSelectedRows()}, e);
  1028. }
  1029. function getColumns() {
  1030. return columns;
  1031. }
  1032. function updateColumnCaches() {
  1033. // Pre-calculate cell boundaries.
  1034. columnPosLeft = [];
  1035. columnPosRight = [];
  1036. var x = 0;
  1037. for (var i = 0, ii = columns.length; i < ii; i++) {
  1038. columnPosLeft[i] = x;
  1039. columnPosRight[i] = x + columns[i].width;
  1040. x += columns[i].width;
  1041. }
  1042. }
  1043. function setColumns(columnDefinitions) {
  1044. columns = columnDefinitions;
  1045. columnsById = {};
  1046. for (var i = 0; i < columns.length; i++) {
  1047. var m = columns[i] = $.extend({}, columnDefaults, columns[i]);
  1048. columnsById[m.id] = i;
  1049. if (m.minWidth && m.width < m.minWidth) {
  1050. m.width = m.minWidth;
  1051. }
  1052. if (m.maxWidth && m.width > m.maxWidth) {
  1053. m.width = m.maxWidth;
  1054. }
  1055. }
  1056. updateColumnCaches();
  1057. if (initialized) {
  1058. invalidateAllRows();
  1059. createColumnHeaders();
  1060. removeCssRules();
  1061. createCssRules();
  1062. resizeCanvas();
  1063. applyColumnWidths();
  1064. handleScroll();
  1065. }
  1066. }
  1067. function getOptions() {
  1068. return options;
  1069. }
  1070. function setOptions(args) {
  1071. if (!getEditorLock().commitCurrentEdit()) {
  1072. return;
  1073. }
  1074. makeActiveCellNormal();
  1075. if (options.enableAddRow !== args.enableAddRow) {
  1076. invalidateRow(getDataLength());
  1077. }
  1078. options = $.extend(options, args);
  1079. validateAndEnforceOptions();
  1080. $viewport.css("overflow-y", options.autoHeight ? "hidden" : "auto");
  1081. render();
  1082. }
  1083. function validateAndEnforceOptions() {
  1084. if (options.autoHeight) {
  1085. options.leaveSpaceForNewRows = false;
  1086. }
  1087. }
  1088. function setData(newData, scrollToTop) {
  1089. data = newData;
  1090. invalidateAllRows();
  1091. updateRowCount();
  1092. if (scrollToTop) {
  1093. scrollTo(0);
  1094. }
  1095. }
  1096. function getData() {
  1097. return data;
  1098. }
  1099. function getDataLength() {
  1100. if (data.getLength) {
  1101. return data.getLength();
  1102. } else {
  1103. return data.length;
  1104. }
  1105. }
  1106. function getDataLengthIncludingAddNew() {
  1107. return getDataLength() + (options.enableAddRow ? 1 : 0);
  1108. }
  1109. function getDataItem(i) {
  1110. if (data.getItem) {
  1111. return data.getItem(i);
  1112. } else {
  1113. return data[i];
  1114. }
  1115. }
  1116. function getTopPanel() {
  1117. return $topPanel[0];
  1118. }
  1119. function setTopPanelVisibility(visible) {
  1120. if (options.showTopPanel != visible) {
  1121. options.showTopPanel = visible;
  1122. if (visible) {
  1123. $topPanelScroller.slideDown("fast", resizeCanvas);
  1124. } else {
  1125. $topPanelScroller.slideUp("fast", resizeCanvas);
  1126. }
  1127. }
  1128. }
  1129. function setHeaderRowVisibility(visible) {
  1130. if (options.showHeaderRow != visible) {
  1131. options.showHeaderRow = visible;
  1132. if (visible) {
  1133. $headerRowScroller.slideDown("fast", resizeCanvas);
  1134. } else {
  1135. $headerRowScroller.slideUp("fast", resizeCanvas);
  1136. }
  1137. }
  1138. }
  1139. function getContainerNode() {
  1140. return $container.get(0);
  1141. }
  1142. //////////////////////////////////////////////////////////////////////////////////////////////
  1143. // Rendering / Scrolling
  1144. function getRowTop(row) {
  1145. return options.rowHeight * row - offset;
  1146. }
  1147. function getRowFromPosition(y) {
  1148. return Math.floor((y + offset) / options.rowHeight);
  1149. }
  1150. function scrollTo(y) {
  1151. y = Math.max(y, 0);
  1152. y = Math.min(y, th - viewportH + (viewportHasHScroll ? scrollbarDimensions.height : 0));
  1153. var oldOffset = offset;
  1154. page = Math.min(n - 1, Math.floor(y / ph));
  1155. offset = Math.round(page * cj);
  1156. var newScrollTop = y - offset;
  1157. if (offset != oldOffset) {
  1158. var range = getVisibleRange(newScrollTop);
  1159. cleanupRows(range);
  1160. updateRowPositions();
  1161. }
  1162. if (prevScrollTop != newScrollTop) {
  1163. vScrollDir = (prevScrollTop + oldOffset < newScrollTop + offset) ? 1 : -1;
  1164. $viewport[0].scrollTop = (lastRenderedScrollTop = scrollTop = prevScrollTop = newScrollTop);
  1165. trigger(self.onViewportChanged, {});
  1166. }
  1167. }
  1168. function defaultFormatter(row, cell, value, columnDef, dataContext) {
  1169. if (value == null) {
  1170. return "";
  1171. } else {
  1172. return (value + "").replace(/&/g,"&amp;").replace(/</g,"&lt;").replace(/>/g,"&gt;");
  1173. }
  1174. }
  1175. function getFormatter(row, column) {
  1176. var rowMetadata = data.getItemMetadata && data.getItemMetadata(row);
  1177. // look up by id, then index
  1178. var columnOverrides = rowMetadata &&
  1179. rowMetadata.columns &&
  1180. (rowMetadata.columns[column.id] || rowMetadata.columns[getColumnIndex(column.id)]);
  1181. return (columnOverrides && columnOverrides.formatter) ||
  1182. (rowMetadata && rowMetadata.formatter) ||
  1183. column.formatter ||
  1184. (options.formatterFactory && options.formatterFactory.getFormatter(column)) ||
  1185. options.defaultFormatter;
  1186. }
  1187. function getEditor(row, cell) {
  1188. var column = columns[cell];
  1189. var rowMetadata = data.getItemMetadata && data.getItemMetadata(row);
  1190. var columnMetadata = rowMetadata && rowMetadata.columns;
  1191. if (columnMetadata && columnMetadata[column.id] && columnMetadata[column.id].editor !== undefined) {
  1192. return columnMetadata[column.id].editor;
  1193. }
  1194. if (columnMetadata && columnMetadata[cell] && columnMetadata[cell].editor !== undefined) {
  1195. return columnMetadata[cell].editor;
  1196. }
  1197. return column.editor || (options.editorFactory && options.editorFactory.getEditor(column));
  1198. }
  1199. function getDataItemValueForColumn(item, columnDef) {
  1200. if (options.dataItemColumnValueExtractor) {
  1201. return options.dataItemColumnValueExtractor(item, columnDef);
  1202. }
  1203. return item[columnDef.field];
  1204. }
  1205. function appendRowHtml(stringArray, row, range, dataLength) {
  1206. var d = getDataItem(row);
  1207. var dataLoading = row < dataLength && !d;
  1208. var rowCss = "slick-row" +
  1209. (dataLoading ? " loading" : "") +
  1210. (row === activeRow ? " active" : "") +
  1211. (row % 2 == 1 ? " odd" : " even");
  1212. var metadata = data.getItemMetadata && data.getItemMetadata(row);
  1213. if (metadata && metadata.cssClasses) {
  1214. rowCss += " " + metadata.cssClasses;
  1215. }
  1216. stringArray.push("<div class='ui-widget-content " + rowCss + "' style='top:" + getRowTop(row) + "px'>");
  1217. var colspan, m;
  1218. for (var i = 0, ii = columns.length; i < ii; i++) {
  1219. m = columns[i];
  1220. colspan = 1;
  1221. if (metadata && metadata.columns) {
  1222. var columnData = metadata.columns[m.id] || metadata.columns[i];
  1223. colspan = (columnData && columnData.colspan) || 1;
  1224. if (colspan === "*") {
  1225. colspan = ii - i;
  1226. }
  1227. }
  1228. // Do not render cells outside of the viewport.
  1229. if (columnPosRight[Math.min(ii - 1, i + colspan - 1)] > range.leftPx) {
  1230. if (columnPosLeft[i] > range.rightPx) {
  1231. // All columns to the right are outside the range.
  1232. break;
  1233. }
  1234. appendCellHtml(stringArray, row, i, colspan, d);
  1235. }
  1236. if (colspan > 1) {
  1237. i += (colspan - 1);
  1238. }
  1239. }
  1240. stringArray.push("</div>");
  1241. }
  1242. function appendCellHtml(stringArray, row, cell, colspan, item) {
  1243. var m = columns[cell];
  1244. var cellCss = "slick-cell l" + cell + " r" + Math.min(columns.length - 1, cell + colspan - 1) +
  1245. (m.cssClass ? " " + m.cssClass : "");
  1246. if (row === activeRow && cell === activeCell) {
  1247. cellCss += (" active");
  1248. }
  1249. // TODO: merge them together in the setter
  1250. for (var key in cellCssClasses) {
  1251. if (cellCssClasses[key][row] && cellCssClasses[key][row][m.id]) {
  1252. cellCss += (" " + cellCssClasses[key][row][m.id]);
  1253. }
  1254. }
  1255. stringArray.push("<div class='" + cellCss + "'>");
  1256. // if there is a corresponding row (if not, this is the Add New row or this data hasn't been loaded yet)
  1257. if (item) {
  1258. var value = getDataItemValueForColumn(item, m);
  1259. stringArray.push(getFormatter(row, m)(row, cell, value, m, item));
  1260. }
  1261. stringArray.push("</div>");
  1262. rowsCache[row].cellRenderQueue.push(cell);
  1263. rowsCache[row].cellColSpans[cell] = colspan;
  1264. }
  1265. function cleanupRows(rangeToKeep) {
  1266. for (var i in rowsCache) {
  1267. if (((i = parseInt(i, 10)) !== activeRow) && (i < rangeToKeep.top || i > rangeToKeep.bottom)) {
  1268. removeRowFromCache(i);
  1269. }
  1270. }
  1271. }
  1272. function invalidate() {
  1273. updateRowCount();
  1274. invalidateAllRows();
  1275. render();
  1276. }
  1277. function invalidateAllRows() {
  1278. if (currentEditor) {
  1279. makeActiveCellNormal();
  1280. }
  1281. for (var row in rowsCache) {
  1282. removeRowFromCache(row);
  1283. }
  1284. }
  1285. function removeRowFromCache(row) {
  1286. var cacheEntry = rowsCache[row];
  1287. if (!cacheEntry) {
  1288. return;
  1289. }
  1290. $canvas[0].removeChild(cacheEntry.rowNode);
  1291. delete rowsCache[row];
  1292. delete postProcessedRows[row];
  1293. renderedRows--;
  1294. counter_rows_removed++;
  1295. }
  1296. function invalidateRows(rows) {
  1297. var i, rl;
  1298. if (!rows || !rows.length) {
  1299. return;
  1300. }
  1301. vScrollDir = 0;
  1302. for (i = 0, rl = rows.length; i < rl; i++) {
  1303. if (currentEditor && activeRow === rows[i]) {
  1304. makeActiveCellNormal();
  1305. }
  1306. if (rowsCache[rows[i]]) {
  1307. removeRowFromCache(rows[i]);
  1308. }
  1309. }
  1310. }
  1311. function invalidateRow(row) {
  1312. invalidateRows([row]);
  1313. }
  1314. function updateCell(row, cell) {
  1315. var cellNode = getCellNode(row, cell);
  1316. if (!cellNode) {
  1317. return;
  1318. }
  1319. var m = columns[cell], d = getDataItem(row);
  1320. if (currentEditor && activeRow === row && activeCell === cell) {
  1321. currentEditor.loadValue(d);
  1322. } else {
  1323. cellNode.innerHTML = d ? getFormatter(row, m)(row, cell, getDataItemValueForColumn(d, m), m, d) : "";
  1324. invalidatePostProcessingResults(row);
  1325. }
  1326. }
  1327. function updateRow(row) {
  1328. var cacheEntry = rowsCache[row];
  1329. if (!cacheEntry) {
  1330. return;
  1331. }
  1332. ensureCellNodesInRowsCache(row);
  1333. var d = getDataItem(row);
  1334. for (var columnIdx in cacheEntry.cellNodesByColumnIdx) {
  1335. if (!cacheEntry.cellNodesByColumnIdx.hasOwnProperty(columnIdx)) {
  1336. continue;
  1337. }
  1338. columnIdx = columnIdx | 0;
  1339. var m = columns[columnIdx],
  1340. node = cacheEntry.cellNodesByColumnIdx[columnIdx];
  1341. if (row === activeRow && columnIdx === activeCell && currentEditor) {
  1342. currentEditor.loadValue(d);
  1343. } else if (d) {
  1344. node.innerHTML = getFormatter(row, m)(row, columnIdx, getDataItemValueForColumn(d, m), m, d);
  1345. } else {
  1346. node.innerHTML = "";
  1347. }
  1348. }
  1349. invalidatePostProcessingResults(row);
  1350. }
  1351. function getViewportHeight() {
  1352. return parseFloat($.css($container[0], "height", true)) -
  1353. parseFloat($.css($container[0], "paddingTop", true)) -
  1354. parseFloat($.css($container[0], "paddingBottom", true)) -
  1355. parseFloat($.css($headerScroller[0], "height")) - getVBoxDelta($headerScroller) -
  1356. (options.showTopPanel ? options.topPanelHeight + getVBoxDelta($topPanelScroller) : 0) -
  1357. (options.showHeaderRow ? options.headerRowHeight + getVBoxDelta($headerRowScroller) : 0);
  1358. }
  1359. function resizeCanvas() {
  1360. if (!initialized) { return; }
  1361. if (options.autoHeight) {
  1362. viewportH = options.rowHeight * getDataLengthIncludingAddNew();
  1363. } else {
  1364. viewportH = getViewportHeight();
  1365. }
  1366. numVisibleRows = Math.ceil(viewportH / options.rowHeight);
  1367. viewportW = parseFloat($.css($container[0], "width", true));
  1368. if (!options.autoHeight) {
  1369. $viewport.height(viewportH);
  1370. }
  1371. if (options.forceFitColumns) {
  1372. autosizeColumns();
  1373. }
  1374. updateRowCount();
  1375. handleScroll();
  1376. // Since the width has changed, force the render() to reevaluate virtually rendered cells.
  1377. lastRenderedScrollLeft = -1;
  1378. render();
  1379. }
  1380. function updateRowCount() {
  1381. var dataLength = getDataLength();
  1382. if (!initialized) { return; }
  1383. numberOfRows = getDataLengthIncludingAddNew() +
  1384. (options.leaveSpaceForNewRows ? numVisibleRows - 1 : 0);
  1385. var oldViewportHasVScroll = viewportHasVScroll;
  1386. // with autoHeight, we do not need to accommodate the vertical scroll bar
  1387. viewportHasVScroll = !options.autoHeight && (numberOfRows * options.rowHeight > viewportH);
  1388. // remove the rows that are now outside of the data range
  1389. // this helps avoid redundant calls to .removeRow() when the size of the data decreased by thousands of rows
  1390. var l = getDataLengthIncludingAddNew() - 1;
  1391. for (var i in rowsCache) {
  1392. if (i >= l) {
  1393. removeRowFromCache(i);
  1394. }
  1395. }
  1396. if (activeCellNode && activeRow > l) {
  1397. resetActiveCell();
  1398. }
  1399. var oldH = h;
  1400. th = Math.max(options.rowHeight * numberOfRows, viewportH - scrollbarDimensions.height);
  1401. if (th < maxSupportedCssHeight) {
  1402. // just one page
  1403. h = ph = th;
  1404. n = 1;
  1405. cj = 0;
  1406. } else {
  1407. // break into pages
  1408. h = maxSupportedCssHeight;
  1409. ph = h / 100;
  1410. n = Math.floor(th / ph);
  1411. cj = (th - h) / (n - 1);
  1412. }
  1413. if (h !== oldH) {
  1414. $canvas.css("height", h);
  1415. scrollTop = $viewport[0].scrollTop;
  1416. }
  1417. var oldScrollTopInRange = (scrollTop + offset <= th - viewportH);
  1418. if (th == 0 || scrollTop == 0) {
  1419. page = offset = 0;
  1420. } else if (oldScrollTopInRange) {
  1421. // maintain virtual position
  1422. scrollTo(scrollTop + offset);
  1423. } else {
  1424. // scroll to bottom
  1425. scrollTo(th - viewportH);
  1426. }
  1427. if (h != oldH && options.autoHeight) {
  1428. resizeCanvas();
  1429. }
  1430. if (options.forceFitColumns && oldViewportHasVScroll != viewportHasVScroll) {
  1431. autosizeColumns();
  1432. }
  1433. updateCanvasWidth(false);
  1434. }
  1435. function getVisibleRange(viewportTop, viewportLeft) {
  1436. if (viewportTop == null) {
  1437. viewportTop = scrollTop;
  1438. }
  1439. if (viewportLeft == null) {
  1440. viewportLeft = scrollLeft;
  1441. }
  1442. return {
  1443. top: getRowFromPosition(viewportTop),
  1444. bottom: getRowFromPosition(viewportTop + viewportH) + 1,
  1445. leftPx: viewportLeft,
  1446. rightPx: viewportLeft + viewportW
  1447. };
  1448. }
  1449. function getRenderedRange(viewportTop, viewportLeft) {
  1450. var range = getVisibleRange(viewportTop, viewportLeft);
  1451. var buffer = Math.round(viewportH / options.rowHeight);
  1452. var minBuffer = 3;
  1453. if (vScrollDir == -1) {
  1454. range.top -= buffer;
  1455. range.bottom += minBuffer;
  1456. } else if (vScrollDir == 1) {
  1457. range.top -= minBuffer;
  1458. range.bottom += buffer;
  1459. } else {
  1460. range.top -= minBuffer;
  1461. range.bottom += minBuffer;
  1462. }
  1463. range.top = Math.max(0, range.top);
  1464. range.bottom = Math.min(getDataLengthIncludingAddNew() - 1, range.bottom);
  1465. range.leftPx -= viewportW;
  1466. range.rightPx += viewportW;
  1467. range.leftPx = Math.max(0, range.leftPx);
  1468. range.rightPx = Math.min(canvasWidth, range.rightPx);
  1469. return range;
  1470. }
  1471. function ensureCellNodesInRowsCache(row) {
  1472. var cacheEntry = rowsCache[row];
  1473. if (cacheEntry) {
  1474. if (cacheEntry.cellRenderQueue.length) {
  1475. var lastChild = cacheEntry.rowNode.lastChild;
  1476. while (cacheEntry.cellRenderQueue.length) {
  1477. var columnIdx = cacheEntry.cellRenderQueue.pop();
  1478. cacheEntry.cellNodesByColumnIdx[columnIdx] = lastChild;
  1479. lastChild = lastChild.previousSibling;
  1480. }
  1481. }
  1482. }
  1483. }
  1484. function cleanUpCells(range, row) {
  1485. var totalCellsRemoved = 0;
  1486. var cacheEntry = rowsCache[row];
  1487. // Remove cells outside the range.
  1488. var cellsToRemove = [];
  1489. for (var i in cacheEntry.cellNodesByColumnIdx) {
  1490. // I really hate it when people mess with Array.prototype.
  1491. if (!cacheEntry.cellNodesByColumnIdx.hasOwnProperty(i)) {
  1492. continue;
  1493. }
  1494. // This is a string, so it needs to be cast back to a number.
  1495. i = i | 0;
  1496. var colspan = cacheEntry.cellColSpans[i];
  1497. if (columnPosLeft[i] > range.rightPx ||
  1498. columnPosRight[Math.min(columns.length - 1, i + colspan - 1)] < range.leftPx) {
  1499. if (!(row == activeRow && i == activeCell)) {
  1500. cellsToRemove.push(i);
  1501. }
  1502. }
  1503. }
  1504. var cellToRemove;
  1505. while ((cellToRemove = cellsToRemove.pop()) != null) {
  1506. cacheEntry.rowNode.removeChild(cacheEntry.cellNodesByColumnIdx[cellToRemove]);
  1507. delete cacheEntry.cellColSpans[cellToRemove];
  1508. delete cacheEntry.cellNodesByColumnIdx[cellToRemove];
  1509. if (postProcessedRows[row]) {
  1510. delete postProcessedRows[row][cellToRemove];
  1511. }
  1512. totalCellsRemoved++;
  1513. }
  1514. }
  1515. function cleanUpAndRenderCells(range) {
  1516. var cacheEntry;
  1517. var stringArray = [];
  1518. var processedRows = [];
  1519. var cellsAdded;
  1520. var totalCellsAdded = 0;
  1521. var colspan;
  1522. for (var row = range.top, btm = range.bottom; row <= btm; row++) {
  1523. cacheEntry = rowsCache[row];
  1524. if (!cacheEntry) {
  1525. continue;
  1526. }
  1527. // cellRenderQueue populated in renderRows() needs to be cleared first
  1528. ensureCellNodesInRowsCache(row);
  1529. cleanUpCells(range, row);
  1530. // Render missing cells.
  1531. cellsAdded = 0;
  1532. var metadata = data.getItemMetadata && data.getItemMetadata(row);
  1533. metadata = metadata && metadata.columns;
  1534. var d = getDataItem(row);
  1535. // TODO: shorten this loop (index? heuristics? binary search?)
  1536. for (var i = 0, ii = columns.length; i < ii; i++) {
  1537. // Cells to the right are outside the range.
  1538. if (columnPosLeft[i] > range.rightPx) {
  1539. break;
  1540. }
  1541. // Already rendered.
  1542. if ((colspan = cacheEntry.cellColSpans[i]) != null) {
  1543. i += (colspan > 1 ? colspan - 1 : 0);
  1544. continue;
  1545. }
  1546. colspan = 1;
  1547. if (metadata) {
  1548. var columnData = metadata[columns[i].id] || metadata[i];
  1549. colspan = (columnData && columnData.colspan) || 1;
  1550. if (colspan === "*") {
  1551. colspan = ii - i;
  1552. }
  1553. }
  1554. if (columnPosRight[Math.min(ii - 1, i + colspan - 1)] > range.leftPx) {
  1555. appendCellHtml(stringArray, row, i, colspan, d);
  1556. cellsAdded++;
  1557. }
  1558. i += (colspan > 1 ? colspan - 1 : 0);
  1559. }
  1560. if (cellsAdded) {
  1561. totalCellsAdded += cellsAdded;
  1562. processedRows.push(row);
  1563. }
  1564. }
  1565. if (!stringArray.length) {
  1566. return;
  1567. }
  1568. var x = document.createElement("div");
  1569. x.innerHTML = stringArray.join("");
  1570. var processedRow;
  1571. var node;
  1572. while ((processedRow = processedRows.pop()) != null) {
  1573. cacheEntry = rowsCache[processedRow];
  1574. var columnIdx;
  1575. while ((columnIdx = cacheEntry.cellRenderQueue.pop()) != null) {
  1576. node = x.lastChild;
  1577. cacheEntry.rowNode.appendChild(node);
  1578. cacheEntry.cellNodesByColumnIdx[columnIdx] = node;
  1579. }
  1580. }
  1581. }
  1582. function renderRows(range) {
  1583. var parentNode = $canvas[0],
  1584. stringArray = [],
  1585. rows = [],
  1586. needToReselectCell = false,
  1587. dataLength = getDataLength();
  1588. for (var i = range.top, ii = range.bottom; i <= ii; i++) {
  1589. if (rowsCache[i]) {
  1590. continue;
  1591. }
  1592. renderedRows++;
  1593. rows.push(i);
  1594. // Create an entry right away so that appendRowHtml() can
  1595. // start populatating it.
  1596. rowsCache[i] = {
  1597. "rowNode": null,
  1598. // ColSpans of rendered cells (by column idx).
  1599. // Can also be used for checking whether a cell has been rendered.
  1600. "cellColSpans": [],
  1601. // Cell nodes (by column idx). Lazy-populated by ensureCellNodesInRowsCache().
  1602. "cellNodesByColumnIdx": [],
  1603. // Column indices of cell nodes that have been rendered, but not yet indexed in
  1604. // cellNodesByColumnIdx. These are in the same order as cell nodes added at the
  1605. // end of the row.
  1606. "cellRenderQueue": []
  1607. };
  1608. appendRowHtml(stringArray, i, range, dataLength);
  1609. if (activeCellNode && activeRow === i) {
  1610. needToReselectCell = true;
  1611. }
  1612. counter_rows_rendered++;
  1613. }
  1614. if (!rows.length) { return; }
  1615. var x = document.createElement("div");
  1616. x.innerHTML = stringArray.join("");
  1617. for (var i = 0, ii = rows.length; i < ii; i++) {
  1618. rowsCache[rows[i]].rowNode = parentNode.appendChild(x.firstChild);
  1619. }
  1620. if (needToReselectCell) {
  1621. activeCellNode = getCellNode(activeRow, activeCell);
  1622. }
  1623. }
  1624. function startPostProcessing() {
  1625. if (!options.enableAsyncPostRender) {
  1626. return;
  1627. }
  1628. clearTimeout(h_postrender);
  1629. h_postrender = setTimeout(asyncPostProcessRows, options.asyncPostRenderDelay);
  1630. }
  1631. function invalidatePostProcessingResults(row) {
  1632. delete postProcessedRows[row];
  1633. postProcessFromRow = Math.min(postProcessFromRow, row);
  1634. postProcessToRow = Math.max(postProcessToRow, row);
  1635. startPostProcessing();
  1636. }
  1637. function updateRowPositions() {
  1638. for (var row in rowsCache) {
  1639. rowsCache[row].rowNode.style.top = getRowTop(row) + "px";
  1640. }
  1641. }
  1642. function render() {
  1643. if (!initialized) { return; }
  1644. var visible = getVisibleRange();
  1645. var rendered = getRenderedRange();
  1646. // remove rows no longer in the viewport
  1647. cleanupRows(rendered);
  1648. // add new rows & missing cells in existing rows
  1649. if (lastRenderedScrollLeft != scrollLeft) {
  1650. cleanUpAndRenderCells(rendered);
  1651. }
  1652. // render missing rows
  1653. renderRows(rendered);
  1654. postProcessFromRow = visible.top;
  1655. postProcessToRow = Math.min(getDataLengthIncludingAddNew() - 1, visible.bottom);
  1656. startPostProcessing();
  1657. lastRenderedScrollTop = scrollTop;
  1658. lastRenderedScrollLeft = scrollLeft;
  1659. h_render = null;
  1660. }
  1661. function handleHeaderRowScroll() {
  1662. var scrollLeft = $headerRowScroller[0].scrollLeft;
  1663. if (scrollLeft != $viewport[0].scrollLeft) {
  1664. $viewport[0].scrollLeft = scrollLeft;
  1665. }
  1666. }
  1667. function handleScroll() {
  1668. scrollTop = $viewport[0].scrollTop;
  1669. scrollLeft = $viewport[0].scrollLeft;
  1670. var vScrollDist = Math.abs(scrollTop - prevScrollTop);
  1671. var hScrollDist = Math.abs(scrollLeft - prevScrollLeft);
  1672. if (hScrollDist) {
  1673. prevScrollLeft = scrollLeft;
  1674. $headerScroller[0].scrollLeft = scrollLeft;
  1675. $topPanelScroller[0].scrollLeft = scrollLeft;
  1676. $headerRowScroller[0].scrollLeft = scrollLeft;
  1677. }
  1678. if (vScrollDist) {
  1679. vScrollDir = prevScrollTop < scrollTop ? 1 : -1;
  1680. prevScrollTop = scrollTop;
  1681. // switch virtual pages if needed
  1682. if (vScrollDist < viewportH) {
  1683. scrollTo(scrollTop + offset);
  1684. } else {
  1685. var oldOffset = offset;
  1686. if (h == viewportH) {
  1687. page = 0;
  1688. } else {
  1689. page = Math.min(n - 1, Math.floor(scrollTop * ((th - viewportH) / (h - viewportH)) * (1 / ph)));
  1690. }
  1691. offset = Math.round(page * cj);
  1692. if (oldOffset != offset) {
  1693. invalidateAllRows();
  1694. }
  1695. }
  1696. }
  1697. if (hScrollDist || vScrollDist) {
  1698. if (h_render) {
  1699. clearTimeout(h_render);
  1700. }
  1701. if (Math.abs(lastRenderedScrollTop - scrollTop) > 20 ||
  1702. Math.abs(lastRenderedScrollLeft - scrollLeft) > 20) {
  1703. if (options.forceSyncScrolling || (
  1704. Math.abs(lastRenderedScrollTop - scrollTop) < viewportH &&
  1705. Math.abs(lastRenderedScrollLeft - scrollLeft) < viewportW)) {
  1706. render();
  1707. } else {
  1708. h_render = setTimeout(render, 50);
  1709. }
  1710. trigger(self.onViewportChanged, {});
  1711. }
  1712. }
  1713. trigger(self.onScroll, {scrollLeft: scrollLeft, scrollTop: scrollTop});
  1714. }
  1715. function asyncPostProcessRows() {
  1716. while (postProcessFromRow <= postProcessToRow) {
  1717. var row = (vScrollDir >= 0) ? postProcessFromRow++ : postProcessToRow--;
  1718. var cacheEntry = rowsCache[row];
  1719. if (!cacheEntry || row >= getDataLength()) {
  1720. continue;
  1721. }
  1722. if (!postProcessedRows[row]) {
  1723. postProcessedRows[row] = {};
  1724. }
  1725. ensureCellNodesInRowsCache(row);
  1726. for (var columnIdx in cacheEntry.cellNodesByColumnIdx) {
  1727. if (!cacheEntry.cellNodesByColumnIdx.hasOwnProperty(columnIdx)) {
  1728. continue;
  1729. }
  1730. columnIdx = columnIdx | 0;
  1731. var m = columns[columnIdx];
  1732. if (m.asyncPostRender && !postProcessedRows[row][columnIdx]) {
  1733. var node = cacheEntry.cellNodesByColumnIdx[columnIdx];
  1734. if (node) {
  1735. m.asyncPostRender(node, row, getDataItem(row), m);
  1736. }
  1737. postProcessedRows[row][columnIdx] = true;
  1738. }
  1739. }
  1740. h_postrender = setTimeout(asyncPostProcessRows, options.asyncPostRenderDelay);
  1741. return;
  1742. }
  1743. }
  1744. function updateCellCssStylesOnRenderedRows(addedHash, removedHash) {
  1745. var node, columnId, addedRowHash, removedRowHash;
  1746. for (var row in rowsCache) {
  1747. removedRowHash = removedHash && removedHash[row];
  1748. addedRowHash = addedHash && addedHash[row];
  1749. if (removedRowHash) {
  1750. for (columnId in removedRowHash) {
  1751. if (!addedRowHash || removedRowHash[columnId] != addedRowHash[columnId]) {
  1752. node = getCellNode(row, getColumnIndex(columnId));
  1753. if (node) {
  1754. $(node).removeClass(removedRowHash[columnId]);
  1755. }
  1756. }
  1757. }
  1758. }
  1759. if (addedRowHash) {
  1760. for (columnId in addedRowHash) {
  1761. if (!removedRowHash || removedRowHash[columnId] != addedRowHash[columnId]) {
  1762. node = getCellNode(row, getColumnIndex(columnId));
  1763. if (node) {
  1764. $(node).addClass(addedRowHash[columnId]);
  1765. }
  1766. }
  1767. }
  1768. }
  1769. }
  1770. }
  1771. function addCellCssStyles(key, hash) {
  1772. if (cellCssClasses[key]) {
  1773. throw "addCellCssStyles: cell CSS hash with key '" + key + "' already exists.";
  1774. }
  1775. cellCssClasses[key] = hash;
  1776. updateCellCssStylesOnRenderedRows(hash, null);
  1777. trigger(self.onCellCssStylesChanged, { "key": key, "hash": hash });
  1778. }
  1779. function removeCellCssStyles(key) {
  1780. if (!cellCssClasses[key]) {
  1781. return;
  1782. }
  1783. updateCellCssStylesOnRenderedRows(null, cellCssClasses[key]);
  1784. delete cellCssClasses[key];
  1785. trigger(self.onCellCssStylesChanged, { "key": key, "hash": null });
  1786. }
  1787. function setCellCssStyles(key, hash) {
  1788. var prevHash = cellCssClasses[key];
  1789. cellCssClasses[key] = hash;
  1790. updateCellCssStylesOnRenderedRows(hash, prevHash);
  1791. trigger(self.onCellCssStylesChanged, { "key": key, "hash": hash });
  1792. }
  1793. function getCellCssStyles(key) {
  1794. return cellCssClasses[key];
  1795. }
  1796. function flashCell(row, cell, speed) {
  1797. speed = speed || 100;
  1798. if (rowsCache[row]) {
  1799. var $cell = $(getCellNode(row, cell));
  1800. function toggleCellClass(times) {
  1801. if (!times) {
  1802. return;
  1803. }
  1804. setTimeout(function () {
  1805. $cell.queue(function () {
  1806. $cell.toggleClass(options.cellFlashingCssClass).dequeue();
  1807. toggleCellClass(times - 1);
  1808. });
  1809. },
  1810. speed);
  1811. }
  1812. toggleCellClass(4);
  1813. }
  1814. }
  1815. //////////////////////////////////////////////////////////////////////////////////////////////
  1816. // Interactivity
  1817. function handleDragInit(e, dd) {
  1818. var cell = getCellFromEvent(e);
  1819. if (!cell || !cellExists(cell.row, cell.cell)) {
  1820. return false;
  1821. }
  1822. var retval = trigger(self.onDragInit, dd, e);
  1823. if (e.isImmediatePropagationStopped()) {
  1824. return retval;
  1825. }
  1826. // if nobody claims to be handling drag'n'drop by stopping immediate propagation,
  1827. // cancel out of it
  1828. return false;
  1829. }
  1830. function handleDragStart(e, dd) {
  1831. var cell = getCellFromEvent(e);
  1832. if (!cell || !cellExists(cell.row, cell.cell)) {
  1833. return false;
  1834. }
  1835. var retval = trigger(self.onDragStart, dd, e);
  1836. if (e.isImmediatePropagationStopped()) {
  1837. return retval;
  1838. }
  1839. return false;
  1840. }
  1841. function handleDrag(e, dd) {
  1842. return trigger(self.onDrag, dd, e);
  1843. }
  1844. function handleDragEnd(e, dd) {
  1845. trigger(self.onDragEnd, dd, e);
  1846. }
  1847. function handleKeyDown(e) {
  1848. trigger(self.onKeyDown, {row: activeRow, cell: activeCell}, e);
  1849. var handled = e.isImmediatePropagationStopped();
  1850. if (!handled) {
  1851. if (!e.shiftKey && !e.altKey && !e.ctrlKey) {
  1852. if (e.which == 27) {
  1853. if (!getEditorLock().isActive()) {
  1854. return; // no editing mode to cancel, allow bubbling and default processing (exit without cancelling the event)
  1855. }
  1856. cancelEditAndSetFocus();
  1857. } else if (e.which == 34) {
  1858. navigatePageDown();
  1859. handled = true;
  1860. } else if (e.which == 33) {
  1861. navigatePageUp();
  1862. handled = true;
  1863. } else if (e.which == 37) {
  1864. handled = navigateLeft();
  1865. } else if (e.which == 39) {
  1866. handled = navigateRight();
  1867. } else if (e.which == 38) {
  1868. handled = navigateUp();
  1869. } else if (e.which == 40) {
  1870. handled = navigateDown();
  1871. } else if (e.which == 9) {
  1872. handled = navigateNext();
  1873. } else if (e.which == 13) {
  1874. if (options.editable) {
  1875. if (currentEditor) {
  1876. // adding new row
  1877. if (activeRow === getDataLength()) {
  1878. navigateDown();
  1879. } else {
  1880. commitEditAndSetFocus();
  1881. }
  1882. } else {
  1883. if (getEditorLock().commitCurrentEdit()) {
  1884. makeActiveCellEditable();
  1885. }
  1886. }
  1887. }
  1888. handled = true;
  1889. }
  1890. } else if (e.which == 9 && e.shiftKey && !e.ctrlKey && !e.altKey) {
  1891. handled = navigatePrev();
  1892. }
  1893. }
  1894. if (handled) {
  1895. // the event has been handled so don't let parent element (bubbling/propagation) or browser (default) handle it
  1896. e.stopPropagation();
  1897. e.preventDefault();
  1898. try {
  1899. e.originalEvent.keyCode = 0; // prevent default behaviour for special keys in IE browsers (F3, F5, etc.)
  1900. }
  1901. // ignore exceptions - setting the original event's keycode throws access denied exception for "Ctrl"
  1902. // (hitting control key only, nothing else), "Shift" (maybe others)
  1903. catch (error) {
  1904. }
  1905. }
  1906. }
  1907. function handleClick(e) {
  1908. if (!currentEditor) {
  1909. // if this click resulted in some cell child node getting focus,
  1910. // don't steal it back - keyboard events will still bubble up
  1911. // IE9+ seems to default DIVs to tabIndex=0 instead of -1, so check for cell clicks directly.
  1912. if (e.target != document.activeElement || $(e.target).hasClass("slick-cell")) {
  1913. setFocus();
  1914. }
  1915. }
  1916. var cell = getCellFromEvent(e);
  1917. if (!cell || (currentEditor !== null && activeRow == cell.row && activeCell == cell.cell)) {
  1918. return;
  1919. }
  1920. trigger(self.onClick, {row: cell.row, cell: cell.cell}, e);
  1921. if (e.isImmediatePropagationStopped()) {
  1922. return;
  1923. }
  1924. if ((activeCell != cell.cell || activeRow != cell.row) && canCellBeActive(cell.row, cell.cell)) {
  1925. if (!getEditorLock().isActive() || getEditorLock().commitCurrentEdit()) {
  1926. scrollRowIntoView(cell.row, false);
  1927. setActiveCellInternal(getCellNode(cell.row, cell.cell));
  1928. }
  1929. }
  1930. }
  1931. function handleContextMenu(e) {
  1932. var $cell = $(e.target).closest(".slick-cell", $canvas);
  1933. if ($cell.length === 0) {
  1934. return;
  1935. }
  1936. // are we editing this cell?
  1937. if (activeCellNode === $cell[0] && currentEditor !== null) {
  1938. return;
  1939. }
  1940. trigger(self.onContextMenu, {}, e);
  1941. }
  1942. function handleDblClick(e) {
  1943. var cell = getCellFromEvent(e);
  1944. if (!cell || (currentEditor !== null && activeRow == cell.row && activeCell == cell.cell)) {
  1945. return;
  1946. }
  1947. trigger(self.onDblClick, {row: cell.row, cell: cell.cell}, e);
  1948. if (e.isImmediatePropagationStopped()) {
  1949. return;
  1950. }
  1951. if (options.editable) {
  1952. gotoCell(cell.row, cell.cell, true);
  1953. }
  1954. }
  1955. function handleHeaderMouseEnter(e) {
  1956. trigger(self.onHeaderMouseEnter, {
  1957. "column": $(this).data("column")
  1958. }, e);
  1959. }
  1960. function handleHeaderMouseLeave(e) {
  1961. trigger(self.onHeaderMouseLeave, {
  1962. "column": $(this).data("column")
  1963. }, e);
  1964. }
  1965. function handleHeaderContextMenu(e) {
  1966. var $header = $(e.target).closest(".slick-header-column", ".slick-header-columns");
  1967. var column = $header && $header.data("column");
  1968. trigger(self.onHeaderContextMenu, {column: column}, e);
  1969. }
  1970. function handleHeaderClick(e) {
  1971. var $header = $(e.target).closest(".slick-header-column", ".slick-header-columns");
  1972. var column = $header && $header.data("column");
  1973. if (column) {
  1974. trigger(self.onHeaderClick, {column: column}, e);
  1975. }
  1976. }
  1977. function handleMouseEnter(e) {
  1978. trigger(self.onMouseEnter, {}, e);
  1979. }
  1980. function handleMouseLeave(e) {
  1981. trigger(self.onMouseLeave, {}, e);
  1982. }
  1983. function cellExists(row, cell) {
  1984. return !(row < 0 || row >= getDataLength() || cell < 0 || cell >= columns.length);
  1985. }
  1986. function getCellFromPoint(x, y) {
  1987. var row = getRowFromPosition(y);
  1988. var cell = 0;
  1989. var w = 0;
  1990. for (var i = 0; i < columns.length && w < x; i++) {
  1991. w += columns[i].width;
  1992. cell++;
  1993. }
  1994. if (cell < 0) {
  1995. cell = 0;
  1996. }
  1997. return {row: row, cell: cell - 1};
  1998. }
  1999. function getCellFromNode(cellNode) {
  2000. // read column number from .l<columnNumber> CSS class
  2001. var cls = /l\d+/.exec(cellNode.className);
  2002. if (!cls) {
  2003. throw "getCellFromNode: cannot get cell - " + cellNode.className;
  2004. }
  2005. return parseInt(cls[0].substr(1, cls[0].length - 1), 10);
  2006. }
  2007. function getRowFromNode(rowNode) {
  2008. for (var row in rowsCache) {
  2009. if (rowsCache[row].rowNode === rowNode) {
  2010. return row | 0;
  2011. }
  2012. }
  2013. return null;
  2014. }
  2015. function getCellFromEvent(e) {
  2016. var $cell = $(e.target).closest(".slick-cell", $canvas);
  2017. if (!$cell.length) {
  2018. return null;
  2019. }
  2020. var row = getRowFromNode($cell[0].parentNode);
  2021. var cell = getCellFromNode($cell[0]);
  2022. if (row == null || cell == null) {
  2023. return null;
  2024. } else {
  2025. return {
  2026. "row": row,
  2027. "cell": cell
  2028. };
  2029. }
  2030. }
  2031. function getCellNodeBox(row, cell) {
  2032. if (!cellExists(row, cell)) {
  2033. return null;
  2034. }
  2035. var y1 = getRowTop(row);
  2036. var y2 = y1 + options.rowHeight - 1;
  2037. var x1 = 0;
  2038. for (var i = 0; i < cell; i++) {
  2039. x1 += columns[i].width;
  2040. }
  2041. var x2 = x1 + columns[cell].width;
  2042. return {
  2043. top: y1,
  2044. left: x1,
  2045. bottom: y2,
  2046. right: x2
  2047. };
  2048. }
  2049. //////////////////////////////////////////////////////////////////////////////////////////////
  2050. // Cell switching
  2051. function resetActiveCell() {
  2052. setActiveCellInternal(null, false);
  2053. }
  2054. function setFocus() {
  2055. if (tabbingDirection == -1) {
  2056. $focusSink[0].focus();
  2057. } else {
  2058. $focusSink2[0].focus();
  2059. }
  2060. }
  2061. function scrollCellIntoView(row, cell, doPaging) {
  2062. scrollRowIntoView(row, doPaging);
  2063. var colspan = getColspan(row, cell);
  2064. var left = columnPosLeft[cell],
  2065. right = columnPosRight[cell + (colspan > 1 ? colspan - 1 : 0)],
  2066. scrollRight = scrollLeft + viewportW;
  2067. if (left < scrollLeft) {
  2068. $viewport.scrollLeft(left);
  2069. handleScroll();
  2070. render();
  2071. } else if (right > scrollRight) {
  2072. $viewport.scrollLeft(Math.min(left, right - $viewport[0].clientWidth));
  2073. handleScroll();
  2074. render();
  2075. }
  2076. }
  2077. function setActiveCellInternal(newCell, opt_editMode) {
  2078. if (activeCellNode !== null) {
  2079. makeActiveCellNormal();
  2080. $(activeCellNode).removeClass("active");
  2081. if (rowsCache[activeRow]) {
  2082. $(rowsCache[activeRow].rowNode).removeClass("active");
  2083. }
  2084. }
  2085. var activeCellChanged = (activeCellNode !== newCell);
  2086. activeCellNode = newCell;
  2087. if (activeCellNode != null) {
  2088. activeRow = getRowFromNode(activeCellNode.parentNode);
  2089. activeCell = activePosX = getCellFromNode(activeCellNode);
  2090. if (opt_editMode == null) {
  2091. opt_editMode = (activeRow == getDataLength()) || options.autoEdit;
  2092. }
  2093. $(activeCellNode).addClass("active");
  2094. $(rowsCache[activeRow].rowNode).addClass("active");
  2095. if (options.editable && opt_editMode && isCellPotentiallyEditable(activeRow, activeCell)) {
  2096. clearTimeout(h_editorLoader);
  2097. if (options.asyncEditorLoading) {
  2098. h_editorLoader = setTimeout(function () {
  2099. makeActiveCellEditable();
  2100. }, options.asyncEditorLoadDelay);
  2101. } else {
  2102. makeActiveCellEditable();
  2103. }
  2104. }
  2105. } else {
  2106. activeRow = activeCell = null;
  2107. }
  2108. if (activeCellChanged) {
  2109. trigger(self.onActiveCellChanged, getActiveCell());
  2110. }
  2111. }
  2112. function clearTextSelection() {
  2113. if (document.selection && document.selection.empty) {
  2114. try {
  2115. //IE fails here if selected element is not in dom
  2116. document.selection.empty();
  2117. } catch (e) { }
  2118. } else if (window.getSelection) {
  2119. var sel = window.getSelection();
  2120. if (sel && sel.removeAllRanges) {
  2121. sel.removeAllRanges();
  2122. }
  2123. }
  2124. }
  2125. function isCellPotentiallyEditable(row, cell) {
  2126. // is the data for this row loaded?
  2127. if (row < getDataLength() && !getDataItem(row)) {
  2128. return false;
  2129. }
  2130. // are we in the Add New row? can we create new from this cell?
  2131. if (columns[cell].cannotTriggerInsert && row >= getDataLength()) {
  2132. return false;
  2133. }
  2134. // does this cell have an editor?
  2135. if (!getEditor(row, cell)) {
  2136. return false;
  2137. }
  2138. return true;
  2139. }
  2140. function makeActiveCellNormal() {
  2141. if (!currentEditor) {
  2142. return;
  2143. }
  2144. trigger(self.onBeforeCellEditorDestroy, {editor: currentEditor});
  2145. currentEditor.destroy();
  2146. currentEditor = null;
  2147. if (activeCellNode) {
  2148. var d = getDataItem(activeRow);
  2149. $(activeCellNode).removeClass("editable invalid");
  2150. if (d) {
  2151. var column = columns[activeCell];
  2152. var formatter = getFormatter(activeRow, column);
  2153. activeCellNode.innerHTML = formatter(activeRow, activeCell, getDataItemValueForColumn(d, column), column, d);
  2154. invalidatePostProcessingResults(activeRow);
  2155. }
  2156. }
  2157. // if there previously was text selected on a page (such as selected text in the edit cell just removed),
  2158. // IE can't set focus to anything else correctly
  2159. if (navigator.userAgent.toLowerCase().match(/msie/)) {
  2160. clearTextSelection();
  2161. }
  2162. getEditorLock().deactivate(editController);
  2163. }
  2164. function makeActiveCellEditable(editor) {
  2165. if (!activeCellNode) {
  2166. return;
  2167. }
  2168. if (!options.editable) {
  2169. throw "Grid : makeActiveCellEditable : should never get called when options.editable is false";
  2170. }
  2171. // cancel pending async call if there is one
  2172. clearTimeout(h_editorLoader);
  2173. if (!isCellPotentiallyEditable(activeRow, activeCell)) {
  2174. return;
  2175. }
  2176. var columnDef = columns[activeCell];
  2177. var item = getDataItem(activeRow);
  2178. if (trigger(self.onBeforeEditCell, {row: activeRow, cell: activeCell, item: item, column: columnDef}) === false) {
  2179. setFocus();
  2180. return;
  2181. }
  2182. getEditorLock().activate(editController);
  2183. $(activeCellNode).addClass("editable");
  2184. // don't clear the cell if a custom editor is passed through
  2185. if (!editor) {
  2186. activeCellNode.innerHTML = "";
  2187. }
  2188. currentEditor = new (editor || getEditor(activeRow, activeCell))({
  2189. grid: self,
  2190. gridPosition: absBox($container[0]),
  2191. position: absBox(activeCellNode),
  2192. container: activeCellNode,
  2193. column: columnDef,
  2194. item: item || {},
  2195. commitChanges: commitEditAndSetFocus,
  2196. cancelChanges: cancelEditAndSetFocus
  2197. });
  2198. if (item) {
  2199. currentEditor.loadValue(item);
  2200. }
  2201. serializedEditorValue = currentEditor.serializeValue();
  2202. if (currentEditor.position) {
  2203. handleActiveCellPositionChange();
  2204. }
  2205. }
  2206. function commitEditAndSetFocus() {
  2207. // if the commit fails, it would do so due to a validation error
  2208. // if so, do not steal the focus from the editor
  2209. if (getEditorLock().commitCurrentEdit()) {
  2210. setFocus();
  2211. if (options.autoEdit) {
  2212. navigateDown();
  2213. }
  2214. }
  2215. }
  2216. function cancelEditAndSetFocus() {
  2217. if (getEditorLock().cancelCurrentEdit()) {
  2218. setFocus();
  2219. }
  2220. }
  2221. function absBox(elem) {
  2222. var box = {
  2223. top: elem.offsetTop,
  2224. left: elem.offsetLeft,
  2225. bottom: 0,
  2226. right: 0,
  2227. width: $(elem).outerWidth(),
  2228. height: $(elem).outerHeight(),
  2229. visible: true};
  2230. box.bottom = box.top + box.height;
  2231. box.right = box.left + box.width;
  2232. // walk up the tree
  2233. var offsetParent = elem.offsetParent;
  2234. while ((elem = elem.parentNode) != document.body) {
  2235. if (box.visible && elem.scrollHeight != elem.offsetHeight && $(elem).css("overflowY") != "visible") {
  2236. box.visible = box.bottom > elem.scrollTop && box.top < elem.scrollTop + elem.clientHeight;
  2237. }
  2238. if (box.visible && elem.scrollWidth != elem.offsetWidth && $(elem).css("overflowX") != "visible") {
  2239. box.visible = box.right > elem.scrollLeft && box.left < elem.scrollLeft + elem.clientWidth;
  2240. }
  2241. box.left -= elem.scrollLeft;
  2242. box.top -= elem.scrollTop;
  2243. if (elem === offsetParent) {
  2244. box.left += elem.offsetLeft;
  2245. box.top += elem.offsetTop;
  2246. offsetParent = elem.offsetParent;
  2247. }
  2248. box.bottom = box.top + box.height;
  2249. box.right = box.left + box.width;
  2250. }
  2251. return box;
  2252. }
  2253. function getActiveCellPosition() {
  2254. return absBox(activeCellNode);
  2255. }
  2256. function getGridPosition() {
  2257. return absBox($container[0])
  2258. }
  2259. function handleActiveCellPositionChange() {
  2260. if (!activeCellNode) {
  2261. return;
  2262. }
  2263. trigger(self.onActiveCellPositionChanged, {});
  2264. if (currentEditor) {
  2265. var cellBox = getActiveCellPosition();
  2266. if (currentEditor.show && currentEditor.hide) {
  2267. if (!cellBox.visible) {
  2268. currentEditor.hide();
  2269. } else {
  2270. currentEditor.show();
  2271. }
  2272. }
  2273. if (currentEditor.position) {
  2274. currentEditor.position(cellBox);
  2275. }
  2276. }
  2277. }
  2278. function getCellEditor() {
  2279. return currentEditor;
  2280. }
  2281. function getActiveCell() {
  2282. if (!activeCellNode) {
  2283. return null;
  2284. } else {
  2285. return {row: activeRow, cell: activeCell};
  2286. }
  2287. }
  2288. function getActiveCellNode() {
  2289. return activeCellNode;
  2290. }
  2291. function scrollRowIntoView(row, doPaging) {
  2292. var rowAtTop = row * options.rowHeight;
  2293. var rowAtBottom = (row + 1) * options.rowHeight - viewportH + (viewportHasHScroll ? scrollbarDimensions.height : 0);
  2294. // need to page down?
  2295. if ((row + 1) * options.rowHeight > scrollTop + viewportH + offset) {
  2296. scrollTo(doPaging ? rowAtTop : rowAtBottom);
  2297. render();
  2298. }
  2299. // or page up?
  2300. else if (row * options.rowHeight < scrollTop + offset) {
  2301. scrollTo(doPaging ? rowAtBottom : rowAtTop);
  2302. render();
  2303. }
  2304. }
  2305. function scrollRowToTop(row) {
  2306. scrollTo(row * options.rowHeight);
  2307. render();
  2308. }
  2309. function scrollPage(dir) {
  2310. var deltaRows = dir * numVisibleRows;
  2311. scrollTo((getRowFromPosition(scrollTop) + deltaRows) * options.rowHeight);
  2312. render();
  2313. if (options.enableCellNavigation && activeRow != null) {
  2314. var row = activeRow + deltaRows;
  2315. if (row >= getDataLengthIncludingAddNew()) {
  2316. row = getDataLengthIncludingAddNew() - 1;
  2317. }
  2318. if (row < 0) {
  2319. row = 0;
  2320. }
  2321. var cell = 0, prevCell = null;
  2322. var prevActivePosX = activePosX;
  2323. while (cell <= activePosX) {
  2324. if (canCellBeActive(row, cell)) {
  2325. prevCell = cell;
  2326. }
  2327. cell += getColspan(row, cell);
  2328. }
  2329. if (prevCell !== null) {
  2330. setActiveCellInternal(getCellNode(row, prevCell));
  2331. activePosX = prevActivePosX;
  2332. } else {
  2333. resetActiveCell();
  2334. }
  2335. }
  2336. }
  2337. function navigatePageDown() {
  2338. scrollPage(1);
  2339. }
  2340. function navigatePageUp() {
  2341. scrollPage(-1);
  2342. }
  2343. function getColspan(row, cell) {
  2344. var metadata = data.getItemMetadata && data.getItemMetadata(row);
  2345. if (!metadata || !metadata.columns) {
  2346. return 1;
  2347. }
  2348. var columnData = metadata.columns[columns[cell].id] || metadata.columns[cell];
  2349. var colspan = (columnData && columnData.colspan);
  2350. if (colspan === "*") {
  2351. colspan = columns.length - cell;
  2352. } else {
  2353. colspan = colspan || 1;
  2354. }
  2355. return colspan;
  2356. }
  2357. function findFirstFocusableCell(row) {
  2358. var cell = 0;
  2359. while (cell < columns.length) {
  2360. if (canCellBeActive(row, cell)) {
  2361. return cell;
  2362. }
  2363. cell += getColspan(row, cell);
  2364. }
  2365. return null;
  2366. }
  2367. function findLastFocusableCell(row) {
  2368. var cell = 0;
  2369. var lastFocusableCell = null;
  2370. while (cell < columns.length) {
  2371. if (canCellBeActive(row, cell)) {
  2372. lastFocusableCell = cell;
  2373. }
  2374. cell += getColspan(row, cell);
  2375. }
  2376. return lastFocusableCell;
  2377. }
  2378. function gotoRight(row, cell, posX) {
  2379. if (cell >= columns.length) {
  2380. return null;
  2381. }
  2382. do {
  2383. cell += getColspan(row, cell);
  2384. }
  2385. while (cell < columns.length && !canCellBeActive(row, cell));
  2386. if (cell < columns.length) {
  2387. return {
  2388. "row": row,
  2389. "cell": cell,
  2390. "posX": cell
  2391. };
  2392. }
  2393. return null;
  2394. }
  2395. function gotoLeft(row, cell, posX) {
  2396. if (cell <= 0) {
  2397. return null;
  2398. }
  2399. var firstFocusableCell = findFirstFocusableCell(row);
  2400. if (firstFocusableCell === null || firstFocusableCell >= cell) {
  2401. return null;
  2402. }
  2403. var prev = {
  2404. "row": row,
  2405. "cell": firstFocusableCell,
  2406. "posX": firstFocusableCell
  2407. };
  2408. var pos;
  2409. while (true) {
  2410. pos = gotoRight(prev.row, prev.cell, prev.posX);
  2411. if (!pos) {
  2412. return null;
  2413. }
  2414. if (pos.cell >= cell) {
  2415. return prev;
  2416. }
  2417. prev = pos;
  2418. }
  2419. }
  2420. function gotoDown(row, cell, posX) {
  2421. var prevCell;
  2422. while (true) {
  2423. if (++row >= getDataLengthIncludingAddNew()) {
  2424. return null;
  2425. }
  2426. prevCell = cell = 0;
  2427. while (cell <= posX) {
  2428. prevCell = cell;
  2429. cell += getColspan(row, cell);
  2430. }
  2431. if (canCellBeActive(row, prevCell)) {
  2432. return {
  2433. "row": row,
  2434. "cell": prevCell,
  2435. "posX": posX
  2436. };
  2437. }
  2438. }
  2439. }
  2440. function gotoUp(row, cell, posX) {
  2441. var prevCell;
  2442. while (true) {
  2443. if (--row < 0) {
  2444. return null;
  2445. }
  2446. prevCell = cell = 0;
  2447. while (cell <= posX) {
  2448. prevCell = cell;
  2449. cell += getColspan(row, cell);
  2450. }
  2451. if (canCellBeActive(row, prevCell)) {
  2452. return {
  2453. "row": row,
  2454. "cell": prevCell,
  2455. "posX": posX
  2456. };
  2457. }
  2458. }
  2459. }
  2460. function gotoNext(row, cell, posX) {
  2461. if (row == null && cell == null) {
  2462. row = cell = posX = 0;
  2463. if (canCellBeActive(row, cell)) {
  2464. return {
  2465. "row": row,
  2466. "cell": cell,
  2467. "posX": cell
  2468. };
  2469. }
  2470. }
  2471. var pos = gotoRight(row, cell, posX);
  2472. if (pos) {
  2473. return pos;
  2474. }
  2475. var firstFocusableCell = null;
  2476. while (++row < getDataLengthIncludingAddNew()) {
  2477. firstFocusableCell = findFirstFocusableCell(row);
  2478. if (firstFocusableCell !== null) {
  2479. return {
  2480. "row": row,
  2481. "cell": firstFocusableCell,
  2482. "posX": firstFocusableCell
  2483. };
  2484. }
  2485. }
  2486. return null;
  2487. }
  2488. function gotoPrev(row, cell, posX) {
  2489. if (row == null && cell == null) {
  2490. row = getDataLengthIncludingAddNew() - 1;
  2491. cell = posX = columns.length - 1;
  2492. if (canCellBeActive(row, cell)) {
  2493. return {
  2494. "row": row,
  2495. "cell": cell,
  2496. "posX": cell
  2497. };
  2498. }
  2499. }
  2500. var pos;
  2501. var lastSelectableCell;
  2502. while (!pos) {
  2503. pos = gotoLeft(row, cell, posX);
  2504. if (pos) {
  2505. break;
  2506. }
  2507. if (--row < 0) {
  2508. return null;
  2509. }
  2510. cell = 0;
  2511. lastSelectableCell = findLastFocusableCell(row);
  2512. if (lastSelectableCell !== null) {
  2513. pos = {
  2514. "row": row,
  2515. "cell": lastSelectableCell,
  2516. "posX": lastSelectableCell
  2517. };
  2518. }
  2519. }
  2520. return pos;
  2521. }
  2522. function navigateRight() {
  2523. return navigate("right");
  2524. }
  2525. function navigateLeft() {
  2526. return navigate("left");
  2527. }
  2528. function navigateDown() {
  2529. return navigate("down");
  2530. }
  2531. function navigateUp() {
  2532. return navigate("up");
  2533. }
  2534. function navigateNext() {
  2535. return navigate("next");
  2536. }
  2537. function navigatePrev() {
  2538. return navigate("prev");
  2539. }
  2540. /**
  2541. * @param {string} dir Navigation direction.
  2542. * @return {boolean} Whether navigation resulted in a change of active cell.
  2543. */
  2544. function navigate(dir) {
  2545. if (!options.enableCellNavigation) {
  2546. return false;
  2547. }
  2548. if (!activeCellNode && dir != "prev" && dir != "next") {
  2549. return false;
  2550. }
  2551. if (!getEditorLock().commitCurrentEdit()) {
  2552. return true;
  2553. }
  2554. setFocus();
  2555. var tabbingDirections = {
  2556. "up": -1,
  2557. "down": 1,
  2558. "left": -1,
  2559. "right": 1,
  2560. "prev": -1,
  2561. "next": 1
  2562. };
  2563. tabbingDirection = tabbingDirections[dir];
  2564. var stepFunctions = {
  2565. "up": gotoUp,
  2566. "down": gotoDown,
  2567. "left": gotoLeft,
  2568. "right": gotoRight,
  2569. "prev": gotoPrev,
  2570. "next": gotoNext
  2571. };
  2572. var stepFn = stepFunctions[dir];
  2573. var pos = stepFn(activeRow, activeCell, activePosX);
  2574. if (pos) {
  2575. var isAddNewRow = (pos.row == getDataLength());
  2576. scrollCellIntoView(pos.row, pos.cell, !isAddNewRow);
  2577. setActiveCellInternal(getCellNode(pos.row, pos.cell));
  2578. activePosX = pos.posX;
  2579. return true;
  2580. } else {
  2581. setActiveCellInternal(getCellNode(activeRow, activeCell));
  2582. return false;
  2583. }
  2584. }
  2585. function getCellNode(row, cell) {
  2586. if (rowsCache[row]) {
  2587. ensureCellNodesInRowsCache(row);
  2588. return rowsCache[row].cellNodesByColumnIdx[cell];
  2589. }
  2590. return null;
  2591. }
  2592. function setActiveCell(row, cell) {
  2593. if (!initialized) { return; }
  2594. if (row > getDataLength() || row < 0 || cell >= columns.length || cell < 0) {
  2595. return;
  2596. }
  2597. if (!options.enableCellNavigation) {
  2598. return;
  2599. }
  2600. scrollCellIntoView(row, cell, false);
  2601. setActiveCellInternal(getCellNode(row, cell), false);
  2602. }
  2603. function canCellBeActive(row, cell) {
  2604. if (!options.enableCellNavigation || row >= getDataLengthIncludingAddNew() ||
  2605. row < 0 || cell >= columns.length || cell < 0) {
  2606. return false;
  2607. }
  2608. var rowMetadata = data.getItemMetadata && data.getItemMetadata(row);
  2609. if (rowMetadata && typeof rowMetadata.focusable === "boolean") {
  2610. return rowMetadata.focusable;
  2611. }
  2612. var columnMetadata = rowMetadata && rowMetadata.columns;
  2613. if (columnMetadata && columnMetadata[columns[cell].id] && typeof columnMetadata[columns[cell].id].focusable === "boolean") {
  2614. return columnMetadata[columns[cell].id].focusable;
  2615. }
  2616. if (columnMetadata && columnMetadata[cell] && typeof columnMetadata[cell].focusable === "boolean") {
  2617. return columnMetadata[cell].focusable;
  2618. }
  2619. return columns[cell].focusable;
  2620. }
  2621. function canCellBeSelected(row, cell) {
  2622. if (row >= getDataLength() || row < 0 || cell >= columns.length || cell < 0) {
  2623. return false;
  2624. }
  2625. var rowMetadata = data.getItemMetadata && data.getItemMetadata(row);
  2626. if (rowMetadata && typeof rowMetadata.selectable === "boolean") {
  2627. return rowMetadata.selectable;
  2628. }
  2629. var columnMetadata = rowMetadata && rowMetadata.columns && (rowMetadata.columns[columns[cell].id] || rowMetadata.columns[cell]);
  2630. if (columnMetadata && typeof columnMetadata.selectable === "boolean") {
  2631. return columnMetadata.selectable;
  2632. }
  2633. return columns[cell].selectable;
  2634. }
  2635. function gotoCell(row, cell, forceEdit) {
  2636. if (!initialized) { return; }
  2637. if (!canCellBeActive(row, cell)) {
  2638. return;
  2639. }
  2640. if (!getEditorLock().commitCurrentEdit()) {
  2641. return;
  2642. }
  2643. scrollCellIntoView(row, cell, false);
  2644. var newCell = getCellNode(row, cell);
  2645. // if selecting the 'add new' row, start editing right away
  2646. setActiveCellInternal(newCell, forceEdit || (row === getDataLength()) || options.autoEdit);
  2647. // if no editor was created, set the focus back on the grid
  2648. if (!currentEditor) {
  2649. setFocus();
  2650. }
  2651. }
  2652. //////////////////////////////////////////////////////////////////////////////////////////////
  2653. // IEditor implementation for the editor lock
  2654. function commitCurrentEdit() {
  2655. var item = getDataItem(activeRow);
  2656. var column = columns[activeCell];
  2657. if (currentEditor) {
  2658. if (currentEditor.isValueChanged()) {
  2659. var validationResults = currentEditor.validate();
  2660. if (validationResults.valid) {
  2661. if (activeRow < getDataLength()) {
  2662. var editCommand = {
  2663. row: activeRow,
  2664. cell: activeCell,
  2665. editor: currentEditor,
  2666. serializedValue: currentEditor.serializeValue(),
  2667. prevSerializedValue: serializedEditorValue,
  2668. execute: function () {
  2669. this.editor.applyValue(item, this.serializedValue);
  2670. updateRow(this.row);
  2671. },
  2672. undo: function () {
  2673. this.editor.applyValue(item, this.prevSerializedValue);
  2674. updateRow(this.row);
  2675. }
  2676. };
  2677. if (options.editCommandHandler) {
  2678. makeActiveCellNormal();
  2679. options.editCommandHandler(item, column, editCommand);
  2680. } else {
  2681. editCommand.execute();
  2682. makeActiveCellNormal();
  2683. }
  2684. trigger(self.onCellChange, {
  2685. row: activeRow,
  2686. cell: activeCell,
  2687. item: item
  2688. });
  2689. } else {
  2690. var newItem = {};
  2691. currentEditor.applyValue(newItem, currentEditor.serializeValue());
  2692. makeActiveCellNormal();
  2693. trigger(self.onAddNewRow, {item: newItem, column: column});
  2694. }
  2695. // check whether the lock has been re-acquired by event handlers
  2696. return !getEditorLock().isActive();
  2697. } else {
  2698. // Re-add the CSS class to trigger transitions, if any.
  2699. $(activeCellNode).removeClass("invalid");
  2700. $(activeCellNode).width(); // force layout
  2701. $(activeCellNode).addClass("invalid");
  2702. trigger(self.onValidationError, {
  2703. editor: currentEditor,
  2704. cellNode: activeCellNode,
  2705. validationResults: validationResults,
  2706. row: activeRow,
  2707. cell: activeCell,
  2708. column: column
  2709. });
  2710. currentEditor.focus();
  2711. return false;
  2712. }
  2713. }
  2714. makeActiveCellNormal();
  2715. }
  2716. return true;
  2717. }
  2718. function cancelCurrentEdit() {
  2719. makeActiveCellNormal();
  2720. return true;
  2721. }
  2722. function rowsToRanges(rows) {
  2723. var ranges = [];
  2724. var lastCell = columns.length - 1;
  2725. for (var i = 0; i < rows.length; i++) {
  2726. ranges.push(new Slick.Range(rows[i], 0, rows[i], lastCell));
  2727. }
  2728. return ranges;
  2729. }
  2730. function getSelectedRows() {
  2731. if (!selectionModel) {
  2732. throw "Selection model is not set";
  2733. }
  2734. return selectedRows;
  2735. }
  2736. function setSelectedRows(rows) {
  2737. if (!selectionModel) {
  2738. throw "Selection model is not set";
  2739. }
  2740. selectionModel.setSelectedRanges(rowsToRanges(rows));
  2741. }
  2742. //////////////////////////////////////////////////////////////////////////////////////////////
  2743. // Debug
  2744. this.debug = function () {
  2745. var s = "";
  2746. s += ("\n" + "counter_rows_rendered: " + counter_rows_rendered);
  2747. s += ("\n" + "counter_rows_removed: " + counter_rows_removed);
  2748. s += ("\n" + "renderedRows: " + renderedRows);
  2749. s += ("\n" + "numVisibleRows: " + numVisibleRows);
  2750. s += ("\n" + "maxSupportedCssHeight: " + maxSupportedCssHeight);
  2751. s += ("\n" + "n(umber of pages): " + n);
  2752. s += ("\n" + "(current) page: " + page);
  2753. s += ("\n" + "page height (ph): " + ph);
  2754. s += ("\n" + "vScrollDir: " + vScrollDir);
  2755. alert(s);
  2756. };
  2757. // a debug helper to be able to access private members
  2758. this.eval = function (expr) {
  2759. return eval(expr);
  2760. };
  2761. //////////////////////////////////////////////////////////////////////////////////////////////
  2762. // Public API
  2763. $.extend(this, {
  2764. "slickGridVersion": "2.1",
  2765. // Events
  2766. "onScroll": new Slick.Event(),
  2767. "onSort": new Slick.Event(),
  2768. "onHeaderMouseEnter": new Slick.Event(),
  2769. "onHeaderMouseLeave": new Slick.Event(),
  2770. "onHeaderContextMenu": new Slick.Event(),
  2771. "onHeaderClick": new Slick.Event(),
  2772. "onHeaderCellRendered": new Slick.Event(),
  2773. "onBeforeHeaderCellDestroy": new Slick.Event(),
  2774. "onHeaderRowCellRendered": new Slick.Event(),
  2775. "onBeforeHeaderRowCellDestroy": new Slick.Event(),
  2776. "onMouseEnter": new Slick.Event(),
  2777. "onMouseLeave": new Slick.Event(),
  2778. "onClick": new Slick.Event(),
  2779. "onDblClick": new Slick.Event(),
  2780. "onContextMenu": new Slick.Event(),
  2781. "onKeyDown": new Slick.Event(),
  2782. "onAddNewRow": new Slick.Event(),
  2783. "onValidationError": new Slick.Event(),
  2784. "onViewportChanged": new Slick.Event(),
  2785. "onColumnsReordered": new Slick.Event(),
  2786. "onColumnsResized": new Slick.Event(),
  2787. "onCellChange": new Slick.Event(),
  2788. "onBeforeEditCell": new Slick.Event(),
  2789. "onBeforeCellEditorDestroy": new Slick.Event(),
  2790. "onBeforeDestroy": new Slick.Event(),
  2791. "onActiveCellChanged": new Slick.Event(),
  2792. "onActiveCellPositionChanged": new Slick.Event(),
  2793. "onDragInit": new Slick.Event(),
  2794. "onDragStart": new Slick.Event(),
  2795. "onDrag": new Slick.Event(),
  2796. "onDragEnd": new Slick.Event(),
  2797. "onSelectedRowsChanged": new Slick.Event(),
  2798. "onCellCssStylesChanged": new Slick.Event(),
  2799. // Methods
  2800. "registerPlugin": registerPlugin,
  2801. "unregisterPlugin": unregisterPlugin,
  2802. "getColumns": getColumns,
  2803. "setColumns": setColumns,
  2804. "getColumnIndex": getColumnIndex,
  2805. "updateColumnHeader": updateColumnHeader,
  2806. "setSortColumn": setSortColumn,
  2807. "setSortColumns": setSortColumns,
  2808. "getSortColumns": getSortColumns,
  2809. "autosizeColumns": autosizeColumns,
  2810. "getOptions": getOptions,
  2811. "setOptions": setOptions,
  2812. "getData": getData,
  2813. "getDataLength": getDataLength,
  2814. "getDataItem": getDataItem,
  2815. "setData": setData,
  2816. "getSelectionModel": getSelectionModel,
  2817. "setSelectionModel": setSelectionModel,
  2818. "getSelectedRows": getSelectedRows,
  2819. "setSelectedRows": setSelectedRows,
  2820. "getContainerNode": getContainerNode,
  2821. "render": render,
  2822. "invalidate": invalidate,
  2823. "invalidateRow": invalidateRow,
  2824. "invalidateRows": invalidateRows,
  2825. "invalidateAllRows": invalidateAllRows,
  2826. "updateCell": updateCell,
  2827. "updateRow": updateRow,
  2828. "getViewport": getVisibleRange,
  2829. "getRenderedRange": getRenderedRange,
  2830. "resizeCanvas": resizeCanvas,
  2831. "updateRowCount": updateRowCount,
  2832. "scrollRowIntoView": scrollRowIntoView,
  2833. "scrollRowToTop": scrollRowToTop,
  2834. "scrollCellIntoView": scrollCellIntoView,
  2835. "getCanvasNode": getCanvasNode,
  2836. "focus": setFocus,
  2837. "getCellFromPoint": getCellFromPoint,
  2838. "getCellFromEvent": getCellFromEvent,
  2839. "getActiveCell": getActiveCell,
  2840. "setActiveCell": setActiveCell,
  2841. "getActiveCellNode": getActiveCellNode,
  2842. "getActiveCellPosition": getActiveCellPosition,
  2843. "resetActiveCell": resetActiveCell,
  2844. "editActiveCell": makeActiveCellEditable,
  2845. "getCellEditor": getCellEditor,
  2846. "getCellNode": getCellNode,
  2847. "getCellNodeBox": getCellNodeBox,
  2848. "canCellBeSelected": canCellBeSelected,
  2849. "canCellBeActive": canCellBeActive,
  2850. "navigatePrev": navigatePrev,
  2851. "navigateNext": navigateNext,
  2852. "navigateUp": navigateUp,
  2853. "navigateDown": navigateDown,
  2854. "navigateLeft": navigateLeft,
  2855. "navigateRight": navigateRight,
  2856. "navigatePageUp": navigatePageUp,
  2857. "navigatePageDown": navigatePageDown,
  2858. "gotoCell": gotoCell,
  2859. "getTopPanel": getTopPanel,
  2860. "setTopPanelVisibility": setTopPanelVisibility,
  2861. "setHeaderRowVisibility": setHeaderRowVisibility,
  2862. "getHeaderRow": getHeaderRow,
  2863. "getHeaderRowColumn": getHeaderRowColumn,
  2864. "getGridPosition": getGridPosition,
  2865. "flashCell": flashCell,
  2866. "addCellCssStyles": addCellCssStyles,
  2867. "setCellCssStyles": setCellCssStyles,
  2868. "removeCellCssStyles": removeCellCssStyles,
  2869. "getCellCssStyles": getCellCssStyles,
  2870. "init": finishInitialization,
  2871. "destroy": destroy,
  2872. // IEditor implementation
  2873. "getEditorLock": getEditorLock,
  2874. "getEditController": getEditController
  2875. });
  2876. init();
  2877. }
  2878. }(jQuery));