| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375 |
- /**
- * @license Copyright (c) 2003-2015, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md.
- */
- 'use strict';
- import ViewText from './text.js';
- import ViewElement from './element.js';
- import ViewDocumentFragment from './documentfragment.js';
- /**
- * DomConverter is a set of tools to do transformations between DOM nodes and view nodes. It also handles
- * {@link engine.treeView.DomConverter#bindElements binding} these nodes.
- *
- * DomConverter does not check which nodes should be rendered (use {@link engine.treeView.Renderer}), does not keep a
- * state of a tree nor keeps synchronization between tree view and DOM tree (use {@link engine.treeView.TreeView}).
- *
- * DomConverter keeps DOM elements to View element bindings, so when the converter will be destroyed, the binding will
- * be lost. Two converters will keep separate binding maps, so one tree view can be bound with two DOM trees.
- *
- * @memberOf engine.treeView
- */
- export default class DomConverter {
- /**
- * Creates DOM converter.
- */
- constructor() {
- // Using WeakMap prevent memory leaks: when the converter will be destroyed all referenced between View and DOM
- // will be removed. Also because it is a *Weak*Map when both view and DOM elements will be removed referenced
- // will be also removed, isn't it brilliant?
- //
- // Yes, PJ. It is.
- //
- // You guys so smart.
- /**
- * DOM to View mapping.
- *
- * @private
- * @member {WeakMap} engine.treeView.DomConverter#_domToViewMapping
- */
- this._domToViewMapping = new WeakMap();
- /**
- * View to DOM mapping.
- *
- * @private
- * @member {WeakMap} engine.treeView.DomConverter#_viewToDomMapping
- */
- this._viewToDomMapping = new WeakMap();
- }
- /**
- * Binds DOM and View elements, so it will be possible to get corresponding elements using
- * {@link engine.treeView.DomConverter#getCorrespondingViewElement getCorrespondingViewElement} and
- * {@link engine.treeView.DomConverter#getCorrespondingDomElement getCorrespondingDomElement}.
- *
- * @param {HTMLElement} domElement DOM element to bind.
- * @param {engine.treeView.Element} viewElement View element to bind.
- */
- bindElements( domElement, viewElement ) {
- this._domToViewMapping.set( domElement, viewElement );
- this._viewToDomMapping.set( viewElement, domElement );
- }
- /**
- * Binds DOM and View document fragments, so it will be possible to get corresponding document fragments using
- * {@link engine.treeView.DomConverter#getCorrespondingViewDocumentFragment getCorrespondingViewDocumentFragment} and
- * {@link engine.treeView.DomConverter#getCorrespondingDomDocumentFragment getCorrespondingDomDocumentFragment}.
- *
- * @param {DocumentFragment} domFragment DOM document fragment to bind.
- * @param {engine.treeView.DocumentFragment} viewFragment View document fragment to bind.
- */
- bindDocumentFragments( domFragment, viewFragment ) {
- this._domToViewMapping.set( domFragment, viewFragment );
- this._viewToDomMapping.set( viewFragment, domFragment );
- }
- /**
- * Compares DOM and View nodes. Elements are same when they are bound. Text nodes are same when they have the same
- * text data. Nodes need to have corresponding types. In all other cases nodes are different.
- *
- * @param {Node} domNode DOM node to compare.
- * @param {engine.treeView.Node} viewNode View node to compare.
- * @returns {Boolean} True if nodes are same.
- */
- compareNodes( domNode, viewNode ) {
- // Elements.
- if ( domNode instanceof HTMLElement && viewNode instanceof ViewElement ) {
- return domNode === this.getCorrespondingDomElement( viewNode );
- }
- // Texts.
- else if ( domNode instanceof Text && viewNode instanceof ViewText ) {
- return domNode.data === viewNode.data;
- }
- // Not matching types.
- return false;
- }
- /**
- * Converts view to DOM. For all text nodes, not bound elements and document fragments new items will
- * be created. For bound elements and document fragments function will return corresponding items.
- *
- * @param {engine.treeView.Node|engine.treeView.DocumentFragment} viewNode View node or document fragment to transform.
- * @param {document} domDocument Document which will be used to create DOM nodes.
- * @param {Object} [options] Conversion options.
- * @param {Boolean} [options.bind=false] Determines whether new elements will be bound.
- * @param {Boolean} [options.withChildren=true] If true node's and document fragment's children will be converted too.
- * @returns {Node|DocumentFragment} Converted node or DocumentFragment.
- */
- viewToDom( viewNode, domDocument, options ) {
- if ( !options ) {
- options = {};
- }
- if ( viewNode instanceof ViewText ) {
- return domDocument.createTextNode( viewNode.data );
- } else {
- if ( this.getCorrespondingDom( viewNode ) ) {
- return this.getCorrespondingDom( viewNode );
- }
- let domElement;
- if ( viewNode instanceof ViewDocumentFragment ) {
- // Create DOM document fragment.
- domElement = domDocument.createDocumentFragment();
- if ( options.bind ) {
- this.bindDocumentFragments( domElement, viewNode );
- }
- } else {
- // Create DOM element.
- domElement = domDocument.createElement( viewNode.name );
- if ( options.bind ) {
- this.bindElements( domElement, viewNode );
- }
- // Copy element's attributes.
- for ( let key of viewNode.getAttributeKeys() ) {
- domElement.setAttribute( key, viewNode.getAttribute( key ) );
- }
- }
- if ( options.withChildren || options.withChildren === undefined ) {
- for ( let childView of viewNode.getChildren() ) {
- domElement.appendChild( this.viewToDom( childView, domDocument, options ) );
- }
- }
- return domElement;
- }
- }
- /**
- * Converts DOM to view. For all text nodes, not bound elements and document fragments new items will
- * be created. For bound elements and document fragments function will return corresponding items.
- *
- * @param {Node|DocumentFragment} domNode DOM node or document fragment to transform.
- * @param {Object} [options] Conversion options.
- * @param {Boolean} [options.bind=false] Determines whether new elements will be bound.
- * @param {Boolean} [options.withChildren=true] It true node's and document fragment's children will be converted too.
- * @returns {engine.treeView.Node|engine.treeView.DocumentFragment} Converted node or document fragment.
- */
- domToView( domNode, options ) {
- if ( !options ) {
- options = {};
- }
- if ( domNode instanceof Text ) {
- return new ViewText( domNode.data );
- } else {
- if ( this.getCorrespondingView( domNode ) ) {
- return this.getCorrespondingView( domNode );
- }
- let viewElement;
- if ( domNode instanceof DocumentFragment ) {
- // Create view document fragment.
- viewElement = new ViewDocumentFragment();
- if ( options.bind ) {
- this.bindDocumentFragments( domNode, viewElement );
- }
- } else {
- // Create view element.
- viewElement = new ViewElement( domNode.tagName.toLowerCase() );
- if ( options.bind ) {
- this.bindElements( domNode, viewElement );
- }
- // Copy element's attributes.
- const attrs = domNode.attributes;
- for ( let i = attrs.length - 1; i >= 0; i-- ) {
- viewElement.setAttribute( attrs[ i ].name, attrs[ i ].value );
- }
- }
- if ( options.withChildren || options.withChildren === undefined ) {
- for ( let i = 0, len = domNode.childNodes.length; i < len; i++ ) {
- let domChild = domNode.childNodes[ i ];
- viewElement.appendChildren( this.domToView( domChild, options ) );
- }
- }
- return viewElement;
- }
- }
- /**
- * Gets corresponding view item. This function use
- * {@link engine.treeView.DomConverter#getCorrespondingViewElement getCorrespondingViewElement}
- * for elements, {@link engine.treeView.DomConverter#getCorrespondingViewText getCorrespondingViewText} for text
- * nodes and {@link engine.treeView.DomConverter#getCorrespondingViewDocumentFragment getCorrespondingViewDocumentFragment}
- * for document fragments.
- *
- * @param {Node|DocumentFragment} domNode DOM node or document fragment.
- * @returns {engine.treeView.Node|engine.treeView.DocumentFragment|null} Corresponding view item.
- */
- getCorrespondingView( domNode ) {
- if ( domNode instanceof HTMLElement ) {
- return this.getCorrespondingViewElement( domNode );
- } else if ( domNode instanceof DocumentFragment ) {
- return this.getCorrespondingViewDocumentFragment( domNode );
- } else {
- return this.getCorrespondingViewText( domNode );
- }
- }
- /**
- * Gets corresponding view element. Returns element if an view element was
- * {@link engine.treeView.DomConverter#bindElements bound} to the given DOM element or null otherwise.
- *
- * @param {HTMLElement} domElement DOM element.
- * @returns {engine.treeView.Element|null} Corresponding element or null if no element was bound.
- */
- getCorrespondingViewElement( domElement ) {
- return this._domToViewMapping.get( domElement );
- }
- /**
- * Gets corresponding view document fragment. Returns document fragment if an view element was
- * {@link engine.treeView.DomConverter#bindDocumentFragments bound} to the given DOM fragment or null otherwise.
- *
- * @param {DocumentFragment} domFragment DOM element.
- * @returns {engine.treeView.DocumentFragment|null} Corresponding document fragment or null if none element was bound.
- */
- getCorrespondingViewDocumentFragment( domFragment ) {
- return this._domToViewMapping.get( domFragment );
- }
- /**
- * Gets corresponding text node. Text nodes are not {@link engine.treeView.DomConverter#bindElements bound},
- * corresponding text node is returned based on the sibling or parent.
- *
- * If the directly previous sibling is a {@link engine.treeView.DomConverter#bindElements bound} element, it is used
- * to find the corresponding text node.
- *
- * If this is a first child in the parent and the parent is a {@link engine.treeView.DomConverter#bindElements bound}
- * element, it is used to find the corresponding text node.
- *
- * Otherwise `null` is returned.
- *
- * @param {Text} domText DOM text node.
- * @returns {engine.treeView.Text|null} Corresponding view text node or null, if it was not possible to find a
- * corresponding node.
- */
- getCorrespondingViewText( domText ) {
- const previousSibling = domText.previousSibling;
- // Try to use previous sibling to find the corresponding text node.
- if ( previousSibling ) {
- if ( !( previousSibling instanceof HTMLElement ) ) {
- // The previous is text or comment.
- return null;
- }
- const viewElement = this.getCorrespondingViewElement( previousSibling );
- if ( viewElement ) {
- return viewElement.getNextSibling();
- }
- }
- // Try to use parent to find the corresponding text node.
- else {
- const viewElement = this.getCorrespondingViewElement( domText.parentElement );
- if ( viewElement ) {
- return viewElement.getChild( 0 );
- }
- }
- return null;
- }
- /**
- * Gets corresponding DOM item. This function uses
- * {@link engine.treeView.DomConverter#getCorrespondingDomElement getCorrespondingDomElement} for
- * elements, {@link engine.treeView.DomConverter#getCorrespondingDomText getCorrespondingDomText} for text nodes
- * and {@link engine.treeView.DomConverter#getCorrespondingDomDocumentFragment getCorrespondingDomDocumentFragment}
- * for document fragments.
- *
- * @param {engine.treeView.Node|engine.treeView.DomFragment} viewNode View node or document fragment.
- * @returns {Node|DocumentFragment|null} Corresponding DOM node or document fragment.
- */
- getCorrespondingDom( viewNode ) {
- if ( viewNode instanceof ViewElement ) {
- return this.getCorrespondingDomElement( viewNode );
- } else if ( viewNode instanceof ViewDocumentFragment ) {
- return this.getCorrespondingDomDocumentFragment( viewNode );
- } else {
- return this.getCorrespondingDomText( viewNode );
- }
- }
- /**
- * Gets corresponding DOM element. Returns element if an DOM element was
- * {@link engine.treeView.DomConverter#bindElements bound} to the given view element or null otherwise.
- *
- * @param {engine.treeView.Element} viewElement View element.
- * @returns {HTMLElement|null} Corresponding element or null if none element was bound.
- */
- getCorrespondingDomElement( viewElement ) {
- return this._viewToDomMapping.get( viewElement );
- }
- /**
- * Gets corresponding DOM document fragment. Returns document fragment if an DOM element was
- * {@link engine.treeView.DomConverter#bindDocumentFragments bound} to the given view document fragment or null otherwise.
- *
- * @param {engine.treeView.DocumentFragment} viewDocumentFragment View document fragment.
- * @returns {DocumentFragment|null} Corresponding document fragment or null if no fragment was bound.
- */
- getCorrespondingDomDocumentFragment( viewDocumentFragment ) {
- return this._viewToDomMapping.get( viewDocumentFragment );
- }
- /**
- * Gets corresponding text node. Text nodes are not {@link engine.treeView.DomConverter#bindElements bound},
- * corresponding text node is returned based on the sibling or parent.
- *
- * If the directly previous sibling is a {@link engine.treeView.DomConverter#bindElements bound} element, it is used
- * to find the corresponding text node.
- *
- * If this is a first child in the parent and the parent is a {@link engine.treeView.DomConverter#bindElements bound}
- * element, it is used to find the corresponding text node.
- *
- * Otherwise null is returned.
- *
- * @param {engine.treeView.Text} viewText View text node.
- * @returns {Text|null} Corresponding DOM text node or null, if it was not possible to find a corresponding node.
- */
- getCorrespondingDomText( viewText ) {
- const previousSibling = viewText.getPreviousSibling();
- // Try to use previous sibling to find the corresponding text node.
- if ( previousSibling && this.getCorrespondingDom( previousSibling ) ) {
- return this.getCorrespondingDom( previousSibling ).nextSibling;
- }
- // Try to use parent to find the corresponding text node.
- if ( !previousSibling && this.getCorrespondingDom( viewText.parent ) ) {
- return this.getCorrespondingDom( viewText.parent ).childNodes[ 0 ];
- }
- return null;
- }
- }
|