mediawiki-extensions-Cite/modules/ve-cite/ve.ui.MWReferencesListContextItem.js
Ed Sanders b2fd0aa4d1 Fix ContextItem documentation
* Be more specific about the type of context which a
  context item belongs to.
* Make grammar clearer.

Change-Id: I9bcc129766c3386582def0f346d6f175e54d6ff6
2023-07-10 14:33:24 +01:00

78 lines
2.1 KiB
JavaScript

/*!
* VisualEditor MWReferencesListContextItem class.
*
* @copyright 2011-2018 VisualEditor Team's Cite sub-team and others; see AUTHORS.txt
* @license MIT
*/
/**
* Context item for a MWReferencesList.
*
* @class
* @extends ve.ui.LinearContextItem
*
* @constructor
* @param {ve.ui.LinearContext} context Context the item is in
* @param {ve.dm.Model} model Model the item is related to
* @param {Object} [config]
*/
ve.ui.MWReferencesListContextItem = function VeUiMWReferencesListContextItem() {
// Parent constructor
ve.ui.MWReferencesListContextItem.super.apply( this, arguments );
// Initialization
this.$element.addClass( 've-ui-mwReferencesListContextItem' );
};
/* Inheritance */
OO.inheritClass( ve.ui.MWReferencesListContextItem, ve.ui.LinearContextItem );
/* Static Properties */
ve.ui.MWReferencesListContextItem.static.name = 'referencesList';
ve.ui.MWReferencesListContextItem.static.icon = 'references';
ve.ui.MWReferencesListContextItem.static.label =
OO.ui.deferMsg( 'cite-ve-dialogbutton-referenceslist-tooltip' );
ve.ui.MWReferencesListContextItem.static.modelClasses = [ ve.dm.MWReferencesListNode ];
ve.ui.MWReferencesListContextItem.static.commandName = 'referencesList';
ve.ui.MWReferencesListContextItem.static.embeddable = false;
/* Methods */
/**
* @inheritdoc
*/
ve.ui.MWReferencesListContextItem.prototype.renderBody = function () {
this.$body.append(
$( '<div>' ).text( this.getDescription() )
);
if ( this.model.getAttribute( 'templateGenerated' ) ) {
this.$body.append(
$( '<div>' )
.addClass( 've-ui-mwReferenceContextItem-muted' )
.text( ve.msg( 'cite-ve-referenceslist-missingreflist' ) )
);
}
};
/**
* @inheritdoc
*/
ve.ui.MWReferencesListContextItem.prototype.getDescription = function () {
var group = this.model.getAttribute( 'refGroup' );
return group ?
ve.msg( 'cite-ve-dialog-referenceslist-contextitem-description-named', group ) :
ve.msg( 'cite-ve-dialog-referenceslist-contextitem-description-general' );
};
/* Registration */
ve.ui.contextItemFactory.register( ve.ui.MWReferencesListContextItem );