| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596 |
- /**
- * @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/commands/setheadercolumncommand
- */
- import Command from '@ckeditor/ckeditor5-core/src/command';
- import {
- findAncestor,
- isHeadingColumnCell,
- updateNumericAttribute
- } from '../utils/common';
- import { getColumnIndexes, getSelectionAffectedTableCells } from '../utils/selection';
- import { getHorizontallyOverlappingCells, splitVertically } from '../utils/structure';
- /**
- * The header column command.
- *
- * The command is registered by {@link module:table/tableediting~TableEditing} as the `'setTableColumnHeader'` editor command.
- *
- * You can make the column containing the selected cell a [header](https://www.w3.org/TR/html50/tabular-data.html#the-th-element)
- * by executing:
- *
- * editor.execute( 'setTableColumnHeader' );
- *
- * **Note:** All preceding columns will also become headers. If the current column is already a header, executing this command
- * will make it a regular column back again (including the following columns).
- *
- * @extends module:core/command~Command
- */
- export default class SetHeaderColumnCommand extends Command {
- /**
- * @inheritDoc
- */
- refresh() {
- const model = this.editor.model;
- const selectedCells = getSelectionAffectedTableCells( model.document.selection );
- const tableUtils = this.editor.plugins.get( 'TableUtils' );
- const isInTable = selectedCells.length > 0;
- this.isEnabled = isInTable;
- /**
- * Flag indicating whether the command is active. The command is active when the
- * {@link module:engine/model/selection~Selection} is in a header column.
- *
- * @observable
- * @readonly
- * @member {Boolean} #value
- */
- this.value = isInTable && selectedCells.every( cell => isHeadingColumnCell( tableUtils, cell ) );
- }
- /**
- * Executes the command.
- *
- * When the selection is in a non-header column, the command will set the `headingColumns` table attribute to cover that column.
- *
- * When the selection is already in a header column, it will set `headingColumns` so the heading section will end before that column.
- *
- * @fires execute
- * @param {Object} [options]
- * @param {Boolean} [options.forceValue] If set, the command will set (`true`) or unset (`false`) the header columns according to
- * the `forceValue` parameter instead of the current model state.
- */
- execute( options = {} ) {
- if ( options.forceValue === this.value ) {
- return;
- }
- const model = this.editor.model;
- const selectedCells = getSelectionAffectedTableCells( model.document.selection );
- const table = findAncestor( 'table', selectedCells[ 0 ] );
- const { first, last } = getColumnIndexes( selectedCells );
- const headingColumnsToSet = this.value ? first : last + 1;
- model.change( writer => {
- if ( headingColumnsToSet ) {
- // Changing heading columns requires to check if any of a heading cell is overlapping horizontally the table head.
- // Any table cell that has a colspan attribute > 1 will not exceed the table head so we need to fix it in columns before.
- const overlappingCells = getHorizontallyOverlappingCells( table, headingColumnsToSet );
- for ( const { cell, column } of overlappingCells ) {
- splitVertically( cell, column, headingColumnsToSet, writer );
- }
- }
- updateNumericAttribute( 'headingColumns', headingColumnsToSet, table, writer, 0 );
- } );
- }
- }
|