| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318 |
- /**
- * @license Copyright (c) 2003-2020, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
- /**
- * @module table/tableclipboard
- */
- import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
- import TableSelection from './tableselection';
- import TableWalker from './tablewalker';
- import { cutCellsHorizontallyAt, cutCellsVerticallyAt, getColumnIndexes, getRowIndexes, isSelectionRectangular } from './utils';
- import { findAncestor } from './commands/utils';
- import { cropTableToDimensions } from './tableselection/croptable';
- import TableUtils from './tableutils';
- /**
- * This plugin adds support for copying/cutting/pasting fragments of tables.
- * It is loaded automatically by the {@link module:table/table~Table} plugin.
- *
- * @extends module:core/plugin~Plugin
- */
- export default class TableClipboard extends Plugin {
- /**
- * @inheritDoc
- */
- static get pluginName() {
- return 'TableClipboard';
- }
- /**
- * @inheritDoc
- */
- static get requires() {
- return [ TableSelection, TableUtils ];
- }
- /**
- * @inheritDoc
- */
- init() {
- const editor = this.editor;
- const viewDocument = editor.editing.view.document;
- this.listenTo( viewDocument, 'copy', ( evt, data ) => this._onCopyCut( evt, data ) );
- this.listenTo( viewDocument, 'cut', ( evt, data ) => this._onCopyCut( evt, data ) );
- this.listenTo( editor.model, 'insertContent', ( evt, args ) => this._onInsertContent( evt, ...args ), { priority: 'high' } );
- }
- /**
- * Copies table content to a clipboard on "copy" & "cut" events.
- *
- * @private
- * @param {module:utils/eventinfo~EventInfo} evt An object containing information about the handled event.
- * @param {Object} data Clipboard event data.
- */
- _onCopyCut( evt, data ) {
- const tableSelection = this.editor.plugins.get( TableSelection );
- if ( !tableSelection.getSelectedTableCells() ) {
- return;
- }
- if ( evt.name == 'cut' && this.editor.isReadOnly ) {
- return;
- }
- data.preventDefault();
- evt.stop();
- const dataController = this.editor.data;
- const viewDocument = this.editor.editing.view.document;
- const content = dataController.toView( tableSelection.getSelectionAsFragment() );
- viewDocument.fire( 'clipboardOutput', {
- dataTransfer: data.dataTransfer,
- content,
- method: evt.name
- } );
- }
- /**
- * Overrides default {@link module:engine/model/model~Model#insertContent `model.insertContent()`} method to handle pasting table inside
- * selected table fragment.
- *
- * Depending on selected table fragment:
- * - If a selected table fragment is smaller than paste table it will crop pasted table to match dimensions.
- * - If dimensions are equal it will replace selected table fragment with a pasted table contents.
- *
- * @private
- * @param evt
- * @param {module:engine/model/documentfragment~DocumentFragment|module:engine/model/item~Item} content The content to insert.
- * @param {module:engine/model/selection~Selectable} [selectable=model.document.selection]
- * The selection into which the content should be inserted. If not provided the current model document selection will be used.
- */
- _onInsertContent( evt, content, selectable ) {
- if ( selectable && !selectable.is( 'documentSelection' ) ) {
- return;
- }
- const tableSelection = this.editor.plugins.get( TableSelection );
- const selectedTableCells = tableSelection.getSelectedTableCells();
- if ( !selectedTableCells ) {
- return;
- }
- // We might need to crop table before inserting so reference might change.
- let pastedTable = getTableIfOnlyTableInContent( content );
- if ( !pastedTable ) {
- return;
- }
- // Override default model.insertContent() handling at this point.
- evt.stop();
- // Currently not handled. See: https://github.com/ckeditor/ckeditor5/issues/6121.
- if ( selectedTableCells.length === 1 ) {
- // @if CK_DEBUG // console.log( 'NOT IMPLEMENTED YET: Single table cell is selected.' );
- return;
- }
- const tableUtils = this.editor.plugins.get( TableUtils );
- const model = this.editor.model;
- model.change( writer => {
- // Currently not handled. The selected table content should be trimmed to a rectangular selection.
- // See: https://github.com/ckeditor/ckeditor5/issues/6122.
- if ( !isSelectionRectangular( selectedTableCells, tableUtils ) ) {
- prepareLandingPlace( selectedTableCells, writer );
- }
- const { last: lastColumnOfSelection, first: firstColumnOfSelection } = getColumnIndexes( selectedTableCells );
- const { first: firstRowOfSelection, last: lastRowOfSelection } = getRowIndexes( selectedTableCells );
- const selectionHeight = lastRowOfSelection - firstRowOfSelection + 1;
- const selectionWidth = lastColumnOfSelection - firstColumnOfSelection + 1;
- const pasteHeight = tableUtils.getRows( pastedTable );
- const pasteWidth = tableUtils.getColumns( pastedTable );
- // The if below is temporal and will be removed when handling this case.
- // See: https://github.com/ckeditor/ckeditor5/issues/6769.
- if ( selectionHeight > pasteHeight || selectionWidth > pasteWidth ) {
- // @if CK_DEBUG // console.log( 'NOT IMPLEMENTED YET: Pasted table is smaller than selection area.' );
- return;
- }
- // Crop pasted table if it extends selection area.
- if ( selectionHeight < pasteHeight || selectionWidth < pasteWidth ) {
- const cropDimensions = {
- startRow: 0,
- startColumn: 0,
- endRow: selectionHeight - 1,
- endColumn: selectionWidth - 1
- };
- pastedTable = cropTableToDimensions( pastedTable, cropDimensions, writer, tableUtils );
- }
- // Holds two-dimensional array that is addressed by [ row ][ column ] that stores cells anchored at given location.
- const pastedTableLocationMap = createLocationMap( pastedTable, selectionWidth, selectionHeight );
- // Content table to which we insert a pasted table.
- const selectedTable = findAncestor( 'table', selectedTableCells[ 0 ] );
- const selectedTableMap = [ ...new TableWalker( selectedTable, {
- startRow: firstRowOfSelection,
- endRow: lastRowOfSelection,
- includeSpanned: true
- } ) ];
- // Selection must be set to pasted cells (some might be removed or new created).
- const cellsToSelect = [];
- // Store previous cell in order to insert a new table cells after it (if required).
- let previousCellInRow;
- // Content table replace cells algorithm iterates over a selected table fragment and:
- //
- // - Removes existing table cells at current slot (location).
- // - Inserts cell from a pasted table for a matched slots.
- //
- // This ensures proper table geometry after the paste
- for ( const { row, column, cell, isSpanned } of selectedTableMap ) {
- if ( column === 0 ) {
- previousCellInRow = null;
- }
- // Could use startColumn, endColumn. See: https://github.com/ckeditor/ckeditor5/issues/6785.
- if ( column < firstColumnOfSelection || column > lastColumnOfSelection ) {
- // Only update the previousCellInRow for non-spanned slots.
- if ( !isSpanned ) {
- previousCellInRow = cell;
- }
- continue;
- }
- // If the slot is occupied by a cell in a selected table - remove it.
- // The slot of this cell will be either:
- // - Replaced by a pasted table cell.
- // - Spanned by a previously pasted table cell.
- if ( !isSpanned ) {
- writer.remove( cell );
- }
- // Map current table slot location to an pasted table slot location.
- const pastedCell = pastedTableLocationMap[ row - firstRowOfSelection ][ column - firstColumnOfSelection ];
- // There is no cell to insert (might be spanned by other cell in a pasted table) - advance to the next content table slot.
- if ( !pastedCell ) {
- continue;
- }
- // Clone cell to insert (to duplicate its attributes and children).
- // Cloning is required to support repeating pasted table content when inserting to a bigger selection.
- const cellToInsert = pastedCell._clone( true );
- let insertPosition;
- if ( !previousCellInRow ) {
- insertPosition = writer.createPositionAt( selectedTable.getChild( row ), 0 );
- } else {
- insertPosition = writer.createPositionAfter( previousCellInRow );
- }
- writer.insert( cellToInsert, insertPosition );
- cellsToSelect.push( cellToInsert );
- previousCellInRow = cellToInsert;
- }
- writer.setSelection( cellsToSelect.map( cell => writer.createRangeOn( cell ) ) );
- } );
- }
- }
- function getTableIfOnlyTableInContent( content ) {
- // Table passed directly.
- if ( content.is( 'table' ) ) {
- return content;
- }
- // We do not support mixed content when pasting table into table.
- // See: https://github.com/ckeditor/ckeditor5/issues/6817.
- if ( content.childCount != 1 || !content.getChild( 0 ).is( 'table' ) ) {
- return null;
- }
- return content.getChild( 0 );
- }
- // Returns two-dimensional array that is addressed by [ row ][ column ] that stores cells anchored at given location.
- //
- // At given row & column location it might be one of:
- //
- // * cell - cell from pasted table anchored at this location.
- // * null - if no cell is anchored at this location.
- //
- // For instance, from a table below:
- //
- // +----+----+----+----+
- // | 00 | 01 | 02 | 03 |
- // + +----+----+----+
- // | | 11 | 13 |
- // +----+ +----+
- // | 20 | | 23 |
- // +----+----+----+----+
- //
- // The method will return an array (numbers represents cell element):
- //
- // const map = [
- // [ '00', '01', '02', '03' ],
- // [ null, '11', null, '13' ],
- // [ '20', null, null, '23' ]
- // ]
- //
- // This allows for a quick access to table at give row & column. For instance to access table cell "13" from pasted table call:
- //
- // const cell = map[ 1 ][ 3 ]
- //
- function createLocationMap( table, width, height ) {
- // Create height x width (row x column) two-dimensional table to store cells.
- const map = new Array( height ).fill( null )
- .map( () => new Array( width ).fill( null ) );
- for ( const { column, row, cell } of new TableWalker( table ) ) {
- map[ row ][ column ] = cell;
- }
- return map;
- }
- function prepareLandingPlace( selectedTableCells, writer ) {
- const table = findAncestor( 'table', selectedTableCells[ 0 ] );
- const { first: firstRow, last: lastRow } = getRowIndexes( selectedTableCells );
- const { first: firstColumn, last: lastColumn } = getColumnIndexes( selectedTableCells );
- if ( firstColumn > 0 ) {
- cutCellsVerticallyAt( table, firstColumn, 0, writer, { firstRow, firstColumn: 0, lastRow, lastColumn: 1000 } );
- }
- cutCellsVerticallyAt( table, lastColumn + 1, firstColumn, writer, { firstRow, firstColumn: 0, lastRow, lastColumn: 1000 } );
- if ( firstRow > 0 ) {
- cutCellsHorizontallyAt( table, firstRow, 0, writer, { firstRow: 0, firstColumn, lastRow: 1000, lastColumn } );
- }
- cutCellsHorizontallyAt( table, lastRow + 1, firstRow, writer, { firstRow: 0, firstColumn, lastRow: 1000, lastColumn } );
- }
|