Преглед на файлове

Cross link view writer, element ans styles map docs.

Maciej Gołaszewski преди 5 години
родител
ревизия
594aa313c2

+ 4 - 0
packages/ckeditor5-engine/src/view/downcastwriter.js

@@ -324,6 +324,8 @@ export default class DowncastWriter {
 	 *			position: 'fixed'
 	 *		}, element );
 	 *
+	 * *Note*: Handles also normalized styles if defined. See {@link module:engine/view/stylesmap~StylesMap#set}.
+	 *
 	 * @param {String|Object} property Property name or object with key - value pairs.
 	 * @param {String} [value] Value to set. This parameter is ignored if object is provided as the first parameter.
 	 * @param {module:engine/view/element~Element} element Element to set styles on.
@@ -342,6 +344,8 @@ export default class DowncastWriter {
 	 *		writer.removeStyle( 'color', element );  // Removes 'color' style.
 	 *		writer.removeStyle( [ 'color', 'border-top' ], element ); // Removes both 'color' and 'border-top' styles.
 	 *
+	 * *Note*: Handles also normalized styles if defined. See {@link module:engine/view/stylesmap~StylesMap#remove}.
+	 *
 	 * @param {Array.<String>|String} property
 	 * @param {module:engine/view/element~Element} element
 	 */

+ 4 - 0
packages/ckeditor5-engine/src/view/element.js

@@ -732,6 +732,8 @@ export default class Element extends Node {
 	 *			position: 'fixed'
 	 *		} );
 	 *
+	 * *Note*: Handles also normalized styles if defined. See {@link module:engine/view/stylesmap~StylesMap#set}.
+	 *
 	 * @see module:engine/view/downcastwriter~DowncastWriter#setStyle
 	 * @protected
 	 * @param {String|Object} property Property name or object with key - value pairs.
@@ -750,6 +752,8 @@ export default class Element extends Node {
 	 *		element._removeStyle( 'color' );  // Removes 'color' style.
 	 *		element._removeStyle( [ 'color', 'border-top' ] ); // Removes both 'color' and 'border-top' styles.
 	 *
+	 * *Note*: Handles also normalized styles if defined. See {@link module:engine/view/stylesmap~StylesMap#remove}.
+	 *
 	 * @see module:engine/view/downcastwriter~DowncastWriter#removeStyle
 	 * @protected
 	 * @param {Array.<String>|String} property

+ 4 - 5
packages/ckeditor5-engine/src/view/stylesmap.js

@@ -96,7 +96,7 @@ export default class StylesMap {
 	 *		styles.has( 'margin-top' );     // returns false
 	 *		styles.has( 'margin-left' );    // returns true
 	 *
-	 * @param {String} name
+	 * @param {String} name Style name.
 	 * @returns {Boolean}
 	 */
 	has( name ) {
@@ -152,7 +152,6 @@ export default class StylesMap {
 	 *
 	 * @param {String|Object} nameOrObject Style property name or object with multiple properties.
 	 * @param {String} value Value to set.
-	 * @returns {Boolean}
 	 */
 	set( nameOrObject, value ) {
 		if ( isObject( nameOrObject ) ) {
@@ -185,7 +184,7 @@ export default class StylesMap {
 	 *
 	 *		styles.toString();   // returns 'margin-bottom:1px;margin-left:1px;'
 	 *
-	 * @param name
+	 * @param {String} name Style name.
 	 */
 	remove( name ) {
 		unset( this._styles, toPath( name ) );
@@ -193,7 +192,7 @@ export default class StylesMap {
 	}
 
 	/**
-	 * Returns a normalized style object or value.
+	 * Returns a normalized style object or a single value.
 	 *
 	 *		const styles = new Styles();
 	 *		styles.setTo( 'margin:1px 2px 3em;' );
@@ -211,7 +210,7 @@ export default class StylesMap {
 	 *
 	 * *Note*: This method will only return normalized styles if a style processor was defined.
 	 *
-	 * @param {String} name
+	 * @param {String} name Style name.
 	 * @returns {Object|String|undefined}
 	 */
 	getNormalized( name ) {

+ 4 - 0
packages/ckeditor5-engine/src/view/upcastwriter.js

@@ -270,6 +270,8 @@ export default class UpcastWriter {
 	 *			position: 'fixed'
 	 *		} );
 	 *
+	 * *Note*: Handles also normalized styles if defined. See {@link module:engine/view/stylesmap~StylesMap#set}.
+	 *
 	 * @see module:engine/view/element~Element#_setStyle
 	 * @param {String|Object} property Property name or object with key - value pairs.
 	 * @param {String} [value] Value to set. This parameter is ignored if object is provided as the first parameter.
@@ -288,6 +290,8 @@ export default class UpcastWriter {
 	 *		writer.removeStyle( element, 'color' );  // Removes 'color' style.
 	 *		writer.removeStyle( element, [ 'color', 'border-top' ] ); // Removes both 'color' and 'border-top' styles.
 	 *
+	 * *Note*: Handles also normalized styles if defined. See {@link module:engine/view/stylesmap~StylesMap#remove}.
+	 *
 	 * @see module:engine/view/element~Element#_removeStyle
 	 * @param {Array.<String>|String} property Style property name or names to be removed.
 	 * @param {module:engine/view/element~Element} element Element from which style will be removed.