@ckeditor/ckeditor5-engine 34.2.0 → 35.1.0

package/src/view/rawelement.js

@@ -2,15 +2,12 @@
  * @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/rawelement
  */
-
 import Element from './element';
-import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror';
 import Node from './node';
-
+import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror';
 /**
  * The raw element class.
  *
@@ -30,117 +27,93 @@ import Node from './node';
  * @extends module:engine/view/element~Element
  */
 export default class RawElement extends Element {
-	/**
-	 * Creates a new instance of a raw element.
-	 *
-	 * Throws the `view-rawelement-cannot-add` {@link module:utils/ckeditorerror~CKEditorError CKEditorError} when the `children`
-	 * parameter is passed to inform that the usage of `RawElement` is incorrect (adding child nodes to `RawElement` is forbidden).
-	 *
-	 * @see module:engine/view/downcastwriter~DowncastWriter#createRawElement
-	 * @protected
-	 * @param {module:engine/view/document~Document} document The document instance to which this element belongs.
-	 * @param {String} name A node name.
-	 * @param {Object|Iterable} [attrs] The collection of attributes.
-	 * @param {module:engine/view/node~Node|Iterable.<module:engine/view/node~Node>} [children]
-	 * A list of nodes to be inserted into the created element.
-	 */
-	constructor( document, name, attrs, children ) {
-		super( document, name, attrs, children );
-
-		/**
-		 * Returns `null` because filler is not needed for raw elements.
-		 *
-		 * @method #getFillerOffset
-		 * @returns {null} Always returns null.
-		 */
-		this.getFillerOffset = getFillerOffset;
-	}
-
-	/**
-	 * Checks whether this object is of the given type or name.
-	 *
-	 *		rawElement.is( 'rawElement' ); // -> true
-	 *		rawElement.is( 'element' ); // -> true
-	 *		rawElement.is( 'node' ); // -> true
-	 *		rawElement.is( 'view:rawElement' ); // -> true
-	 *		rawElement.is( 'view:element' ); // -> true
-	 *		rawElement.is( 'view:node' ); // -> true
-	 *
-	 *		rawElement.is( 'model:element' ); // -> false
-	 *		rawElement.is( 'documentFragment' ); // -> false
-	 *
-	 * Assuming that the object being checked is a raw element, you can also check its
-	 * {@link module:engine/view/rawelement~RawElement#name name}:
-	 *
-	 *		rawElement.is( 'img' ); // -> true if this is an img element
-	 *		rawElement.is( 'rawElement', 'img' ); // -> same as above
-	 *		text.is( 'img' ); -> false
-	 *
-	 * {@link module:engine/view/node~Node#is Check the entire list of view objects} which implement the `is()` method.
-	 *
-	 * @param {String} type The type to check when the `name` parameter is present.
-	 * Otherwise, it acts like the `name` parameter.
-	 * @param {String} [name] The element name.
-	 * @returns {Boolean}
-	 */
-	is( type, name = null ) {
-		if ( !name ) {
-			return type === 'rawElement' || type === 'view:rawElement' ||
-				// From super.is(). This is highly utilised method and cannot call super. See ckeditor/ckeditor5#6529.
-				type === this.name || type === 'view:' + this.name ||
-				type === 'element' || type === 'view:element' ||
-				type === 'node' || type === 'view:node';
-		} else {
-			return name === this.name && (
-				type === 'rawElement' || type === 'view:rawElement' ||
-				type === 'element' || type === 'view:element'
-			);
-		}
-	}
-
-	/**
-	 * Overrides the {@link module:engine/view/element~Element#_insertChild} method.
-	 * Throws the `view-rawelement-cannot-add` {@link module:utils/ckeditorerror~CKEditorError CKEditorError} to prevent
-	 * adding any child nodes to a raw element.
-	 *
-	 * @protected
-	 */
-	_insertChild( index, nodes ) {
-		if ( nodes && ( nodes instanceof Node || Array.from( nodes ).length > 0 ) ) {
-			/**
-			 * Cannot add children to a {@link module:engine/view/rawelement~RawElement} instance.
-			 *
-			 * @error view-rawelement-cannot-add
-			 */
-			throw new CKEditorError(
-				'view-rawelement-cannot-add',
-				[ this, nodes ]
-			);
-		}
-	}
-
-	/**
-	 * This allows rendering the children of a {@link module:engine/view/rawelement~RawElement} on the DOM level.
-	 * This method is called by the {@link module:engine/view/domconverter~DomConverter} with the raw DOM element
-	 * passed as an argument, leaving the number and shape of the children up to the integrator.
-	 *
-	 * This method **must be defined** for the raw element to work:
-	 *
-	 *		const myRawElement = downcastWriter.createRawElement( 'div' );
-	 *
-	 *		myRawElement.render = function( domElement, domConverter ) {
-	 *			domConverter.setContentOf( domElement, '<b>This is the raw content of myRawElement.</b>' );
-	 *		};
-	 *
-	 * @method #render
-	 * @param {HTMLElement} domElement The native DOM element representing the raw view element.
-	 * @param {module:engine/view/domconverter~DomConverter} domConverter Instance of the DomConverter used to optimize the output.
-	 */
+    /**
+     * Creates a new instance of a raw element.
+     *
+     * Throws the `view-rawelement-cannot-add` {@link module:utils/ckeditorerror~CKEditorError CKEditorError} when the `children`
+     * parameter is passed to inform that the usage of `RawElement` is incorrect (adding child nodes to `RawElement` is forbidden).
+     *
+     * @see module:engine/view/downcastwriter~DowncastWriter#createRawElement
+     * @protected
+     * @param {module:engine/view/document~Document} document The document instance to which this element belongs.
+     * @param {String} name A node name.
+     * @param {Object|Iterable} [attrs] The collection of attributes.
+     * @param {module:engine/view/node~Node|Iterable.<module:engine/view/node~Node>} [children]
+     * A list of nodes to be inserted into the created element.
+     */
+    constructor(...args) {
+        super(...args);
+        /**
+         * Returns `null` because filler is not needed for raw elements.
+         *
+         * @method #getFillerOffset
+         * @returns {null} Always returns null.
+         */
+        this.getFillerOffset = getFillerOffset;
+    }
+    /**
+     * Overrides the {@link module:engine/view/element~Element#_insertChild} method.
+     * Throws the `view-rawelement-cannot-add` {@link module:utils/ckeditorerror~CKEditorError CKEditorError} to prevent
+     * adding any child nodes to a raw element.
+     *
+     * @protected
+     */
+    _insertChild(index, items) {
+        if (items && (items instanceof Node || Array.from(items).length > 0)) {
+            /**
+             * Cannot add children to a {@link module:engine/view/rawelement~RawElement} instance.
+             *
+             * @error view-rawelement-cannot-add
+             */
+            throw new CKEditorError('view-rawelement-cannot-add', [this, items]);
+        }
+        return 0;
+    }
+    render() { }
 }
