checkboxRenderer.js 9.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343
  1. import { empty, addClass, hasClass } from './../helpers/dom/element';
  2. import { equalsIgnoreCase } from './../helpers/string';
  3. import EventManager from './../eventManager';
  4. import { isKey } from './../helpers/unicode';
  5. import { partial } from './../helpers/function';
  6. import { stopImmediatePropagation, isImmediatePropagationStopped } from './../helpers/dom/event';
  7. import { getRenderer } from './index';
  8. var isListeningKeyDownEvent = new WeakMap();
  9. var isCheckboxListenerAdded = new WeakMap();
  10. var BAD_VALUE_CLASS = 'htBadValue';
  11. /**
  12. * Checkbox renderer
  13. *
  14. * @private
  15. * @param {Object} instance Handsontable instance
  16. * @param {Element} TD Table cell where to render
  17. * @param {Number} row
  18. * @param {Number} col
  19. * @param {String|Number} prop Row object property name
  20. * @param value Value to render (remember to escape unsafe HTML before inserting to DOM!)
  21. * @param {Object} cellProperties Cell properties (shared by cell renderer and editor)
  22. */
  23. function checkboxRenderer(instance, TD, row, col, prop, value, cellProperties) {
  24. getRenderer('base').apply(this, arguments);
  25. var eventManager = registerEvents(instance);
  26. var input = createInput();
  27. var labelOptions = cellProperties.label;
  28. var badValue = false;
  29. if (typeof cellProperties.checkedTemplate === 'undefined') {
  30. cellProperties.checkedTemplate = true;
  31. }
  32. if (typeof cellProperties.uncheckedTemplate === 'undefined') {
  33. cellProperties.uncheckedTemplate = false;
  34. }
  35. empty(TD); // TODO identify under what circumstances this line can be removed
  36. if (value === cellProperties.checkedTemplate || equalsIgnoreCase(value, cellProperties.checkedTemplate)) {
  37. input.checked = true;
  38. } else if (value === cellProperties.uncheckedTemplate || equalsIgnoreCase(value, cellProperties.uncheckedTemplate)) {
  39. input.checked = false;
  40. } else if (value === null) {
  41. // default value
  42. addClass(input, 'noValue');
  43. } else {
  44. input.style.display = 'none';
  45. addClass(input, BAD_VALUE_CLASS);
  46. badValue = true;
  47. }
  48. input.setAttribute('data-row', row);
  49. input.setAttribute('data-col', col);
  50. if (!badValue && labelOptions) {
  51. var labelText = '';
  52. if (labelOptions.value) {
  53. labelText = typeof labelOptions.value === 'function' ? labelOptions.value.call(this, row, col, prop, value) : labelOptions.value;
  54. } else if (labelOptions.property) {
  55. labelText = instance.getDataAtRowProp(row, labelOptions.property);
  56. }
  57. var label = createLabel(labelText);
  58. if (labelOptions.position === 'before') {
  59. label.appendChild(input);
  60. } else {
  61. label.insertBefore(input, label.firstChild);
  62. }
  63. input = label;
  64. }
  65. TD.appendChild(input);
  66. if (badValue) {
  67. TD.appendChild(document.createTextNode('#bad-value#'));
  68. }
  69. if (!isListeningKeyDownEvent.has(instance)) {
  70. isListeningKeyDownEvent.set(instance, true);
  71. instance.addHook('beforeKeyDown', onBeforeKeyDown);
  72. }
  73. /**
  74. * On before key down DOM listener.
  75. *
  76. * @private
  77. * @param {Event} event
  78. */
  79. function onBeforeKeyDown(event) {
  80. var toggleKeys = 'SPACE|ENTER';
  81. var switchOffKeys = 'DELETE|BACKSPACE';
  82. var isKeyCode = partial(isKey, event.keyCode);
  83. if (isKeyCode(toggleKeys + '|' + switchOffKeys) && !isImmediatePropagationStopped(event)) {
  84. eachSelectedCheckboxCell(function () {
  85. stopImmediatePropagation(event);
  86. event.preventDefault();
  87. });
  88. }
  89. if (isKeyCode(toggleKeys)) {
  90. changeSelectedCheckboxesState();
  91. }
  92. if (isKeyCode(switchOffKeys)) {
  93. changeSelectedCheckboxesState(true);
  94. }
  95. }
  96. /**
  97. * Change checkbox checked property
  98. *
  99. * @private
  100. * @param {Boolean} [uncheckCheckbox=false]
  101. */
  102. function changeSelectedCheckboxesState() {
  103. var uncheckCheckbox = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : false;
  104. var selRange = instance.getSelectedRange();
  105. if (!selRange) {
  106. return;
  107. }
  108. var topLeft = selRange.getTopLeftCorner();
  109. var bottomRight = selRange.getBottomRightCorner();
  110. var changes = [];
  111. for (var _row = topLeft.row; _row <= bottomRight.row; _row += 1) {
  112. for (var _col = topLeft.col; _col <= bottomRight.col; _col += 1) {
  113. var _cellProperties = instance.getCellMeta(_row, _col);
  114. if (_cellProperties.type !== 'checkbox') {
  115. return;
  116. }
  117. /* eslint-disable no-continue */
  118. if (_cellProperties.readOnly === true) {
  119. continue;
  120. }
  121. if (typeof _cellProperties.checkedTemplate === 'undefined') {
  122. _cellProperties.checkedTemplate = true;
  123. }
  124. if (typeof _cellProperties.uncheckedTemplate === 'undefined') {
  125. _cellProperties.uncheckedTemplate = false;
  126. }
  127. var dataAtCell = instance.getDataAtCell(_row, _col);
  128. if (uncheckCheckbox === false) {
  129. if (dataAtCell === _cellProperties.checkedTemplate) {
  130. changes.push([_row, _col, _cellProperties.uncheckedTemplate]);
  131. } else if ([_cellProperties.uncheckedTemplate, null, void 0].indexOf(dataAtCell) !== -1) {
  132. changes.push([_row, _col, _cellProperties.checkedTemplate]);
  133. }
  134. } else {
  135. changes.push([_row, _col, _cellProperties.uncheckedTemplate]);
  136. }
  137. }
  138. }
  139. if (changes.length > 0) {
  140. instance.setDataAtCell(changes);
  141. }
  142. }
  143. /**
  144. * Call callback for each found selected cell with checkbox type.
  145. *
  146. * @private
  147. * @param {Function} callback
  148. */
  149. function eachSelectedCheckboxCell(callback) {
  150. var selRange = instance.getSelectedRange();
  151. if (!selRange) {
  152. return;
  153. }
  154. var topLeft = selRange.getTopLeftCorner();
  155. var bottomRight = selRange.getBottomRightCorner();
  156. for (var _row2 = topLeft.row; _row2 <= bottomRight.row; _row2++) {
  157. for (var _col2 = topLeft.col; _col2 <= bottomRight.col; _col2++) {
  158. var _cellProperties2 = instance.getCellMeta(_row2, _col2);
  159. if (_cellProperties2.type !== 'checkbox') {
  160. return;
  161. }
  162. var cell = instance.getCell(_row2, _col2);
  163. if (cell == null) {
  164. callback(_row2, _col2, _cellProperties2);
  165. } else {
  166. var checkboxes = cell.querySelectorAll('input[type=checkbox]');
  167. if (checkboxes.length > 0 && !_cellProperties2.readOnly) {
  168. callback(checkboxes);
  169. }
  170. }
  171. }
  172. }
  173. }
  174. }
  175. /**
  176. * Register checkbox listeners.
  177. *
  178. * @param {Handsontable} instance Handsontable instance.
  179. * @returns {EventManager}
  180. */
  181. function registerEvents(instance) {
  182. var eventManager = isCheckboxListenerAdded.get(instance);
  183. if (!eventManager) {
  184. eventManager = new EventManager(instance);
  185. eventManager.addEventListener(instance.rootElement, 'click', function (event) {
  186. return onClick(event, instance);
  187. });
  188. eventManager.addEventListener(instance.rootElement, 'mouseup', function (event) {
  189. return onMouseUp(event, instance);
  190. });
  191. eventManager.addEventListener(instance.rootElement, 'change', function (event) {
  192. return onChange(event, instance);
  193. });
  194. isCheckboxListenerAdded.set(instance, eventManager);
  195. }
  196. return eventManager;
  197. }
  198. /**
  199. * Create input element.
  200. *
  201. * @returns {Node}
  202. */
  203. function createInput() {
  204. var input = document.createElement('input');
  205. input.className = 'htCheckboxRendererInput';
  206. input.type = 'checkbox';
  207. input.setAttribute('autocomplete', 'off');
  208. input.setAttribute('tabindex', '-1');
  209. return input.cloneNode(false);
  210. }
  211. /**
  212. * Create label element.
  213. *
  214. * @returns {Node}
  215. */
  216. function createLabel(text) {
  217. var label = document.createElement('label');
  218. label.className = 'htCheckboxRendererLabel';
  219. label.appendChild(document.createTextNode(text));
  220. return label.cloneNode(true);
  221. }
  222. /**
  223. * `mouseup` callback.
  224. *
  225. * @private
  226. * @param {Event} event `mouseup` event.
  227. * @param {Object} instance Handsontable instance.
  228. */
  229. function onMouseUp(event, instance) {
  230. if (!isCheckboxInput(event.target)) {
  231. return;
  232. }
  233. setTimeout(instance.listen, 10);
  234. }
  235. /**
  236. * `click` callback.
  237. *
  238. * @private
  239. * @param {Event} event `click` event.
  240. * @param {Object} instance Handsontable instance.
  241. */
  242. function onClick(event, instance) {
  243. if (!isCheckboxInput(event.target)) {
  244. return false;
  245. }
  246. var row = parseInt(event.target.getAttribute('data-row'), 10);
  247. var col = parseInt(event.target.getAttribute('data-col'), 10);
  248. var cellProperties = instance.getCellMeta(row, col);
  249. if (cellProperties.readOnly) {
  250. event.preventDefault();
  251. }
  252. }
  253. /**
  254. * `change` callback.
  255. *
  256. * @param {Event} event `change` event.
  257. * @param {Object} instance Handsontable instance.
  258. * @param {Object} cellProperties Reference to cell properties.
  259. * @returns {Boolean}
  260. */
  261. function onChange(event, instance) {
  262. if (!isCheckboxInput(event.target)) {
  263. return false;
  264. }
  265. var row = parseInt(event.target.getAttribute('data-row'), 10);
  266. var col = parseInt(event.target.getAttribute('data-col'), 10);
  267. var cellProperties = instance.getCellMeta(row, col);
  268. if (!cellProperties.readOnly) {
  269. var newCheckboxValue = null;
  270. if (event.target.checked) {
  271. newCheckboxValue = cellProperties.uncheckedTemplate === void 0 ? true : cellProperties.checkedTemplate;
  272. } else {
  273. newCheckboxValue = cellProperties.uncheckedTemplate === void 0 ? false : cellProperties.uncheckedTemplate;
  274. }
  275. instance.setDataAtCell(row, col, newCheckboxValue);
  276. }
  277. }
  278. /**
  279. * Check if the provided element is the checkbox input.
  280. *
  281. * @private
  282. * @param {HTMLElement} element The element in question.
  283. * @returns {Boolean}
  284. */
  285. function isCheckboxInput(element) {
  286. return element.tagName === 'INPUT' && element.getAttribute('type') === 'checkbox';
  287. }
  288. export default checkboxRenderer;