import BasePlugin from './../_base'; import { addClass, hasClass, removeClass, outerHeight } from './../../helpers/dom/element'; import EventManager from './../../eventManager'; import { pageX } 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 * This plugin allows to change columns width. To make columns width persistent the {@link Options#persistentState} * plugin should be enabled. * * The plugin creates additional components to make resizing possibly using user interface: * - handle - the draggable element that sets the desired width of the column. * - guide - the helper guide that shows the desired width as a vertical guide. * * @plugin ManualColumnResize */ class ManualColumnResize extends BasePlugin { constructor(hotInstance) { super(hotInstance); this.currentTH = null; this.currentCol = null; this.selectedCols = []; this.currentWidth = null; this.newSize = null; this.startY = null; this.startWidth = 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.manualColumnWidths = []; addClass(this.handle, 'manualColumnResizer'); addClass(this.guide, 'manualColumnResizerGuide'); } /** * Checks if the plugin is enabled in the handsontable settings. This method is executed in {@link Hooks#beforeInit} * hook and if it returns `true` than the {@link ManualColumnResize#enablePlugin} method is called. * * @returns {Boolean} */ isEnabled() { return this.hot.getSettings().manualColumnResize; } /** * Enables the plugin functionality for this Handsontable instance. */ enablePlugin() { if (this.enabled) { return; } this.manualColumnWidths = []; const initialColumnWidth = this.hot.getSettings().manualColumnResize; const loadedManualColumnWidths = this.loadManualColumnWidths(); this.addHook('modifyColWidth', (width, col) => this.onModifyColWidth(width, col)); this.addHook('beforeStretchingColumnWidth', (stretchedWidth, column) => this.onBeforeStretchingColumnWidth(stretchedWidth, column)); this.addHook('beforeColumnResize', (currentColumn, newSize, isDoubleClick) => this.onBeforeColumnResize(currentColumn, newSize, isDoubleClick)); if (typeof loadedManualColumnWidths !== 'undefined') { this.manualColumnWidths = loadedManualColumnWidths; } else if (Array.isArray(initialColumnWidth)) { this.manualColumnWidths = initialColumnWidth; } else { this.manualColumnWidths = []; } // Handsontable.hooks.register('beforeColumnResize'); // Handsontable.hooks.register('afterColumnResize'); this.bindEvents(); super.enablePlugin(); } /** * Updates the plugin state. This method is executed when {@link Core#updateSettings} is invoked. */ updatePlugin() { const initialColumnWidth = this.hot.getSettings().manualColumnResize; if (Array.isArray(initialColumnWidth)) { this.manualColumnWidths = initialColumnWidth; } else if (!initialColumnWidth) { this.manualColumnWidths = []; } } /** * Disables the plugin functionality for this Handsontable instance. */ disablePlugin() { super.disablePlugin(); } /** * Saves the current sizes using the persistentState plugin (the {@link Options#persistentState} option has to be enabled). */ saveManualColumnWidths() { this.hot.runHooks('persistentStateSave', 'manualColumnWidths', this.manualColumnWidths); } /** * Loads the previously saved sizes using the persistentState plugin (the {@link Options#persistentState} option has to be enabled). * * @returns {Array} * * @fires Hooks#persistentStateLoad * @fires Hooks#manualColumnWidths */ loadManualColumnWidths() { const storedState = {}; this.hot.runHooks('persistentStateLoad', 'manualColumnWidths', storedState); return storedState.value; } /** * Set the resize handle position. * * @private * @param {HTMLCellElement} TH TH HTML element. */ setupHandlePosition(TH) { if (!TH.parentNode) { return false; } this.currentTH = TH; // getCoords returns CellCoords // const col = this.hot.view.wt.wtTable.getCoords(TH).col; const text = TH.innerText.replace('\n', '
'); let col = this.hot.getColHeader().indexOf(text); // 如果这里调大说明存在列头一模一样的情况,这时就直接用 html element里的顺序来 if (this.hot.getSettings().viewportColumnRenderingOffset >= 20) { col = TH.cellIndex; if (!TH.parentNode.childNodes[0].innerText.replace(/(\s| )/gi, '')) { col -= 1; } } const headerHeight = outerHeight(this.currentTH); if (col >= 0) { // if not col header const box = this.currentTH.getBoundingClientRect(); this.currentCol = col; this.selectedCols = []; if (this.hot.selection.isSelected() && this.hot.selection.isSelectedByColumnHeader()) { const { from, to } = this.hot.getSelectedRangeLast(); let start = from.col; let end = to.col; if (start >= end) { start = to.col; end = from.col; } if (this.currentCol >= start && this.currentCol <= end) { rangeEach(start, end, i => this.selectedCols.push(i)); } else { this.selectedCols.push(this.currentCol); } } else { this.selectedCols.push(this.currentCol); } this.startOffset = box.left - 6; this.startWidth = parseInt(box.width, 10); this.handle.style.top = `${box.top}px`; this.handle.style.left = `${this.startOffset + this.startWidth}px`; this.handle.style.height = `${headerHeight}px`; this.hot.rootElement.appendChild(this.handle); } } /** * Refresh the resize handle position. * * @private */ refreshHandlePosition() { this.handle.style.left = `${this.startOffset + this.currentWidth}px`; } /** * Sets the resize guide position. * * @private */ setupGuidePosition() { const handleHeight = parseInt(outerHeight(this.handle), 10); const handleBottomPosition = parseInt(this.handle.style.top, 10) + handleHeight; const maximumVisibleElementHeight = parseInt(this.hot.view.maximumVisibleElementHeight(0), 10); addClass(this.handle, 'active'); addClass(this.guide, 'active'); this.guide.style.top = `${handleBottomPosition}px`; this.guide.style.left = this.handle.style.left; this.guide.style.height = `${maximumVisibleElementHeight - handleHeight}px`; this.hot.rootElement.appendChild(this.guide); } /** * Refresh the resize guide position. * * @private */ refreshGuidePosition() { this.guide.style.left = this.handle.style.left; } /** * Hides both the resize handle and resize guide. * * @private */ hideHandleAndGuide() { removeClass(this.handle, 'active'); removeClass(this.guide, 'active'); } /** * Checks if provided element is considered a column header. * * @private * @param {HTMLElement} element HTML element. * @returns {Boolean} */ checkIfColumnHeader(element) { if (element !== this.hot.rootElement) { const parent = element.parentNode; if (parent.tagName === 'THEAD') { return true; } return this.checkIfColumnHeader(parent); } return false; } /** * Gets the TH element from the provided element. * * @private * @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.checkIfColumnHeader(event.target)) { const th = this.getTHFromTargetElement(event.target); if (!th) { return; } const colspan = th.getAttribute('colspan'); if (th && (colspan === null || colspan === 1)) { if (!this.pressed) { this.setupHandlePosition(th); } } } } /** * Auto-size row after doubleclick - callback. * * @private * * @fires Hooks#beforeColumnResize * @fires Hooks#afterColumnResize */ afterMouseDownTimeout() { const render = () => { this.hot.forceFullRender = true; this.hot.view.render(); // updates all this.hot.view.wt.wtOverlays.adjustElementsSize(true); }; const resize = (selectedCol, forceRender) => { const hookNewSize = this.hot.runHooks('beforeColumnResize', selectedCol, this.newSize, true); if (hookNewSize !== void 0) { this.newSize = hookNewSize; } if (this.hot.getSettings().stretchH === 'all') { this.clearManualSize(selectedCol); } else { this.setManualSize(selectedCol, this.newSize); // double click sets by auto row size plugin } if (forceRender) { render(); } this.saveManualColumnWidths(); this.hot.runHooks('afterColumnResize', selectedCol, this.newSize, true); }; if (this.dblclick >= 2) { const selectedColsLength = this.selectedCols.length; if (selectedColsLength > 1) { arrayEach(this.selectedCols, (selectedCol) => { resize(selectedCol); }); render(); } else { arrayEach(this.selectedCols, (selectedCol) => { resize(selectedCol, true); }); } } this.dblclick = 0; this.autoresizeTimeout = null; } /** * 'mousedown' event callback. * * @private * @param {MouseEvent} event */ onMouseDown(event) { if (hasClass(event.target, 'manualColumnResizer')) { this.setupGuidePosition(); this.pressed = this.hot; if (this.autoresizeTimeout === null) { this.autoresizeTimeout = setTimeout(() => this.afterMouseDownTimeout(), 500); this.hot._registerTimeout(this.autoresizeTimeout); } this.dblclick += 1; this.startX = pageX(event); this.newSize = this.startWidth; } } /** * 'mousemove' event callback - refresh the handle and guide positions, cache the new column width. * * @private * @param {MouseEvent} event */ onMouseMove(event) { if (this.pressed) { this.currentWidth = this.startWidth + (pageX(event) - this.startX); arrayEach(this.selectedCols, (selectedCol) => { this.newSize = this.setManualSize(selectedCol, this.currentWidth); }); this.refreshHandlePosition(); this.refreshGuidePosition(); } } /** * 'mouseup' event callback - apply the column resizing. * * @private * * @fires Hooks#beforeColumnResize * @fires Hooks#afterColumnResize */ onMouseUp() { const render = () => { this.hot.forceFullRender = true; this.hot.view.render(); // updates all this.hot.view.wt.wtOverlays.adjustElementsSize(true); }; const resize = (selectedCol, forceRender) => { this.hot.runHooks('beforeColumnResize', selectedCol, this.newSize, false); if (forceRender) { render(); } this.saveManualColumnWidths(); this.hot.runHooks('afterColumnResize', selectedCol, this.newSize); }; if (this.pressed) { this.hideHandleAndGuide(); this.pressed = false; if (this.newSize !== this.startWidth) { const selectedColsLength = this.selectedCols.length; if (selectedColsLength > 1) { arrayEach(this.selectedCols, (selectedCol) => { resize(selectedCol); }); render(); } else { arrayEach(this.selectedCols, (selectedCol) => { resize(selectedCol, true); }); } } this.setupHandlePosition(this.currentTH); } } /** * Binds 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', () => this.onMouseUp()); } /** * Sets the new width for specified column index. * * @param {Number} column Visual column index. * @param {Number} width Column width (no less than 20px). * @returns {Number} Returns new width. */ setManualSize(column, width) { const newWidth = Math.max(width, 20); /** * We need to run col through modifyCol hook, in case the order of displayed columns is different than the order * in data source. For instance, this order can be modified by manualColumnMove plugin. */ const physicalColumn = this.hot.runHooks('modifyCol', column); this.manualColumnWidths[physicalColumn] = newWidth; return newWidth; } /** * Clears the cache for the specified column index. * * @param {Number} column Visual column index. */ clearManualSize(column) { const physicalColumn = this.hot.runHooks('modifyCol', column); this.manualColumnWidths[physicalColumn] = void 0; } /** * Modifies the provided column width, based on the plugin settings * * @private * @param {Number} width Column width. * @param {Number} column Visual column index. * @returns {Number} */ onModifyColWidth(width, column) { let newWidth = width; if (this.enabled) { const physicalColumn = this.hot.runHooks('modifyCol', column); const columnWidth = this.manualColumnWidths[physicalColumn]; if (this.hot.getSettings().manualColumnResize && columnWidth) { newWidth = columnWidth; } } return newWidth; } /** * Modifies the provided column stretched width. This hook decides if specified column should be stretched or not. * * @private * @param {Number} stretchedWidth Stretched width. * @param {Number} column Physical column index. * @returns {Number} */ onBeforeStretchingColumnWidth(stretchedWidth, column) { let width = this.manualColumnWidths[column]; if (width === void 0) { width = stretchedWidth; } return width; } /** * `beforeColumnResize` hook callback. * * @private */ onBeforeColumnResize() { // clear the header height cache information this.hot.view.wt.wtViewport.hasOversizedColumnHeadersMarked = {}; } } registerPlugin('manualColumnResize', ManualColumnResize); export default ManualColumnResize;