mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor
synced 2024-11-30 00:55:00 +00:00
4854d644ee
Us grouping the inheritable static properties that way is an
implementation detail that is polluting the index and makes
it harder to refer to individual identifiers.
It also causes problems under JSDuck 5 because that version is
more strict about defining properties (Foo.static.bar) of which
the parent is not defined in the index (Foo.static), we'd have
to add a sea of `@static @property {Object} this.static` all
over the place. Might as well hide this implementation detail
and just consider them static properties (just like we already
do for "private" properties).
Change-Id: Ibf2ebf7752aabc2b75b6ac6fa00e2284a181a600
167 lines
3.9 KiB
JavaScript
167 lines
3.9 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
|
|
* @mixins OO.EventEmitter
|
|
*
|
|
* @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
|
|
OO.EventEmitter.call( this );
|
|
|
|
// Properties
|
|
this.list = null;
|
|
this.offset = null;
|
|
this.index = null;
|
|
this.move = null;
|
|
};
|
|
|
|
/* Inheritance */
|
|
|
|
OO.inheritClass( ve.dm.MetaItem, ve.dm.Model );
|
|
|
|
OO.mixinClass( ve.dm.MetaItem, OO.EventEmitter );
|
|
|
|
/* Static members */
|
|
|
|
/**
|
|
* Symbolic name for the group this meta item type will be grouped in in ve.dm.MetaList.
|
|
*
|
|
* @static
|
|
* @property
|
|
* @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 );
|
|
};
|
|
|
|
/**
|
|
* Replace item with another in-place.
|
|
*
|
|
* Pass a plain object rather than a MetaItem into this function unless you know what you're doing.
|
|
*
|
|
* @param {Object|ve.dm.MetaItem} item Item to replace this item with
|
|
*/
|
|
ve.dm.MetaItem.prototype.replaceWith = function ( item ) {
|
|
var offset = this.getOffset(),
|
|
index = this.getIndex(),
|
|
list = this.list;
|
|
|
|
list.removeMeta( this );
|
|
list.insertMeta( item, offset, index );
|
|
};
|
|
|
|
/**
|
|
* Get the group this meta item belongs to.
|
|
* @see #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;
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Check whether this item is attached to a MetaList.
|
|
* @returns {boolean} Whether item is attached
|
|
*/
|
|
ve.dm.MetaItem.prototype.isAttached = function () {
|
|
return this.list !== null;
|
|
};
|