| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197 |
- /**
- * @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 list/liststylecommand
- */
- import Command from '@ckeditor/ckeditor5-core/src/command';
- import TreeWalker from '@ckeditor/ckeditor5-engine/src/model/treewalker';
- /**
- * The list style command. It is used by the {@link module:list/liststyle~ListStyle list styles feature}.
- *
- * @extends module:core/command~Command
- */
- export default class ListStyleCommand extends Command {
- /**
- * Creates an instance of the command.
- *
- * @param {module:core/editor/editor~Editor} editor The editor instance.
- * @param {String} defaultType The list type that will be used by default if the value was not specified during
- * the command execution.
- */
- constructor( editor, defaultType ) {
- super( editor );
- /**
- * The default type of the list style.
- *
- * @protected
- * @member {String}
- */
- this._defaultType = defaultType;
- }
- /**
- * @inheritDoc
- */
- refresh() {
- this.value = this._getValue();
- this.isEnabled = this._checkEnabled();
- }
- /**
- * Executes the command.
- *
- * @param {Object} options
- * @param {String|null} options.type The type of the list styles, e.g. 'disc' or 'square'. If `null` specified, the default
- * style will be applied.
- * @protected
- */
- execute( options = {} ) {
- const model = this.editor.model;
- const document = model.document;
- // For all selected blocks find all list items that are being selected
- // and update the `listStyle` attribute in those lists.
- let listItems = [ ...document.selection.getSelectedBlocks() ]
- .filter( element => element.is( 'element', 'listItem' ) )
- .map( element => {
- const position = model.change( writer => writer.createPositionAt( element, 0 ) );
- return [
- ...getSiblingNodes( position, 'backward' ),
- ...getSiblingNodes( position, 'forward' )
- ];
- } )
- .flat();
- // Since `getSelectedBlocks()` can return items that belong to the same list, and
- // `getSiblingNodes()` returns the entire list, we need to remove duplicated items.
- listItems = [ ...new Set( listItems ) ];
- if ( !listItems.length ) {
- return;
- }
- model.change( writer => {
- for ( const item of listItems ) {
- writer.setAttribute( 'listStyle', options.type || this._defaultType, item );
- }
- } );
- }
- /**
- * Checks the command's {@link #value}.
- *
- * @private
- * @returns {String|null} The current value.
- */
- _getValue() {
- const listItem = this.editor.model.document.selection.getFirstPosition().parent;
- if ( listItem && listItem.is( 'element', 'listItem' ) ) {
- return listItem.getAttribute( 'listStyle' );
- }
- return null;
- }
- /**
- * Checks whether the command can be enabled in the current context.
- *
- * @private
- * @returns {Boolean} Whether the command should be enabled.
- */
- _checkEnabled() {
- const editor = this.editor;
- const numberedList = editor.commands.get( 'numberedList' );
- const bulletedList = editor.commands.get( 'bulletedList' );
- return numberedList.isEnabled || bulletedList.isEnabled;
- }
- }
- // Returns an array with all `listItem` elements that represents the same list.
- //
- // It means that values for `listIndent`, `listType`, and `listStyle` for all items
- // are equal.
- //
- // @param {module:engine/model/position~Position} position Starting position.
- // @param {'forward'|'backward'} direction Walking direction.
- // @returns {Array.<module:engine/model/element~Element>
- function getSiblingNodes( position, direction ) {
- const items = [];
- const listItem = position.parent;
- const walkerOptions = {
- ignoreElementEnd: true,
- startPosition: position,
- shallow: true,
- direction
- };
- const limitIndent = listItem.getAttribute( 'listIndent' );
- const nodes = [ ...new TreeWalker( walkerOptions ) ]
- .filter( value => value.item.is( 'element' ) )
- .map( value => value.item );
- for ( const element of nodes ) {
- // If found something else than `listItem`, we're out of the list scope.
- if ( !element.is( 'element', 'listItem' ) ) {
- break;
- }
- // If current parsed item has lower indent that element that the element that was a starting point,
- // it means we left a nested list. Abort searching items.
- //
- // ■ List item 1. [listIndent=0]
- // ○ List item 2.[] [listIndent=1], limitIndent = 1,
- // ○ List item 3. [listIndent=1]
- // ■ List item 4. [listIndent=0]
- //
- // Abort searching when leave nested list.
- if ( element.getAttribute( 'listIndent' ) < limitIndent ) {
- break;
- }
- // ■ List item 1.[] [listIndent=0] limitIndent = 0,
- // ○ List item 2. [listIndent=1]
- // ○ List item 3. [listIndent=1]
- // ■ List item 4. [listIndent=0]
- //
- // Ignore nested lists.
- if ( element.getAttribute( 'listIndent' ) > limitIndent ) {
- continue;
- }
- // ■ List item 1.[] [listType=bulleted]
- // 1. List item 2. [listType=numbered]
- // 2.List item 3. [listType=numbered]
- //
- // Abort searching when found a different kind of a list.
- if ( element.getAttribute( 'listType' ) !== listItem.getAttribute( 'listType' ) ) {
- break;
- }
- // ■ List item 1.[] [listType=bulleted]
- // ■ List item 2. [listType=bulleted]
- // ○ List item 3. [listType=bulleted]
- // ○ List item 4. [listType=bulleted]
- //
- // Abort searching when found a different list style.
- if ( element.getAttribute( 'listStyle' ) !== listItem.getAttribute( 'listStyle' ) ) {
- break;
- }
- if ( direction === 'backward' ) {
- items.unshift( element );
- } else {
- items.push( element );
- }
- }
- return items;
- }
|