-
+/**
+ * Checks whether this object is of the given type or name.
+ *
+ *		rawElement.is( 'rawElement' ); // -> true
+ *		rawElement.is( 'element' ); // -> true
+ *		rawElement.is( 'node' ); // -> true
+ *		rawElement.is( 'view:rawElement' ); // -> true
+ *		rawElement.is( 'view:element' ); // -> true
+ *		rawElement.is( 'view:node' ); // -> true
+ *
+ *		rawElement.is( 'model:element' ); // -> false
+ *		rawElement.is( 'documentFragment' ); // -> false
+ *
+ * Assuming that the object being checked is a raw element, you can also check its
+ * {@link module:engine/view/rawelement~RawElement#name name}:
+ *
+ *		rawElement.is( 'img' ); // -> true if this is an img element
+ *		rawElement.is( 'rawElement', 'img' ); // -> same as above
+ *		text.is( 'img' ); -> false
+ *
+ * {@link module:engine/view/node~Node#is Check the entire list of view objects} which implement the `is()` method.
+ *
+ * @param {String} type The type to check when the `name` parameter is present.
+ * Otherwise, it acts like the `name` parameter.
+ * @param {String} [name] The element name.
+ * @returns {Boolean}
+ */
+RawElement.prototype.is = function (type, name) {
+    if (!name) {
+        return type === 'rawElement' || type === 'view:rawElement' ||
+            // From super.is(). This is highly utilised method and cannot call super. See ckeditor/ckeditor5#6529.
+            type === this.name || type === 'view:' + this.name ||
+            type === 'element' || type === 'view:element' ||
+            type === 'node' || type === 'view:node';
+    }
+    else {
+        return name === this.name && (type === 'rawElement' || type === 'view:rawElement' ||
+            type === 'element' || type === 'view:element');
+    }
+};
 // Returns `null` because block filler is not needed for raw elements.
 //
 // @returns {null}
 function getFillerOffset() {
-	return null;
+    return null;
 }