mediawiki-extensions-Visual.../modules/ve/dm/models/ve.dm.MWTransclusionPartModel.js
Ed Sanders dcbea2328c Code style fix: @return -> @returns
Change-Id: I26daca6313bf09055af8f980ba0065782257fd54
2013-06-17 11:50:24 +01:00

59 lines
1.2 KiB
JavaScript

/*!
* VisualEditor DataModel MWTransclusionPartModel class.
*
* @copyright 2011-2013 VisualEditor Team and others; see AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
/**
* MediaWiki transclusion part model.
*
* @class
* @mixins ve.EventEmitter
*
* @constructor
* @param {ve.dm.MWTransclusionModel} transclusion Transclusion
*/
ve.dm.MWTransclusionPartModel = function VeDmMWTransclusionPartModel( transclusion ) {
// Mixin constructors
ve.EventEmitter.call( this );
// Properties
this.transclusion = transclusion;
this.id = 'part/' + this.transclusion.getUniquePartId();
};
/* Inheritance */
ve.mixinClass( ve.dm.MWTransclusionPartModel, ve.EventEmitter );
/* Methods */
/**
* Get transclusion part is in.
*
* @method
* @returns {ve.dm.MWTransclusionModel} Transclusion
*/
ve.dm.MWTransclusionPartModel.prototype.getTransclusion = function () {
return this.transclusion;
};
/**
* Get a unique part ID within the transclusion.
*
* @returns {string} Unique ID.
*/
ve.dm.MWTransclusionPartModel.prototype.getId = function () {
return this.id;
};
/**
* Remove part from transclusion.
*
* @method
*/
ve.dm.MWTransclusionPartModel.prototype.remove = function () {
this.transclusion.removePart( this );
};