'use strict'; /*! * VisualEditor MWReferenceContextItem class. * * @copyright 2011-2018 VisualEditor Team's Cite sub-team and others; see AUTHORS.txt * @license MIT */ /** * Context item for a MWReference. * * @constructor * @extends ve.ui.LinearContextItem * @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.MWReferenceContextItem = function VeUiMWReferenceContextItem() { // Parent constructor ve.ui.MWReferenceContextItem.super.apply( this, arguments ); this.view = null; // Initialization this.$element.addClass( 've-ui-mwReferenceContextItem' ); }; /* Inheritance */ OO.inheritClass( ve.ui.MWReferenceContextItem, ve.ui.LinearContextItem ); /* Static Properties */ ve.ui.MWReferenceContextItem.static.name = 'reference'; ve.ui.MWReferenceContextItem.static.icon = 'reference'; ve.ui.MWReferenceContextItem.static.label = OO.ui.deferMsg( 'cite-ve-dialogbutton-reference-title' ); ve.ui.MWReferenceContextItem.static.modelClasses = [ ve.dm.MWReferenceNode ]; ve.ui.MWReferenceContextItem.static.commandName = 'reference'; /* Methods */ /** * Get a DOM rendering of the reference. * * @private * @return {jQuery} DOM rendering of reference */ ve.ui.MWReferenceContextItem.prototype.getRendering = function () { const refNode = this.getReferenceNode(); if ( refNode ) { this.view = new ve.ui.MWPreviewElement( refNode ); // The $element property may be rendered into asynchronously, update the // context's size when the rendering is complete if that's the case this.view.once( 'render', this.context.updateDimensions.bind( this.context ) ); return this.view.$element; } else { return $( '<div>' ) .addClass( 've-ui-mwReferenceContextItem-muted' ) .text( ve.msg( 'cite-ve-referenceslist-missingref' ) ); } }; /** * Get a DOM rendering of a warning if this reference is reused. * * @private * @return {jQuery|null} */ ve.ui.MWReferenceContextItem.prototype.getReuseWarning = function () { const refModel = ve.dm.MWReferenceModel.static.newFromReferenceNode( this.model ); const group = this.getFragment().getDocument().getInternalList() .getNodeGroup( refModel.getListGroup() ); const nodes = ve.getProp( group, 'keyedNodes', refModel.getListKey() ); const usages = nodes && nodes.filter( function ( node ) { return !node.findParent( ve.dm.MWReferencesListNode ); } ).length; if ( usages > 1 ) { return $( '<div>' ) .addClass( 've-ui-mwReferenceContextItem-muted' ) .text( mw.msg( 'cite-ve-dialog-reference-editing-reused', usages ) ); } }; /** * Get a DOM rendering of a warning if this reference is an extension. * * @private * @return {jQuery|null} */ ve.ui.MWReferenceContextItem.prototype.getExtendsWarning = function () { const refModel = ve.dm.MWReferenceModel.static.newFromReferenceNode( this.model ); if ( refModel.extendsRef ) { return $( '<div>' ) .addClass( 've-ui-mwReferenceContextItem-muted' ) .text( mw.msg( 'cite-ve-dialog-reference-editing-extends' ) ); } }; /** * Get the reference node in the containing document (not the internal list document) * * @return {ve.dm.InternalItemNode|null} Reference item node */ ve.ui.MWReferenceContextItem.prototype.getReferenceNode = function () { if ( !this.model.isEditable() ) { return null; } if ( !this.referenceNode ) { const refModel = ve.dm.MWReferenceModel.static.newFromReferenceNode( this.model ); this.referenceNode = this.getFragment().getDocument().getInternalList() .getItemNode( refModel.getListIndex() ); } return this.referenceNode; }; /** * @override */ ve.ui.MWReferenceContextItem.prototype.getDescription = function () { return this.model.isEditable() ? this.getRendering().text() : ve.msg( 'cite-ve-referenceslist-missingref' ); }; /** * Get the text of the parent reference. * * @private * @return {string|null} */ ve.ui.MWReferenceContextItem.prototype.getParentRef = function () { const refModel = ve.dm.MWReferenceModel.static.newFromReferenceNode( this.model ); if ( !refModel.extendsRef ) { return null; } const list = this.getFragment().getDocument().getInternalList(); const index = list.keys.indexOf( 'literal/' + refModel.extendsRef ); return list.getItemNode( index ).element.attributes.originalHtml; }; /** * @override */ ve.ui.MWReferenceContextItem.prototype.renderBody = function () { this.$body.empty().append( this.getParentRef(), this.getRendering(), this.getReuseWarning(), this.getExtendsWarning() ); }; /** * @override */ ve.ui.MWReferenceContextItem.prototype.teardown = function () { if ( this.view ) { this.view.destroy(); } // Call parent ve.ui.MWReferenceContextItem.super.prototype.teardown.call( this ); }; /* Registration */ ve.ui.contextItemFactory.register( ve.ui.MWReferenceContextItem );