| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115 |
- /**
- * @license Copyright (c) 2003-2016, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md.
- */
- import Command from './command.js';
- import getSchemaValidRanges from './helpers/getschemavalidranges.js';
- import isAttributeAllowedInSelection from './helpers/isattributeallowedinselection.js';
- /**
- * An extension of basic {@link core.command.Command} class, which provides utilities for a command that toggle a single
- * attribute on a text or element with value `true`. ToggleAttributeCommand uses {@link engine.model.Document#selection}
- * to decide which nodes (if any) should be changed, and applies or removes attributes from them.
- * See {@link engine.view.Converter#execute} for more.
- *
- * The command checks {@link engine.model.Document#schema} to decide if it should be enabled.
- * See {@link engine.view.Converter#checkSchema} for more.
- *
- * @memberOf core.command
- */
- export default class ToggleAttributeCommand extends Command {
- /**
- * @see core.command.Command
- * @param {core.editor.Editor} editor
- * @param {String} attributeKey Attribute that will be set by the command.
- */
- constructor( editor, attributeKey ) {
- super( editor );
- /**
- * Attribute that will be set by the command.
- *
- * @member {String} core.command.ToggleAttributeCommand#attributeKey
- */
- this.attributeKey = attributeKey;
- /**
- * Flag indicating whether command is active. For collapsed selection it means that typed characters will have
- * the command's attribute set. For range selection it means that all nodes inside have the attribute applied.
- *
- * @observable
- * @member {Boolean} core.command.ToggleAttributeCommand#value
- */
- this.set( 'value', false );
- this.listenTo( this.editor.document.selection, 'change:attribute', () => {
- this.value = this.editor.document.selection.hasAttribute( this.attributeKey );
- } );
- }
- /**
- * Checks if {@link engine.model.Document#schema} allows to create attribute in {@link engine.model.Document#selection}
- *
- * @private
- * @returns {Boolean}
- */
- _checkEnabled() {
- const document = this.editor.document;
- return isAttributeAllowedInSelection( this.attributeKey, document.selection, document.schema );
- }
- /**
- * Executes the command: adds or removes attributes to nodes or selection.
- *
- * If the command is active (`value == true`), it will remove attributes. Otherwise, it will set attributes.
- *
- * The execution result differs, depending on the {@link engine.model.Document#selection}:
- * * if selection is on a range, the command applies the attribute on all nodes in that ranges
- * (if they are allowed to have this attribute by the {@link engine.model.Schema schema}),
- * * if selection is collapsed in non-empty node, the command applies attribute to the {@link engine.model.Document#selection}
- * itself (note that typed characters copy attributes from selection),
- * * if selection is collapsed in empty node, the command applies attribute to the parent node of selection (note
- * that selection inherits all attributes from a node if it is in empty node).
- *
- * If the command is disabled (`isEnabled == false`) when it is executed, nothing will happen.
- *
- * @private
- * @param {Object} [options] Options of command.
- * @param {Boolean} [options.forceValue] If set it will force command behavior. If `true`, command will apply attribute,
- * otherwise command will remove attribute. If not set, command will look for it's current value to decide what it should do.
- * @param {engine.model.Batch} [options.batch] Batch to group undo steps.
- * @param {Array.<engine.model.Range>} [options.ranges] The list of ranges to apply command to.
- */
- _doExecute( options = {} ) {
- const { forceValue, batch, ranges } = options;
- const document = this.editor.document;
- const selection = document.selection;
- const value = ( forceValue === undefined ) ? !this.value : forceValue;
- // If selection has non-collapsed ranges, we change attribute on nodes inside those ranges.
- document.enqueueChanges( () => {
- if ( !ranges && selection.isCollapsed ) {
- if ( value ) {
- selection.setAttribute( this.attributeKey, true );
- } else {
- selection.removeAttribute( this.attributeKey );
- }
- } else {
- const workRanges = getSchemaValidRanges( this.attributeKey, ranges || selection.getRanges(), document.schema );
- // Keep it as one undo step.
- const workBatch = batch || document.batch();
- for ( let range of workRanges ) {
- if ( value ) {
- workBatch.setAttribute( range, this.attributeKey, value );
- } else {
- workBatch.removeAttribute( range, this.attributeKey );
- }
- }
- }
- } );
- }
- }
|