mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor
synced 2024-09-27 20:26:46 +00:00
0b55bb8cdc
ve.dm.Model is now the common base class for these three. ve.dm.Node inherited from ve.Node before, so it now uses it as a mixin instead. This required changing ve.Node's usage of ve.EventEmitter from inhertiance to a mixin as well, because inherited methods apparently don't get mixed in correctly. * Change annotation terminology from linmodAnnotation to element for consistency with Node, MetaItem and Model * Reimplement getClonedElement() in Node for .internal treatment Change-Id: Ifd3922af23557c0b0f8984d36b31c8a1e2ec497e
140 lines
3.3 KiB
JavaScript
140 lines
3.3 KiB
JavaScript
/*!
|
|
* VisualEditor DataModel MetaItem class.
|
|
*
|
|
* @copyright 2011-2013 VisualEditor Team and others; see AUTHORS.txt
|
|
* @license The MIT License (MIT); see LICENSE.txt
|
|
*/
|
|
|
|
/**
|
|
* DataModel meta item.
|
|
*
|
|
* @class
|
|
* @abstract
|
|
* @extends ve.dm.Model
|
|
* @constructor
|
|
* @param {Object} element Reference to element in meta-linmod
|
|
*/
|
|
ve.dm.MetaItem = function VeDmMetaItem( element ) {
|
|
// Parent constructor
|
|
ve.dm.Model.call( this, element );
|
|
// Mixin
|
|
ve.EventEmitter.call( this );
|
|
|
|
// Properties
|
|
this.list = null;
|
|
this.offset = null;
|
|
this.index = null;
|
|
};
|
|
|
|
/* Inheritance */
|
|
|
|
ve.inheritClass( ve.dm.MetaItem, ve.dm.Model );
|
|
|
|
ve.mixinClass( ve.dm.MetaItem, ve.EventEmitter );
|
|
|
|
/* Static members */
|
|
|
|
/**
|
|
* Symbolic name for the group this meta item type will be grouped in in ve.dm.MetaList.
|
|
*
|
|
* @static
|
|
* @property {string} [static.group='misc']
|
|
* @inheritable
|
|
*/
|
|
ve.dm.MetaItem.static.group = 'misc';
|
|
|
|
/* Methods */
|
|
|
|
/**
|
|
* Remove this item from the document. Only works if the item is attached to a MetaList.
|
|
* @throws {Error} Cannot remove detached item
|
|
*/
|
|
ve.dm.MetaItem.prototype.remove = function () {
|
|
if ( !this.list ) {
|
|
throw new Error( 'Cannot remove detached item' );
|
|
}
|
|
this.list.removeMeta( this );
|
|
};
|
|
|
|
/**
|
|
* Get the group this meta item belongs to.
|
|
* @see ve.dm.MetaItem#static.group
|
|
* @returns {string} Group
|
|
*/
|
|
ve.dm.MetaItem.prototype.getGroup = function () {
|
|
return this.constructor.static.group;
|
|
};
|
|
|
|
/**
|
|
* Get the MetaList this item is attached to.
|
|
* @returns {ve.dm.MetaList|null} Reference to the parent list, or null if not attached
|
|
*/
|
|
ve.dm.MetaItem.prototype.getParentList = function () {
|
|
return this.list;
|
|
};
|
|
|
|
/**
|
|
* Get this item's offset in the linear model.
|
|
*
|
|
* This is only known if the item is attached to a MetaList.
|
|
*
|
|
* @returns {number|null} Offset, or null if not attached
|
|
*/
|
|
ve.dm.MetaItem.prototype.getOffset = function () {
|
|
return this.offset;
|
|
};
|
|
|
|
/**
|
|
* Get this item's index in the metadata array at the offset.
|
|
*
|
|
* This is only known if the item is attached to a MetaList.
|
|
*
|
|
* @returns {number|null} Index, or null if not attached
|
|
*/
|
|
ve.dm.MetaItem.prototype.getIndex = function () {
|
|
return this.index;
|
|
};
|
|
|
|
/**
|
|
* Set the offset. This is used by the parent list to synchronize the item with the document state.
|
|
* @param {number} offset New offset
|
|
*/
|
|
ve.dm.MetaItem.prototype.setOffset = function ( offset ) {
|
|
this.offset = offset;
|
|
};
|
|
|
|
/**
|
|
* Set the index. This is used by the parent list to synchronize the item with the document state.
|
|
* @param {number} index New index
|
|
*/
|
|
ve.dm.MetaItem.prototype.setIndex = function ( index ) {
|
|
this.index = index;
|
|
};
|
|
|
|
/**
|
|
* Attach this item to a MetaList.
|
|
* @param {ve.dm.MetaList} list Parent list to attach to
|
|
* @param {number} offset Offset of this item in the parent list's document
|
|
* @param {number} index Index of this item in the metadata array at the offset
|
|
*/
|
|
ve.dm.MetaItem.prototype.attach = function ( list, offset, index ) {
|
|
this.list = list;
|
|
this.offset = offset;
|
|
this.index = index;
|
|
};
|
|
|
|
/**
|
|
* Detach this item from its parent list.
|
|
*
|
|
* This clears the stored offset and index, unless the item has already been attached to another list.
|
|
*
|
|
* @param {ve.dm.MetaList} list List to detach from
|
|
*/
|
|
ve.dm.MetaItem.prototype.detach = function ( list ) {
|
|
if ( this.list === list ) {
|
|
this.list = null;
|
|
this.offset = null;
|
|
this.index = null;
|
|
}
|
|
};
|