浏览代码

Added: Initial mergeRight and mergeLeft commands implementation.

Maciej Gołaszewski 7 年之前
父节点
当前提交
b57a632b53

+ 77 - 0
packages/ckeditor5-table/src/commands/mergecellcommand.js

@@ -0,0 +1,77 @@
+/**
+ * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+/**
+ * @module table/commands/mergecellcommand
+ */
+
+import Command from '@ckeditor/ckeditor5-core/src/command';
+import Position from '@ckeditor/ckeditor5-engine/src/model/position';
+import Range from '../../../ckeditor5-engine/src/model/range';
+
+/**
+ * The merge cell command.
+ *
+ * @extends module:core/command~Command
+ */
+export default class MergeCellCommand extends Command {
+	/**
+	 * @param editor
+	 * @param options
+	 */
+	constructor( editor, options ) {
+		super( editor );
+
+		this.direction = options.direction;
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	refresh() {
+		this.isEnabled = this._checkEnabled();
+	}
+
+	_checkEnabled() {
+		const model = this.editor.model;
+		const doc = model.document;
+		const element = doc.selection.getFirstPosition().parent;
+
+		const siblingToMerge = this.direction == 'right' ? element.nextSibling : element.previousSibling;
+
+		if ( !element.is( 'tableCell' ) || !siblingToMerge ) {
+			return false;
+		}
+
+		const rowspan = parseInt( element.getAttribute( 'rowspan' ) || 1 );
+
+		const nextCellRowspan = parseInt( siblingToMerge.getAttribute( 'rowspan' ) || 1 );
+
+		return nextCellRowspan === rowspan;
+	}
+
+	/**
+	 * Executes the command.
+	 *
+	 * @fires execute
+	 */
+	execute() {
+		const model = this.editor.model;
+		const doc = model.document;
+		const tableCell = doc.selection.getFirstPosition().parent;
+
+		const siblingToMerge = this.direction == 'right' ? tableCell.nextSibling : tableCell.previousSibling;
+
+		model.change( writer => {
+			writer.move( Range.createIn( siblingToMerge ), Position.createAt( tableCell, this.direction == 'right' ? 'end' : undefined ) );
+			writer.remove( siblingToMerge );
+
+			const colspan = parseInt( tableCell.getAttribute( 'colspan' ) || 1 );
+			const nextTableCellColspan = parseInt( siblingToMerge.getAttribute( 'colspan' ) || 1 );
+
+			writer.setAttribute( 'colspan', colspan + nextTableCellColspan, tableCell );
+		} );
+	}
+}

+ 3 - 0
packages/ckeditor5-table/src/tableediting.js

@@ -18,6 +18,7 @@ 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 { getParentTable } from './commands/utils';
@@ -88,6 +89,8 @@ export default class TablesEditing extends Plugin {
 		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' } ) );
 
 		this.listenTo( editor.editing.view.document, 'keydown', ( ...args ) => this._handleTabOnSelectedTable( ...args ) );
 		this.listenTo( editor.editing.view.document, 'keydown', ( ...args ) => this._handleTabInsideTable( ...args ) );

+ 190 - 0
packages/ckeditor5-table/tests/commands/mergecellcommand.js

@@ -0,0 +1,190 @@
+/**
+ * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+import ModelTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/modeltesteditor';
+import { setData, getData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model';
+import { upcastElementToElement } from '@ckeditor/ckeditor5-engine/src/conversion/upcast-converters';
+
+import MergeCellCommand from '../../src/commands/mergecellcommand';
+import { downcastInsertTable } from '../../src/converters/downcast';
+import upcastTable from '../../src/converters/upcasttable';
+import { formatTable, formattedModelTable, modelTable } from '../_utils/utils';
+
+describe.only( 'MergeCellCommand', () => {
+	let editor, model, command;
+
+	beforeEach( () => {
+		return ModelTestEditor.create()
+			.then( newEditor => {
+				editor = newEditor;
+				model = editor.model;
+
+				const conversion = editor.conversion;
+				const schema = model.schema;
+
+				schema.register( 'table', {
+					allowWhere: '$block',
+					allowAttributes: [ 'headingRows' ],
+					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
+				} );
+
+				model.schema.register( 'p', { inheritAllFrom: '$block' } );
+
+				// Table conversion.
+				conversion.for( 'upcast' ).add( upcastTable() );
+				conversion.for( 'downcast' ).add( downcastInsertTable() );
+
+				// Table row upcast only since downcast conversion is done in `downcastTable()`.
+				conversion.for( 'upcast' ).add( upcastElementToElement( { model: 'tableRow', view: 'tr' } ) );
+
+				// Table cell conversion.
+				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' } );
+			} );
+	} );
+
+	afterEach( () => {
+		return editor.destroy();
+	} );
+
+	describe( 'direction=right', () => {
+		beforeEach( () => {
+			command = new MergeCellCommand( editor, { direction: 'right' } );
+		} );
+
+		describe( 'isEnabled', () => {
+			it( 'should be true if in cell that has sibling on the right', () => {
+				setData( model, modelTable( [
+					[ '00[]', '01' ]
+				] ) );
+
+				expect( command.isEnabled ).to.be.true;
+			} );
+
+			it( 'should be false if last cell of a row', () => {
+				setData( model, modelTable( [
+					[ '00', '01[]' ]
+				] ) );
+
+				expect( command.isEnabled ).to.be.false;
+			} );
+
+			it( 'should be true if in a cell that has sibling on the right with the same rowspan', () => {
+				setData( model, modelTable( [
+					[ { rowspan: 2, contents: '00[]' }, { rowspan: 2, contents: '01' } ]
+				] ) );
+
+				expect( command.isEnabled ).to.be.true;
+			} );
+
+			it( 'should be false if in a cell that has sibling but with different rowspan', () => {
+				setData( model, modelTable( [
+					[ { rowspan: 2, contents: '00[]' }, { rowspan: 3, contents: '01' } ]
+				] ) );
+
+				expect( command.isEnabled ).to.be.false;
+			} );
+
+			it( 'should be false if not in a cell', () => {
+				setData( model, '<p>11[]</p>' );
+
+				expect( command.isEnabled ).to.be.false;
+			} );
+		} );
+
+		describe( 'execute()', () => {
+			it( 'should merge table cells ', () => {
+				setData( model, modelTable( [
+					[ '[]00', '01' ]
+				] ) );
+
+				command.execute();
+
+				expect( formatTable( getData( model ) ) ).to.equal( formattedModelTable( [
+					[ { colspan: 2, contents: '[]0001' } ]
+				] ) );
+			} );
+		} );
+	} );
+
+	describe( 'direction=left', () => {
+		beforeEach( () => {
+			command = new MergeCellCommand( editor, { direction: 'left' } );
+		} );
+
+		describe( 'isEnabled', () => {
+			it( 'should be true if in cell that has sibling on the left', () => {
+				setData( model, modelTable( [
+					[ '00', '01[]' ]
+				] ) );
+
+				expect( command.isEnabled ).to.be.true;
+			} );
+
+			it( 'should be false if first cell of a row', () => {
+				setData( model, modelTable( [
+					[ '00[]', '01' ]
+				] ) );
+
+				expect( command.isEnabled ).to.be.false;
+			} );
+
+			it( 'should be true if in a cell that has sibling on the left with the same rowspan', () => {
+				setData( model, modelTable( [
+					[ { rowspan: 2, contents: '00' }, { rowspan: 2, contents: '01[]' } ]
+				] ) );
+
+				expect( command.isEnabled ).to.be.true;
+			} );
+
+			it( 'should be false if in a cell that has sibling but with different rowspan', () => {
+				setData( model, modelTable( [
+					[ { rowspan: 2, contents: '00' }, { rowspan: 3, contents: '01[]' } ]
+				] ) );
+
+				expect( command.isEnabled ).to.be.false;
+			} );
+
+			it( 'should be false if not in a cell', () => {
+				setData( model, '<p>11[]</p>' );
+
+				expect( command.isEnabled ).to.be.false;
+			} );
+		} );
+
+		describe( 'execute()', () => {
+			it( 'should merge table cells ', () => {
+				setData( model, modelTable( [
+					[ '00', '[]01' ]
+				] ) );
+
+				command.execute();
+
+				expect( formatTable( getData( model ) ) ).to.equal( formattedModelTable( [
+					[ { colspan: 2, contents: '00[]01' } ]
+				] ) );
+			} );
+		} );
+	} );
+} );

+ 2 - 0
packages/ckeditor5-table/tests/commands/splitcellcommand.js

@@ -82,6 +82,8 @@ describe( 'SplitCellCommand', () => {
 			setData( model, modelTable( [
 				[ { rowspan: 2, contents: '11[]' } ]
 			] ) );
+
+			expect( command.isEnabled ).to.be.true;
 		} );
 
 		it( 'should be false in cell without rowspan or colspan attribute', () => {