| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230 |
- /**
- * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md.
- */
- /**
- * @module table/tableediting
- */
- import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
- import { upcastElementToElement } from '@ckeditor/ckeditor5-engine/src/conversion/upcast-converters';
- import Range from '@ckeditor/ckeditor5-engine/src/model/range';
- import { keyCodes } from '@ckeditor/ckeditor5-utils/src/keyboard';
- import upcastTable from './converters/upcasttable';
- import {
- downcastAttributeChange,
- downcastInsertCell,
- downcastInsertRow,
- downcastInsertTable,
- downcastRemoveRow
- } from './converters/downcast';
- import InsertTableCommand from './commands/inserttablecommand';
- import InsertRowCommand from './commands/insertrowcommand';
- import InsertColumnCommand from './commands/insertcolumncommand';
- import SplitCellCommand from './commands/splitcellcommand';
- import MergeCellCommand from './commands/mergecellcommand';
- import RemoveRowCommand from './commands/removerowcommand';
- import RemoveColumnCommand from './commands/removecolumncommand';
- import SetTableHeadersCommand from './commands/settableheaderscommand';
- import { getParentTable } from './commands/utils';
- import './../theme/table.css';
- import TableUtils from './tableutils';
- /**
- * The table editing feature.
- *
- * @extends module:core/plugin~Plugin
- */
- export default class TablesEditing extends Plugin {
- /**
- * @inheritDoc
- */
- init() {
- const editor = this.editor;
- const schema = editor.model.schema;
- const conversion = editor.conversion;
- schema.register( 'table', {
- allowWhere: '$block',
- allowAttributes: [ 'headingRows', 'headingColumns' ],
- isBlock: true,
- isObject: true
- } );
- schema.register( 'tableRow', {
- allowIn: 'table',
- allowAttributes: [],
- isBlock: true,
- isLimit: true
- } );
- schema.register( 'tableCell', {
- allowIn: 'tableRow',
- allowContentOf: '$block',
- allowAttributes: [ 'colspan', 'rowspan' ],
- isBlock: true,
- isLimit: true
- } );
- // Table conversion.
- conversion.for( 'upcast' ).add( upcastTable() );
- conversion.for( 'editingDowncast' ).add( downcastInsertTable( { asWidget: true } ) );
- conversion.for( 'dataDowncast' ).add( downcastInsertTable() );
- // Insert row conversion.
- conversion.for( 'editingDowncast' ).add( downcastInsertRow( { asWidget: true } ) );
- conversion.for( 'dataDowncast' ).add( downcastInsertRow() );
- // Remove row conversion.
- conversion.for( 'downcast' ).add( downcastRemoveRow() );
- // Table cell conversion.
- conversion.for( 'editingDowncast' ).add( downcastInsertCell( { asWidget: true } ) );
- conversion.for( 'dataDowncast' ).add( downcastInsertCell() );
- conversion.for( 'upcast' ).add( upcastElementToElement( { model: 'tableCell', view: 'td' } ) );
- conversion.for( 'upcast' ).add( upcastElementToElement( { model: 'tableCell', view: 'th' } ) );
- conversion.attributeToAttribute( { model: 'colspan', view: 'colspan' } );
- conversion.attributeToAttribute( { model: 'rowspan', view: 'rowspan' } );
- conversion.for( 'editingDowncast' ).add( downcastAttributeChange( { attribute: 'headingRows', asWidget: true } ) );
- conversion.for( 'dataDowncast' ).add( downcastAttributeChange( { attribute: 'headingRows' } ) );
- conversion.for( 'editingDowncast' ).add( downcastAttributeChange( { attribute: 'headingColumns', asWidget: true } ) );
- conversion.for( 'dataDowncast' ).add( downcastAttributeChange( { attribute: 'headingColumns' } ) );
- editor.commands.add( 'insertTable', new InsertTableCommand( editor ) );
- editor.commands.add( 'insertRowAbove', new InsertRowCommand( editor, { location: 'above' } ) );
- editor.commands.add( 'insertRowBelow', new InsertRowCommand( editor, { location: 'below' } ) );
- editor.commands.add( 'insertColumn', new InsertColumnCommand( editor ) );
- editor.commands.add( 'splitCell', new SplitCellCommand( editor ) );
- editor.commands.add( 'removeRow', new RemoveRowCommand( editor ) );
- editor.commands.add( 'removeColumn', new RemoveColumnCommand( editor ) );
- editor.commands.add( 'mergeRight', new MergeCellCommand( editor, { direction: 'right' } ) );
- editor.commands.add( 'mergeLeft', new MergeCellCommand( editor, { direction: 'left' } ) );
- editor.commands.add( 'mergeDown', new MergeCellCommand( editor, { direction: 'down' } ) );
- editor.commands.add( 'mergeUp', new MergeCellCommand( editor, { direction: 'up' } ) );
- editor.commands.add( 'setTableHeaders', new SetTableHeadersCommand( editor ) );
- this.listenTo( editor.editing.view.document, 'keydown', ( ...args ) => this._handleTabOnSelectedTable( ...args ) );
- this.listenTo( editor.editing.view.document, 'keydown', ( ...args ) => this._handleTabInsideTable( ...args ) );
- }
- /**
- * @inheritDoc
- */
- static get requires() {
- return [ TableUtils ];
- }
- /**
- * Handles {@link module:engine/view/document~Document#event:keydown keydown} events for 'Tab' key executed
- * when table widget is selected.
- *
- * @private
- * @param {module:utils/eventinfo~EventInfo} eventInfo
- * @param {module:engine/view/observer/domeventdata~DomEventData} domEventData
- */
- _handleTabOnSelectedTable( eventInfo, domEventData ) {
- const tabPressed = domEventData.keyCode == keyCodes.tab;
- // Act only on TAB & SHIFT-TAB - Do not override native CTRL+TAB handler.
- if ( !tabPressed || domEventData.ctrlKey ) {
- return;
- }
- const editor = this.editor;
- const selection = editor.model.document.selection;
- if ( !selection.isCollapsed && selection.rangeCount === 1 && selection.getFirstRange().isFlat ) {
- const selectedElement = selection.getSelectedElement();
- if ( !selectedElement || selectedElement.name != 'table' ) {
- return;
- }
- eventInfo.stop();
- domEventData.preventDefault();
- domEventData.stopPropagation();
- editor.model.change( writer => {
- writer.setSelection( Range.createIn( selectedElement.getChild( 0 ).getChild( 0 ) ) );
- } );
- }
- }
- /**
- * Handles {@link module:engine/view/document~Document#event:keydown keydown} events for 'Tab' key executed inside table cell.
- *
- * @private
- * @param {module:utils/eventinfo~EventInfo} eventInfo
- * @param {module:engine/view/observer/domeventdata~DomEventData} domEventData
- */
- _handleTabInsideTable( eventInfo, domEventData ) {
- const tabPressed = domEventData.keyCode == keyCodes.tab;
- // Act only on TAB & SHIFT-TAB - Do not override native CTRL+TAB handler.
- if ( !tabPressed || domEventData.ctrlKey ) {
- return;
- }
- const editor = this.editor;
- const selection = editor.model.document.selection;
- const table = getParentTable( selection.getFirstPosition() );
- if ( !table ) {
- return;
- }
- domEventData.preventDefault();
- domEventData.stopPropagation();
- const tableCell = selection.focus.parent;
- const tableRow = tableCell.parent;
- const currentRow = table.getChildIndex( tableRow );
- const currentCellIndex = tableRow.getChildIndex( tableCell );
- const isForward = !domEventData.shiftKey;
- const isFirstCellInRow = currentCellIndex === 0;
- if ( !isForward && isFirstCellInRow && currentRow === 0 ) {
- // It's the first cell of a table - don't do anything (stay in current position).
- return;
- }
- const isLastCellInRow = currentCellIndex === tableRow.childCount - 1;
- const isLastRow = currentRow === table.childCount - 1;
- if ( isForward && isLastRow && isLastCellInRow ) {
- editor.plugins.get( TableUtils ).insertRow( table, { at: table.childCount } );
- }
- let moveToCell;
- // Move to first cell in next row.
- if ( isForward && isLastCellInRow ) {
- const nextRow = table.getChild( currentRow + 1 );
- moveToCell = nextRow.getChild( 0 );
- }
- // Move to last cell in a previous row.
- else if ( !isForward && isFirstCellInRow ) {
- const previousRow = table.getChild( currentRow - 1 );
- moveToCell = previousRow.getChild( previousRow.childCount - 1 );
- }
- // Move to next/previous cell.
- else {
- moveToCell = tableRow.getChild( currentCellIndex + ( isForward ? 1 : -1 ) );
- }
- editor.model.change( writer => {
- writer.setSelection( Range.createIn( moveToCell ) );
- } );
- }
- }
|