瀏覽代碼

Make the API more consistent.

Piotr Jasiun 10 年之前
父節點
當前提交
b5b4987f8c

+ 10 - 6
packages/ckeditor5-engine/src/treeview/element.js

@@ -31,18 +31,22 @@ export default class Element extends Node {
 			this.insertChildren( 0, children );
 		}
 
-		this.domElement = null;
+		this._domElement = null;
 	}
 
-	setDomElement( domElement ) {
-		this.domElement = domElement;
+	bindDomElement( domElement ) {
+		this._domElement = domElement;
 
 		Element._domToViewMapping.set( domElement, this );
 	}
 
+	getCorespondingDom() {
+		return this._domElement;
+	}
+
 	// Note that created elements will not have coresponding DOM elements created it these did not exist before.
 	static createFromDom( domElement ) {
-		let viewElement = this.getCorespondingElement( domElement );
+		let viewElement = this.getCorespondingView( domElement );
 
 		if ( viewElement ) {
 			return viewElement;
@@ -67,7 +71,7 @@ export default class Element extends Node {
 	}
 
 	// Coresponding elements exists only for rendered elementes.
-	static getCorespondingElement( domElement ) {
+	static getCorespondingView( domElement ) {
 		return this._domToViewMapping.get( domElement );
 	}
 
@@ -130,7 +134,7 @@ export default class Element extends Node {
 		this._attrs.set( key, value );
 	}
 
-	cloneDOMAttrs( element ) {
+	cloneDomAttrs( element ) {
 		this.markToSync( 'ATTRIBUTES_NEED_UPDATE' );
 
 		for ( let i = element.attributes.length - 1; i >= 0; i-- ) {

+ 3 - 3
packages/ckeditor5-engine/src/treeview/observer/mutationobserver.js

@@ -55,7 +55,7 @@ export default class MutationObserver extends Observer {
 
 		for ( let mutation of domMutations ) {
 			if ( mutation.type === 'childList' ) {
-				const element = ViewElement.getCorespondingElement( mutation.target );
+				const element = ViewElement.getCorespondingView( mutation.target );
 
 				if ( element ) {
 					mutatedElements.add( element );
@@ -65,7 +65,7 @@ export default class MutationObserver extends Observer {
 
 		for ( let mutation of domMutations ) {
 			if ( mutation.type === 'characterData' ) {
-				const text = ViewText.getCorespondingText( mutation.target );
+				const text = ViewText.getCorespondingView( mutation.target );
 
 				if ( text && !mutatedElements.has( text.parent ) ) {
 					mutatedTexts.set( text, {
@@ -87,7 +87,7 @@ export default class MutationObserver extends Observer {
 		}
 
 		for ( let viewElement of mutatedElements ) {
-			const domElement = viewElement.domElement;
+			const domElement = viewElement.getCorespondingDom();
 			const domChildren = domElement.childNodes;
 			const viewChildren = viewElement.getChildren();
 			const newViewChildren = [];

+ 10 - 10
packages/ckeditor5-engine/src/treeview/renderer.js

@@ -22,12 +22,12 @@ export default class Renderer {
 
 	markToSync( node, type ) {
 		if ( type === 'TEXT_NEEDS_UPDATE' ) {
-			if ( node.parent.domElement ) {
+			if ( node.parent.getCorespondingDom() ) {
 				this.markedTexts.add( node );
 			}
 		} else {
 			// If the node has no DOM element it is not rendered yet, its children/attributes do not need to be marked to be sync.
-			if ( !node.domElement ) {
+			if ( !node.getCorespondingDom() ) {
 				return;
 			}
 
@@ -43,7 +43,7 @@ export default class Renderer {
 		const domDocument = this.domRoot.ownerDocument;
 
 		for ( let node of this.markedTexts ) {
-			if ( !this.markedChildren.has( node.parent ) && node.parent.domElement ) {
+			if ( !this.markedChildren.has( node.parent ) && node.parent.getCorespondingDom() ) {
 				updateText( node );
 			}
 		}
@@ -61,7 +61,7 @@ export default class Renderer {
 		this.markedChildren.clear();
 
 		function updateText( viewText ) {
-			const domText = viewText.getDomText();
+			const domText = viewText.getCorespondingDom();
 
 			if ( domText.data != viewText.getText() ) {
 				domText.data = viewText.getText();
@@ -69,7 +69,7 @@ export default class Renderer {
 		}
 
 		function updateAttrs( viewElement ) {
-			const domElement = viewElement.domElement;
+			const domElement = viewElement.getCorespondingDom();
 			const domAttrKeys = domElement.attributes;
 			const viewAttrKeys = viewElement.getAttrKeys();
 
@@ -87,7 +87,7 @@ export default class Renderer {
 		}
 
 		function updateChildren( viewElement ) {
-			const domElement = viewElement.domElement;
+			const domElement = viewElement.getCorespondingDom();
 			const domChildren = domElement.childNodes;
 			const viewChildren = Array.from( viewElement.getChildren() );
 
@@ -109,7 +109,7 @@ export default class Renderer {
 		function compareNodes( domNode, viewNode ) {
 			// Elements.
 			if ( domNode instanceof HTMLElement && viewNode instanceof ViewElement ) {
-				return domNode === viewNode.domElement;
+				return domNode === viewNode.getCorespondingDom();
 			}
 			// Texts.
 			else if ( domNode instanceof Text && viewNode instanceof ViewText ) {
@@ -121,15 +121,15 @@ export default class Renderer {
 		}
 
 		function viewToDom( view ) {
-			if ( view.domElement ) {
-				return view.domElement;
+			if ( view.getCorespondingDom() ) {
+				return view.getCorespondingDom();
 			}
 
 			if ( view instanceof ViewText ) {
 				return domDocument.createTextNode( view.getText() );
 			} else {
 				const domElement = domDocument.createElement( view.name );
-				view.setDomElement( domElement );
+				view.bindDomElement( domElement );
 
 				for ( let key of view.getAttrKeys() ) {
 					domElement.setAttribute( key, view.getAttr( key ) );

+ 2 - 2
packages/ckeditor5-engine/src/treeview/rootelement.js

@@ -13,10 +13,10 @@ import Element from './element.js';
  * @class treeView.RootElement
  */
 export default class RootElement extends Element {
-	constructor( TreeView, name ) {
+	constructor( treeView, name ) {
 		super( name );
 
-		this._treeView = TreeView;
+		this._treeView = treeView;
 	}
 
 	getTreeView() {

+ 8 - 8
packages/ckeditor5-engine/src/treeview/text.js

@@ -25,31 +25,31 @@ export default class Text extends Node {
 		this._text = text;
 	}
 
-	getDomText() {
+	getCorespondingDom() {
 		const previousSibling = this.getPreviousSibling();
 
-		if ( previousSibling && previousSibling.domElement ) {
-			return previousSibling.domElement.nextSibling;
+		if ( previousSibling && previousSibling.getCorespondingDom() ) {
+			return previousSibling.getCorespondingDom().nextSibling;
 		}
 
-		if ( !previousSibling && this.parent.domElement ) {
-			return this.parent.domElement.childNodes[ 0 ];
+		if ( !previousSibling && this.parent.getCorespondingDom() ) {
+			return this.parent.getCorespondingDom().childNodes[ 0 ];
 		}
 
 		return null;
 	}
 
-	static getCorespondingText( domText ) {
+	static getCorespondingView( domText ) {
 		const previousSibling = domText.previousSibling;
 
 		if ( previousSibling ) {
-			const viewElement = Element.getCorespondingElement( previousSibling );
+			const viewElement = Element.getCorespondingView( previousSibling );
 
 			if ( viewElement ) {
 				return viewElement.getNextSibling;
 			}
 		} else {
-			const viewElement = Element.getCorespondingElement( domText.parentElement );
+			const viewElement = Element.getCorespondingView( domText.parentElement );
 
 			if ( viewElement ) {
 				return viewElement.getChild( 0 );

+ 2 - 2
packages/ckeditor5-engine/src/treeview/treeview.js

@@ -25,8 +25,8 @@ export default class TreeView {
 		 * Root of the view
 		 */
 		this.viewRoot = new RootElement( this, domElement.name );
-		this.viewRoot.cloneDOMAttrs( domElement );
-		this.viewRoot.setDomElement( domElement );
+		this.viewRoot.cloneDomAttrs( domElement );
+		this.viewRoot.bindDomElement( domElement );
 		this.viewRoot.markToSync( 'CHILDREN_NEED_UPDATE' );
 	}