浏览代码

Renamed utils functions: widgetize to toWidget and createNestedEditable to toWidgetEditable.

Szymon Kupś 8 年之前
父节点
当前提交
621a358363

+ 3 - 3
packages/ckeditor5-image/src/image/utils.js

@@ -7,7 +7,7 @@
  * @module image/image/utils
  */
 
-import { widgetize, isWidget } from '../widget/utils';
+import { toWidget, isWidget } from '../widget/utils';
 import ModelElement from '@ckeditor/ckeditor5-engine/src/model/element';
 
 const imageSymbol = Symbol( 'isImage' );
@@ -15,7 +15,7 @@ const imageSymbol = Symbol( 'isImage' );
 /**
  * Converts given {@link module:engine/view/element~Element} to image widget:
  * * adds {@link module:engine/view/element~Element#setCustomProperty custom property} allowing to recognize image widget element,
- * * calls {@link module:image/widget/utils~widgetize widgetize} function with proper element's label creator.
+ * * calls {@link module:image/widget/utils~toWidget toWidget} function with proper element's label creator.
  *
  * @param {module:engine/view/element~Element} viewElement
  * @param {String} label Element's label. It will be concatenated with image's `alt` attribute if one is present.
@@ -24,7 +24,7 @@ const imageSymbol = Symbol( 'isImage' );
 export function toImageWidget( viewElement, label ) {
 	viewElement.setCustomProperty( imageSymbol, true );
 
-	return widgetize( viewElement, { label: labelCreator } );
+	return toWidget( viewElement, { label: labelCreator } );
 
 	function labelCreator() {
 		const imgElement = viewElement.getChild( 0 );

+ 2 - 2
packages/ckeditor5-image/src/imagecaption/utils.js

@@ -8,7 +8,7 @@
  */
 
 import ModelElement from '@ckeditor/ckeditor5-engine/src/model/element';
-import { createNestedEditable } from '../widget/utils';
+import { toWidgetEditable } from '../widget/utils';
 
 const captionSymbol = Symbol( 'imageCaption' );
 
