@ckeditor/ckeditor5-engine 33.0.0 → 34.0.0

package/src/view/downcastwriter.js

@@ -185,10 +185,6 @@ export default class DowncastWriter {
 	 *		// Set `id` of a marker element so it is not joined or merged with "normal" elements.
 	 *		writer.createAttributeElement( 'span', { class: 'my-marker' }, { id: 'marker:my' } );
 	 *
-	 * **Note:** By default an `AttributeElement` is split by a
-	 * {@link module:engine/view/containerelement~ContainerElement `ContainerElement`} but this behavior can be modified
-	 * with `isAllowedInsideAttributeElement` option set while {@link #createContainerElement creating the element}.
-	 *
 	 * @param {String} name Name of the element.
 	 * @param {Object} [attributes] Element's attributes.
 	 * @param {Object} [options] Element's options.
@@ -237,7 +233,7 @@ export default class DowncastWriter {
 	 *		] );
 	 *
 	 *		// Create element with specific options.
-	 *		writer.createContainerElement( 'span', { class: 'placeholder' }, { isAllowedInsideAttributeElement: true } );
+	 *		writer.createContainerElement( 'span', { class: 'placeholder' }, { renderUnsafeAttributes: [ 'foo' ] } );
 	 *
 	 * @param {String} name Name of the element.
 	 * @param {Object} [attributes] Elements attributes.
@@ -245,9 +241,6 @@ export default class DowncastWriter {
 	 * A node or a list of nodes to be inserted into the created element. If no children were specified, element's `options`
 	 * can be passed in this argument.
 	 * @param {Object} [options] Element's options.
-	 * @param {Boolean} [options.isAllowedInsideAttributeElement=false] Whether an element is
-	 * {@link module:engine/view/element~Element#isAllowedInsideAttributeElement allowed inside an AttributeElement} and can be wrapped
-	 * with {@link module:engine/view/attributeelement~AttributeElement} by {@link module:engine/view/downcastwriter~DowncastWriter}.
 	 * @param {Array.<String>} [options.renderUnsafeAttributes] A list of attribute names that should be rendered in the editing
 	 * pipeline even though they would normally be filtered out by unsafe attribute detection mechanisms.
 	 * @returns {module:engine/view/containerelement~ContainerElement} Created element.
@@ -263,10 +256,6 @@ export default class DowncastWriter {
 
 		const containerElement = new ContainerElement( this.document, name, attributes, children );
 
-		if ( options.isAllowedInsideAttributeElement !== undefined ) {
-			containerElement._isAllowedInsideAttributeElement = options.isAllowedInsideAttributeElement;
-		}
-
 		if ( options.renderUnsafeAttributes ) {
 			containerElement._unsafeAttributesToRender.push( ...options.renderUnsafeAttributes );
 		}
@@ -310,9 +299,6 @@ export default class DowncastWriter {
 	 * @param {String} name Name of the element.
 	 * @param {Object} [attributes] Elements attributes.
 	 * @param {Object} [options] Element's options.
-	 * @param {Boolean} [options.isAllowedInsideAttributeElement=true] Whether an element is
-	 * {@link module:engine/view/element~Element#isAllowedInsideAttributeElement allowed inside an AttributeElement} and can be wrapped
-	 * with {@link module:engine/view/attributeelement~AttributeElement} by {@link module:engine/view/downcastwriter~DowncastWriter}.
 	 * @param {Array.<String>} [options.renderUnsafeAttributes] A list of attribute names that should be rendered in the editing
 	 * pipeline even though they would normally be filtered out by unsafe attribute detection mechanisms.
 	 * @returns {module:engine/view/emptyelement~EmptyElement} Created element.
@@ -320,10 +306,6 @@ export default class DowncastWriter {
 	createEmptyElement( name, attributes, options = {} ) {
 		const emptyElement = new EmptyElement( this.document, name, attributes );
 
-		if ( options.isAllowedInsideAttributeElement !== undefined ) {
-			emptyElement._isAllowedInsideAttributeElement = options.isAllowedInsideAttributeElement;
-		}
-
 		if ( options.renderUnsafeAttributes ) {
 			emptyElement._unsafeAttributesToRender.push( ...options.renderUnsafeAttributes );
 		}
@@ -354,23 +336,15 @@ export default class DowncastWriter {
 	 * @param {String} name The name of the element.
 	 * @param {Object} [attributes] Element attributes.
 	 * @param {Function} [renderFunction] A custom render function.
-	 * @param {Object} [options] Element's options.
-	 * @param {Boolean} [options.isAllowedInsideAttributeElement=true] Whether an element is
-	 * {@link module:engine/view/element~Element#isAllowedInsideAttributeElement allowed inside an AttributeElement} and can be wrapped
-	 * with {@link module:engine/view/attributeelement~AttributeElement} by {@link module:engine/view/downcastwriter~DowncastWriter}.
 	 * @returns {module:engine/view/uielement~UIElement} The created element.
 	 */
-	createUIElement( name, attributes, renderFunction, options = {} ) {
+	createUIElement( name, attributes, renderFunction ) {
 		const uiElement = new UIElement( this.document, name, attributes );
 
 		if ( renderFunction ) {
 			uiElement.render = renderFunction;
 		}
 
-		if ( options.isAllowedInsideAttributeElement !== undefined ) {
-			uiElement._isAllowedInsideAttributeElement = options.isAllowedInsideAttributeElement;
-		}
-
 		return uiElement;
 	}
 
@@ -397,9 +371,6 @@ export default class DowncastWriter {
 	 * @param {Object} [attributes] Element attributes.
 	 * @param {Function} [renderFunction] A custom render function.
 	 * @param {Object} [options] Element's options.
-	 * @param {Boolean} [options.isAllowedInsideAttributeElement=true] Whether an element is
-	 * {@link module:engine/view/element~Element#isAllowedInsideAttributeElement allowed inside an AttributeElement} and can be wrapped
-	 * with {@link module:engine/view/attributeelement~AttributeElement} by {@link module:engine/view/downcastwriter~DowncastWriter}.
 	 * @param {Array.<String>} [options.renderUnsafeAttributes] A list of attribute names that should be rendered in the editing
 	 * pipeline even though they would normally be filtered out by unsafe attribute detection mechanisms.
 	 * @returns {module:engine/view/rawelement~RawElement} The created element.
@@ -409,10 +380,6 @@ export default class DowncastWriter {
 
 		rawElement.render = renderFunction || ( () => {} );
 
-		if ( options.isAllowedInsideAttributeElement !== undefined ) {
-			rawElement._isAllowedInsideAttributeElement = options.isAllowedInsideAttributeElement;
-		}
-
 		if ( options.renderUnsafeAttributes ) {
 			rawElement._unsafeAttributesToRender.push( ...options.renderUnsafeAttributes );
 		}
@@ -790,7 +757,7 @@ export default class DowncastWriter {
 
 			// Break attributes on nodes that do exist in the model tree so they can have attributes, other elements
 			// can't have an attribute in model and won't get wrapped with an AttributeElement while down-casted.
-			const breakAttributes = !( node.is( 'uiElement' ) && node.isAllowedInsideAttributeElement );
+			const breakAttributes = !node.is( 'uiElement' );
 
 			if ( !lastGroup || lastGroup.breakAttributes != breakAttributes ) {
 				groups.push( {
@@ -979,16 +946,6 @@ export default class DowncastWriter {
 	 * Throws {@link module:utils/ckeditorerror~CKEditorError} `view-writer-wrap-nonselection-collapsed-range` when passed range
 	 * is collapsed and different than view selection.
 	 *
-	 * **Note:** Attribute elements by default can wrap {@link module:engine/view/text~Text},
-	 * {@link module:engine/view/emptyelement~EmptyElement}, {@link module:engine/view/uielement~UIElement},
-	 * {@link module:engine/view/rawelement~RawElement} and other attribute elements with higher priority. Other elements while placed
-	 * inside an attribute element will split it (or nest it in case of an `AttributeElement`). This behavior can be modified by changing
-	 * the `isAllowedInsideAttributeElement` option while using
-	 * {@link module:engine/view/downcastwriter~DowncastWriter#createContainerElement},
-	 * {@link module:engine/view/downcastwriter~DowncastWriter#createEmptyElement},
-	 * {@link module:engine/view/downcastwriter~DowncastWriter#createUIElement} or
-	 * {@link module:engine/view/downcastwriter~DowncastWriter#createRawElement}.
-	 *
 	 * @param {module:engine/view/range~Range} range Range to wrap.
 	 * @param {module:engine/view/attributeelement~AttributeElement} attribute Attribute element to use as wrapper.
 	 * @returns {module:engine/view/range~Range} range Range after wrapping, spanning over wrapping attribute element.
@@ -1399,7 +1356,6 @@ export default class DowncastWriter {
 			const child = parent.getChild( i );
 			const isText = child.is( '$text' );
 			const isAttribute = child.is( 'attributeElement' );
-			const isAllowedInsideAttributeElement = child.isAllowedInsideAttributeElement;
 
 			//
 			// (In all examples, assume that `wrapElement` is `<span class="foo">` element.)
@@ -1418,7 +1374,7 @@ export default class DowncastWriter {
 			//
 			// <p>abc</p>                   -->  <p><span class="foo">abc</span></p>
 			// <p><strong>abc</strong></p>  -->  <p><span class="foo"><strong>abc</strong></span></p>
-			else if ( isText || isAllowedInsideAttributeElement || ( isAttribute && shouldABeOutsideB( wrapElement, child ) ) ) {
+			else if ( isText || !isAttribute || shouldABeOutsideB( wrapElement, child ) ) {
 				// Clone attribute.
 				const newAttribute = wrapElement._clone();
 
@@ -1436,7 +1392,7 @@ export default class DowncastWriter {
 			//
 			// <p><a href="foo.html">abc</a></p>  -->  <p><a href="foo.html"><span class="foo">abc</span></a></p>
 			//
-			else if ( isAttribute ) {
+			else /* if ( isAttribute ) */ {
 				this._wrapChildren( child, 0, child.childCount, wrapElement );
 			}
 

package/src/view/element.js

@@ -130,15 +130,6 @@ export default class Element extends Node {
 		 */
 		this._customProperties = new Map();
 
-		/**
-		 * Whether an element is allowed inside an AttributeElement and can be wrapped with
-		 * {@link module:engine/view/attributeelement~AttributeElement} by {@link module:engine/view/downcastwriter~DowncastWriter}.
-		 *
-		 * @protected
-		 * @member {Boolean}
-		 */
-		this._isAllowedInsideAttributeElement = false;
-
 		/**
 		 * A list of attribute names that should be rendered in the editing pipeline even though filtering mechanisms
 		 * implemented in the {@link module:engine/view/domconverter~DomConverter} (for instance,
@@ -175,17 +166,6 @@ export default class Element extends Node {
 		return this._children.length === 0;
 	}
 
-	/**
-	 * Whether the element is allowed inside an AttributeElement and can be wrapped with
-	 * {@link module:engine/view/attributeelement~AttributeElement} by {@link module:engine/view/downcastwriter~DowncastWriter}.
-	 *
-	 * @readonly
-	 * @type {Boolean}
-	 */
-	get isAllowedInsideAttributeElement() {
-		return this._isAllowedInsideAttributeElement;
-	}
-
 	/**
 	 * Checks whether this object is of the given.
 	 *
@@ -350,11 +330,6 @@ export default class Element extends Node {
 			return false;
 		}
 
-		// Check isAllowedInsideAttributeElement property.
-		if ( this.isAllowedInsideAttributeElement != otherElement.isAllowedInsideAttributeElement ) {
-			return false;
-		}
-
 		// Check number of attributes, classes and styles.
 		if ( this._attrs.size !== otherElement._attrs.size || this._classes.size !== otherElement._classes.size ||
 			this._styles.size !== otherElement._styles.size ) {
@@ -633,8 +608,6 @@ export default class Element extends Node {
 		// is changed by e.g. toWidget() function from ckeditor5-widget. Perhaps this should be one of custom props.
 		cloned.getFillerOffset = this.getFillerOffset;
 
-		cloned._isAllowedInsideAttributeElement = this.isAllowedInsideAttributeElement;
-
 		return cloned;
 	}
 

package/src/view/emptyelement.js

@@ -37,9 +37,6 @@ export default class EmptyElement extends Element {
 	constructor( document, name, attrs, children ) {
 		super( document, name, attrs, children );
 
-		// Override the default of the base class.
-		this._isAllowedInsideAttributeElement = true;
-
 		/**
 		 * Returns `null` because filler is not needed for EmptyElements.
 		 *

package/src/view/matcher.js

@@ -739,7 +739,7 @@ function matchStyles( patterns, element ) {
  * 			styles: /^border.*$/
  * 		}
  *
- * Refer to the {@glink builds/guides/migration/migration-to-29##migration-to-ckeditor-5-v2910 Migration to v29.1.0} guide
+ * Refer to the {@glink updating/migration-to-29##migration-to-ckeditor-5-v2910 Migration to v29.1.0} guide
  * and {@link module:engine/view/matcher~MatcherPattern} documentation.
  *
  * @param {Object} pattern Pattern with missing properties.
@@ -769,7 +769,7 @@ function matchStyles( patterns, element ) {
  * 			classes: 'foobar'
  * 		}
  *
- * Refer to the {@glink builds/guides/migration/migration-to-29##migration-to-ckeditor-5-v2910 Migration to v29.1.0} guide
+ * Refer to the {@glink updating/migration-to-29##migration-to-ckeditor-5-v2910 Migration to v29.1.0} guide
  * and the {@link module:engine/view/matcher~MatcherPattern} documentation.
  *
  * @param {Object} pattern Pattern with missing properties.

package/src/view/observer/clickobserver.js

@@ -1,4 +1,3 @@
-
 /**
  * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license

package/src/view/observer/inputobserver.js

@@ -1,6 +1,6 @@
 /**
  * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
 
 /**

package/src/view/observer/tabobserver.js

@@ -0,0 +1,68 @@
+/**
+ * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+
+/**
+ * @module engine/view/observer/tabobserver
+ */
+
+import Observer from './observer';
+import BubblingEventInfo from './bubblingeventinfo';
+
+import { keyCodes } from '@ckeditor/ckeditor5-utils/src/keyboard';
+
+/**
+ * Tab observer introduces the {@link module:engine/view/document~Document#event:tab `Document#tab`} event.
+ *
+ * Note that because {@link module:engine/view/observer/tabobserver~TabObserver} is attached by the
+ * {@link module:engine/view/view~View} this event is available by default.
+ *
+ * @extends module:engine/view/observer/observer~Observer
+ */
+export default class TabObserver extends Observer {
+	/**
+	 * @inheritDoc
+	 */
+	constructor( view ) {
+		super( view );
+
+		const doc = this.document;
+
+		doc.on( 'keydown', ( evt, data ) => {
+			if (
+				!this.isEnabled ||
+				data.keyCode != keyCodes.tab ||
+				data.ctrlKey
+			) {
+				return;
+			}
+
+			const event = new BubblingEventInfo( doc, 'tab', doc.selection.getFirstRange() );
+
+			doc.fire( event, data );
+
+			if ( event.stop.called ) {
+				evt.stop();
+			}
+		} );
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	observe() {}
+}
+
+/**
+ * Event fired when the user presses a tab key.
+ *
+ * Introduced by {@link module:engine/view/observer/tabobserver~TabObserver}.
+ *
+ * Note that because {@link module:engine/view/observer/tabobserver~TabObserver} is attached by the
+ * {@link module:engine/view/view~View} this event is available by default.
+ *
+ * @event module:engine/view/document~Document#event:tab
+ *
+ * @param {module:engine/view/observer/domeventdata~DomEventData} data
+ */

package/src/view/placeholder.js

@@ -276,7 +276,7 @@ function getChildPlaceholderHostSubstitute( parent ) {
 	if ( parent.childCount ) {
 		const firstChild = parent.getChild( 0 );
 
-		if ( firstChild.is( 'element' ) && !firstChild.is( 'uiElement' ) ) {
+		if ( firstChild.is( 'element' ) && !firstChild.is( 'uiElement' ) && !firstChild.is( 'attributeElement' ) ) {
 			return firstChild;
 		}
 	}

package/src/view/rawelement.js

@@ -47,9 +47,6 @@ export default class RawElement extends Element {
 	constructor( document, name, attrs, children ) {
 		super( document, name, attrs, children );
 
-		// Override the default of the base class.
-		this._isAllowedInsideAttributeElement = true;
-
 		/**
 		 * Returns `null` because filler is not needed for raw elements.
 		 *

package/src/view/uielement.js

@@ -50,9 +50,6 @@ export default class UIElement extends Element {
 	constructor( document, name, attributes, children ) {
 		super( document, name, attributes, children );
 
-		// Override the default of the base class.
-		this._isAllowedInsideAttributeElement = true;
-
 		/**
 		 * Returns `null` because filler is not needed for UIElements.
 		 *

package/src/view/view.js

@@ -23,6 +23,7 @@ import FocusObserver from './observer/focusobserver';
 import CompositionObserver from './observer/compositionobserver';
 import InputObserver from './observer/inputobserver';
 import ArrowKeysObserver from './observer/arrowkeysobserver';
+import TabObserver from './observer/tabobserver';
 
 import ObservableMixin from '@ckeditor/ckeditor5-utils/src/observablemixin';
 import mix from '@ckeditor/ckeditor5-utils/src/mix';
@@ -54,6 +55,8 @@ import env from '@ckeditor/ckeditor5-utils/src/env';
  * * {@link module:engine/view/observer/keyobserver~KeyObserver},
  * * {@link module:engine/view/observer/fakeselectionobserver~FakeSelectionObserver}.
  * * {@link module:engine/view/observer/compositionobserver~CompositionObserver}.
+ * * {@link module:engine/view/observer/arrowkeysobserver~ArrowKeysObserver}.
+ * * {@link module:engine/view/observer/tabobserver~TabObserver}.
  *
  * This class also {@link module:engine/view/view~View#attachDomRoot binds the DOM and the view elements}.
  *
@@ -186,6 +189,7 @@ export default class View {
 		this.addObserver( FakeSelectionObserver );
 		this.addObserver( CompositionObserver );
 		this.addObserver( ArrowKeysObserver );
+		this.addObserver( TabObserver );
 
 		if ( env.isAndroid ) {
 			this.addObserver( InputObserver );