/*! * VisualEditor DataModel InternalList class. * * @copyright 2011-2013 VisualEditor Team and others; see AUTHORS.txt * @license The MIT License (MIT); see LICENSE.txt */ /** * DataModel meta item. * * @class * @mixins ve.EventEmitter * * @constructor * @param {ve.dm.Document} doc Document model */ ve.dm.InternalList = function VeDmInternalList( doc ) { // Mixin constructors ve.EventEmitter.call( this ); // Properties this.document = doc; this.store = new ve.dm.IndexValueStore(); this.itemsHtml = []; this.listNode = null; // Event handlers //this.document.connect( this, { 'transact', 'onTransact' } ); }; /* Inheritance */ ve.mixinClass( ve.dm.InternalList, ve.EventEmitter ); /* Methods */ /** * Queues up an item's html for parsing later. * * If an item with the specified key already exists it will be ignored. * * @method * @param {string} key Item key * @param {string} html Item contents * @returns {number} Index of the item in the index-value store, and also the list */ ve.dm.InternalList.prototype.queueItemHtml = function ( key, html ) { var index = this.getStore().indexOfHash( key ); if ( index === null ) { index = this.getStore().index( html, key ); this.itemsHtml.push( index ); } return index; }; /** * Gets all the item's HTML strings * @method * @returns {Object} Name-indexed object containing HTMLElements */ ve.dm.InternalList.prototype.getItemsHtml = function () { return this.getStore().values( this.itemsHtml ); }; /** * Gets the internal list's document model * @method * @returns {ve.dm.Document} Document model */ ve.dm.InternalList.prototype.getDocument = function () { return this.document; }; /** * Gets the internal list's index value store * @method * @returns {ve.dm.IndexValueStore} Index value store */ ve.dm.InternalList.prototype.getStore = function () { return this.store; }; /** * Get the list node * @method * @returns {ve.dm.InternalListNode} List node */ ve.dm.InternalList.prototype.getListNode = function () { var i, nodes; // find listNode if not set, or unattached if ( !this.listNode || !this.listNode.doc ) { nodes = this.getDocument().documentNode.children; for ( i = nodes.length; i >= 0; i-- ) { if ( nodes[i] instanceof ve.dm.InternalListNode ) { this.listNode = nodes[i]; break; } } } return this.listNode; }; /** * Get the item node from a specific index * @method * @param {number} index Item's index * @returns {ve.dm.InternalItemNode} Item node */ ve.dm.InternalList.prototype.getItemNode = function ( index ) { return this.getListNode().children[index]; }; /** * Converts stored item HTML into linear data. * * Each item is an InternalItem, and they are wrapped in an InternalList. * If there are no items an empty array is returned. * * Stored HTML is deleted after conversion. * * @method * @param {ve.dm.Converter} converter Converter object * @returns {Array} Linear model data */ ve.dm.InternalList.prototype.convertToData = function ( converter ) { var i, length, itemData, itemsHtml = this.getItemsHtml(), list = []; if ( itemsHtml.length ) { list.push( { 'type': 'internalList' } ); for ( i = 0, length = itemsHtml.length; i < length; i++ ) { itemData = converter.getDataFromDomRecursion( $( '
' ).html( itemsHtml[i] )[0] ); list = list.concat( [{ 'type': 'internalItem' }], itemData, [{ 'type': '/internalItem' }] ); } list.push( { 'type': '/internalList' } ); } // After conversion we no longer need the HTML this.itemsHtml = []; return list; }; /** * Clone this internal list. * * @param {ve.dm.Document} [doc] The new list's document. Defaults to this list's document. * @returns {ve.dm.InternalList} Clone of this internal */ ve.dm.InternalList.prototype.clone = function ( doc ) { var clone = new this.constructor( doc || this.getDocument() ); clone.store = this.getStore().clone(); return clone; }; /** * Merge another document's internal list into this one. * * Objects that are in other but not in this are added to this, possibly with a different index. * * @param {ve.dm.InternalList} other List to merge into this one * @returns {Object} Object in which the keys are indexes in other and the values are the corresponding keys in this */ ve.dm.InternalList.prototype.merge = function ( other ) { var i, len, index, storeMapping = this.getStore().merge( other.getStore() ), mapping = {}; for ( i = 0, len = other.itemsHtml.length; i < len; i++ ) { other.itemsHtml[i] = storeMapping[other.itemsHtml[i]]; index = ve.indexOf( other.itemsHtml[i], this.itemsHtml ); if ( index === -1 ) { index = this.itemsHtml.push( other.itemsHtml[i] ) - 1; } mapping[i] = index; } return mapping; };