@@ -20,7 +20,7 @@ const captionSymbol = Symbol( 'imageCaption' );
  */
 export function captionElementCreator( viewDocument ) {
 	return () => {
-		const editable = createNestedEditable( 'figcaption', viewDocument );
+		const editable = toWidgetEditable( 'figcaption', viewDocument );
 		editable.setCustomProperty( captionSymbol, true );
 
 		return editable;

+ 3 - 3
packages/ckeditor5-image/src/widget/utils.js

@@ -44,7 +44,7 @@ export function isWidget( element ) {
 }
 
 /**
- * "Widgetizes" given {@link module:engine/view/element~Element}:
+ * Converts given {@link module:engine/view/element~Element} to widget in following way:
  * * sets `contenteditable` attribute to `true`,
  * * adds custom `getFillerOffset` method returning `null`,
  * * adds `ck-widget` CSS class,
@@ -56,7 +56,7 @@ export function isWidget( element ) {
  * a plain string or a function returning a string.
  * @returns {module:engine/view/element~Element} Returns same element.
  */
-export function widgetize( element, options ) {
+export function toWidget( element, options ) {
 	options = options || {};
 	element.setAttribute( 'contenteditable', false );
 	element.getFillerOffset = getFillerOffset;
@@ -105,7 +105,7 @@ export function getLabel( element ) {
  * @param {module:engine/view/document~Document} viewDocument
  * @returns {module:engine/view/editableelement~EditableElement}
  */
-export function createNestedEditable( elementName, viewDocument ) {
+export function toWidgetEditable( elementName, viewDocument ) {
 	const editable = new ViewEditableElement( elementName, { contenteditable: true } );
 	editable.addClass( NESTED_EDITABLE_CLASS_NAME );
 	editable.document = viewDocument;

+ 8 - 8
packages/ckeditor5-image/tests/widget/utils.js

@@ -6,11 +6,11 @@
 import ViewElement from '@ckeditor/ckeditor5-engine/src/view/element';
 import ViewDocument from '@ckeditor/ckeditor5-engine/src/view/document';
 import {
-	widgetize,
+	toWidget,
 	isWidget,
 	setLabel,
 	getLabel,
-	createNestedEditable,
+	toWidgetEditable,
 	WIDGET_CLASS_NAME,
 	NESTED_EDITABLE_CLASS_NAME
 } from '../../src/widget/utils';
@@ -20,10 +20,10 @@ describe( 'widget utils', () => {
 
 	beforeEach( () => {
 		element = new ViewElement( 'div' );
-		widgetize( element );
+		toWidget( element );
 	} );
 
-	describe( 'widgetize()', () => {
+	describe( 'toWidget()', () => {
 		it( 'should set contenteditable to false', () => {
 			expect( element.getAttribute( 'contenteditable' ) ).to.be.false;
 		} );
@@ -39,14 +39,14 @@ describe( 'widget utils', () => {
 
 		it( 'should add element\'s label if one is provided', () => {
 			element = new ViewElement( 'div' );
-			widgetize( element, { label: 'foo bar baz label' } );
+			toWidget( element, { label: 'foo bar baz label' } );
 
 			expect( getLabel( element ) ).to.equal( 'foo bar baz label' );
 		} );
 
 		it( 'should add element\'s label if one is provided as function', () => {
 			element = new ViewElement( 'div' );
-			widgetize( element, { label: () => 'foo bar baz label' } );
+			toWidget( element, { label: () => 'foo bar baz label' } );
 
 			expect( getLabel( element ) ).to.equal( 'foo bar baz label' );
 		} );
@@ -87,12 +87,12 @@ describe( 'widget utils', () => {
 		} );
 	} );
 
-	describe( 'createNestedEditable', () => {
+	describe( 'toWidgetEditable', () => {
 		let viewDocument, element;
 
 		beforeEach( () => {
 			viewDocument = new ViewDocument();
-			element = createNestedEditable( 'div', viewDocument );
+			element = toWidgetEditable( 'div', viewDocument );
 		} );
 
 		it( 'should be created in context of proper document', () => {

+ 2 - 2
packages/ckeditor5-image/tests/widget/widget.js

@@ -7,7 +7,7 @@ import VirtualTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/virtualtest
 import Widget from '../../src/widget/widget';
 import MouseObserver from '@ckeditor/ckeditor5-engine/src/view/observer/mouseobserver';
 import buildModelConverter from '@ckeditor/ckeditor5-engine/src/conversion/buildmodelconverter';
-import { widgetize } from '../../src/widget/utils';
+import { toWidget } from '../../src/widget/utils';
 import ViewContainer from '@ckeditor/ckeditor5-engine/src/view/containerelement';
 import ViewEditable from '@ckeditor/ckeditor5-engine/src/view/editableelement';
 import DomEventData from '@ckeditor/ckeditor5-engine/src/view/observer/domeventdata';
@@ -48,7 +48,7 @@ describe( 'Widget', () => {
 						const b = new AttributeContainer( 'b' );
 						const div = new ViewContainer( 'div', null, b );
 
-						return widgetize( div );
+						return toWidget( div );
 					} );
 
 				buildModelConverter().for( editor.editing.modelToView )

+ 2 - 2
packages/ckeditor5-image/tests/widget/widgetengine.js

@@ -10,7 +10,7 @@ import { setData as setModelData } from '@ckeditor/ckeditor5-engine/src/dev-util
 import { getData as getViewData } from '@ckeditor/ckeditor5-engine/src/dev-utils/view';
 import ViewContainer from '@ckeditor/ckeditor5-engine/src/view/containerelement';
 import ViewEditable from '@ckeditor/ckeditor5-engine/src/view/editableelement';
-import { widgetize } from '../../src/widget/utils';
+import { toWidget } from '../../src/widget/utils';
 
 describe( 'WidgetEngine', () => {
 	let editor, document, viewDocument;
@@ -32,7 +32,7 @@ describe( 'WidgetEngine', () => {
 				buildModelConverter().for( editor.editing.modelToView )
 					.fromElement( 'widget' )
 					.toElement( () => {
-						const element = widgetize( new ViewContainer( 'div' ), { label: 'element label' } );
+						const element = toWidget( new ViewContainer( 'div' ), { label: 'element label' } );
 
 						return element;
 					} );