import BasePlugin from './../_base'; import {addClass, hasClass, removeClass, outerWidth} from './../../helpers/dom/element'; import EventManager from './../../eventManager'; import {pageX, pageY} from './../../helpers/dom/event'; import {arrayEach} from './../../helpers/array'; import {rangeEach} from './../../helpers/number'; import {registerPlugin} from './../../plugins'; // Developer note! Whenever you make a change in this file, make an analogous change in manualRowResize.js /** * @description * ManualRowResize Plugin. * * Has 2 UI components: * - handle - the draggable element that sets the desired height of the row. * - guide - the helper guide that shows the desired height as a horizontal guide. * * @plugin ManualRowResize */ class ManualRowResize extends BasePlugin { constructor(hotInstance) { super(hotInstance); this.currentTH = null; this.currentRow = null; this.selectedRows = []; this.currentHeight = null; this.newSize = null; this.startY = null; this.startHeight = null; this.startOffset = null; this.handle = document.createElement('DIV'); this.guide = document.createElement('DIV'); this.eventManager = new EventManager(this); this.pressed = null; this.dblclick = 0; this.autoresizeTimeout = null; this.manualRowHeights = []; addClass(this.handle, 'manualRowResizer'); addClass(this.guide, 'manualRowResizerGuide'); } /** * Check if the plugin is enabled in the handsontable settings. * * @returns {Boolean} */ isEnabled() { return this.hot.getSettings().manualRowResize; } /** * Enable plugin for this Handsontable instance. */ enablePlugin() { if (this.enabled) { return; } this.manualRowHeights = []; let initialRowHeights = this.hot.getSettings().manualRowResize; let loadedManualRowHeights = this.loadManualRowHeights(); if (typeof loadedManualRowHeights != 'undefined') { this.manualRowHeights = loadedManualRowHeights; } else if (Array.isArray(initialRowHeights)) { this.manualRowHeights = initialRowHeights; } else { this.manualRowHeights = []; } this.addHook('modifyRowHeight', (height, row) => this.onModifyRowHeight(height, row)); // Handsontable.hooks.register('beforeRowResize'); // Handsontable.hooks.register('afterRowResize'); this.bindEvents(); super.enablePlugin(); } /** * Updates the plugin to use the latest options you have specified. */ updatePlugin() { let initialRowHeights = this.hot.getSettings().manualRowResize; if (Array.isArray(initialRowHeights)) { this.manualRowHeights = initialRowHeights; } else if (!initialRowHeights) { this.manualRowHeights = []; } } /** * Disable plugin for this Handsontable instance. */ disablePlugin() { super.disablePlugin(); } /** * Save the current sizes using the persistentState plugin. */ saveManualRowHeights() { this.hot.runHooks('persistentStateSave', 'manualRowHeights', this.manualRowHeights); } /** * Load the previously saved sizes using the persistentState plugin. * * @returns {Array} */ loadManualRowHeights() { let storedState = {}; this.hot.runHooks('persistentStateLoad', 'manualRowHeights', storedState); return storedState.value; } /** * Set the resize handle position. * * @param {HTMLCellElement} TH TH HTML element. */ setupHandlePosition(TH) { this.currentTH = TH; let row = this.hot.view.wt.wtTable.getCoords(TH).row; // getCoords returns CellCoords let headerWidth = outerWidth(this.currentTH); if (row >= 0) { // if not col header let box = this.currentTH.getBoundingClientRect(); this.currentRow = row; this.selectedRows = []; if (this.hot.selection.isSelected() && this.hot.selection.selectedHeader.rows) { let {from, to} = this.hot.getSelectedRange(); let start = from.row; let end = to.row; if (start >= end) { start = to.row; end = from.row; } if (this.currentRow >= start && this.currentRow <= end) { rangeEach(start, end, (i) => this.selectedRows.push(i)); } else { this.selectedRows.push(this.currentRow); } } else { this.selectedRows.push(this.currentRow); } this.startOffset = box.top - 6; this.startHeight = parseInt(box.height, 10); this.handle.style.left = `${box.left}px`; this.handle.style.top = `${this.startOffset + this.startHeight}px`; this.handle.style.width = `${headerWidth}px`; this.hot.rootElement.appendChild(this.handle); } } /** * Refresh the resize handle position. */ refreshHandlePosition() { this.handle.style.top = `${this.startOffset + this.currentHeight}px`; } /** * Set the resize guide position. */ setupGuidePosition() { let handleWidth = parseInt(outerWidth(this.handle), 10); let handleRightPosition = parseInt(this.handle.style.left, 10) + handleWidth; let maximumVisibleElementWidth = parseInt(this.hot.view.maximumVisibleElementWidth(0), 10); addClass(this.handle, 'active'); addClass(this.guide, 'active'); this.guide.style.top = this.handle.style.top; this.guide.style.left = `${handleRightPosition}px`; this.guide.style.width = `${maximumVisibleElementWidth - handleWidth}px`; this.hot.rootElement.appendChild(this.guide); } /** * Refresh the resize guide position. */ refreshGuidePosition() { this.guide.style.top = this.handle.style.top; } /** * Hide both the resize handle and resize guide. */ hideHandleAndGuide() { removeClass(this.handle, 'active'); removeClass(this.guide, 'active'); } /** * Check if provided element is considered as a row header. * * @param {HTMLElement} element HTML element. * @returns {Boolean} */ checkIfRowHeader(element) { if (element != this.hot.rootElement) { let parent = element.parentNode; if (parent.tagName === 'TBODY') { return true; } return this.checkIfRowHeader(parent); } return false; } /** * Get the TH element from the provided element. * * @param {HTMLElement} element HTML element. * @returns {HTMLElement} */ getTHFromTargetElement(element) { if (element.tagName != 'TABLE') { if (element.tagName == 'TH') { return element; } return this.getTHFromTargetElement(element.parentNode); } return null; } /** * 'mouseover' event callback - set the handle position. * * @private * @param {MouseEvent} event */ onMouseOver(event) { if (this.checkIfRowHeader(event.target)) { let th = this.getTHFromTargetElement(event.target); if (th) { if (!this.pressed) { this.setupHandlePosition(th); } } } } /** * Auto-size row after doubleclick - callback. * * @private */ afterMouseDownTimeout() { const render = () => { this.hot.forceFullRender = true; this.hot.view.render(); // updates all this.hot.view.wt.wtOverlays.adjustElementsSize(true); }; const resize = (selectedRow, forceRender) => { let hookNewSize = this.hot.runHooks('beforeRowResize', selectedRow, this.newSize, true); if (hookNewSize !== void 0) { this.newSize = hookNewSize; } this.setManualSize(selectedRow, this.newSize); // double click sets auto row size if (forceRender) { render(); } this.hot.runHooks('afterRowResize', selectedRow, this.newSize, true); }; if (this.dblclick >= 2) { let selectedRowsLength = this.selectedRows.length; if (selectedRowsLength > 1) { arrayEach(this.selectedRows, (selectedRow) => { resize(selectedRow); }); render(); } else { arrayEach(this.selectedRows, (selectedRow) => { resize(selectedRow, true); }); } } this.dblclick = 0; this.autoresizeTimeout = null; } /** * 'mousedown' event callback. * * @private * @param {MouseEvent} event */ onMouseDown(event) { if (hasClass(event.target, 'manualRowResizer')) { this.setupGuidePosition(); this.pressed = this.hot; if (this.autoresizeTimeout == null) { this.autoresizeTimeout = setTimeout(() => this.afterMouseDownTimeout(), 500); this.hot._registerTimeout(this.autoresizeTimeout); } this.dblclick++; this.startY = pageY(event); this.newSize = this.startHeight; } } /** * 'mousemove' event callback - refresh the handle and guide positions, cache the new row height. * * @private * @param {MouseEvent} event */ onMouseMove(event) { if (this.pressed) { this.currentHeight = this.startHeight + (pageY(event) - this.startY); arrayEach(this.selectedRows, (selectedRow) => { this.newSize = this.setManualSize(selectedRow, this.currentHeight); }); this.refreshHandlePosition(); this.refreshGuidePosition(); } } /** * 'mouseup' event callback - apply the row resizing. * * @private * @param {MouseEvent} event */ onMouseUp(event) { const render = () => { this.hot.forceFullRender = true; this.hot.view.render(); // updates all this.hot.view.wt.wtOverlays.adjustElementsSize(true); }; const runHooks = (selectedRow, forceRender) => { this.hot.runHooks('beforeRowResize', selectedRow, this.newSize); if (forceRender) { render(); } this.saveManualRowHeights(); this.hot.runHooks('afterRowResize', selectedRow, this.newSize); }; if (this.pressed) { this.hideHandleAndGuide(); this.pressed = false; if (this.newSize != this.startHeight) { let selectedRowsLength = this.selectedRows.length; if (selectedRowsLength > 1) { arrayEach(this.selectedRows, (selectedRow) => { runHooks(selectedRow); }); render(); } else { arrayEach(this.selectedRows, (selectedRow) => { runHooks(selectedRow, true); }); } } this.setupHandlePosition(this.currentTH); } } /** * Bind the mouse events. * * @private */ bindEvents() { this.eventManager.addEventListener(this.hot.rootElement, 'mouseover', (e) => this.onMouseOver(e)); this.eventManager.addEventListener(this.hot.rootElement, 'mousedown', (e) => this.onMouseDown(e)); this.eventManager.addEventListener(window, 'mousemove', (e) => this.onMouseMove(e)); this.eventManager.addEventListener(window, 'mouseup', (e) => this.onMouseUp(e)); } /** * Cache the current row height. * * @param {Number} row Row index. * @param {Number} height Row height. * @returns {Number} */ setManualSize(row, height) { row = this.hot.runHooks('modifyRow', row); this.manualRowHeights[row] = height; return height; } /** * Modify the provided row height, based on the plugin settings. * * @private * @param {Number} height Row height. * @param {Number} row Row index. * @returns {Number} */ onModifyRowHeight(height, row) { if (this.enabled) { let autoRowSizePlugin = this.hot.getPlugin('autoRowSize'); let autoRowHeightResult = autoRowSizePlugin ? autoRowSizePlugin.heights[row] : null; row = this.hot.runHooks('modifyRow', row); let manualRowHeight = this.manualRowHeights[row]; if (manualRowHeight !== void 0 && (manualRowHeight === autoRowHeightResult || manualRowHeight > (height || 0))) { return manualRowHeight; } } return height; } } registerPlugin('manualRowResize', ManualRowResize); export default ManualRowResize;