extensions/Cite/modules/ve-cite/ve.ui.MWReferenceContextItem.js

   1 /*!
   2  * VisualEditor MWReferenceContextItem class.
   3  *
   4  * @copyright 2011-2017 Cite VisualEditor Team and others; see AUTHORS.txt
   5  * @license The MIT License (MIT); see LICENSE.txt
   6  */
   7
   8 /**
   9  * Context item for a MWReference.
  10  *
  11  * @class
  12  * @extends ve.ui.LinearContextItem
  13  *
  14  * @constructor
  15  * @param {ve.ui.Context} context Context item is in
  16  * @param {ve.dm.Model} model Model item is related to
  17  * @param {Object} config Configuration options
  18  */
  19 ve.ui.MWReferenceContextItem = function VeUiMWReferenceContextItem() {
  20         // Parent constructor
  21         ve.ui.MWReferenceContextItem.super.apply( this, arguments );
  22         this.view = null;
  23         // Initialization
  24         this.$element.addClass( 've-ui-mwReferenceContextItem' );
  25 };
  26
  27 /* Inheritance */
  28
  29 OO.inheritClass( ve.ui.MWReferenceContextItem, ve.ui.LinearContextItem );
  30
  31 /* Static Properties */
  32
  33 ve.ui.MWReferenceContextItem.static.name = 'reference';
  34
  35 ve.ui.MWReferenceContextItem.static.icon = 'reference';
  36
  37 ve.ui.MWReferenceContextItem.static.label = OO.ui.deferMsg( 'cite-ve-dialogbutton-reference-title' );
  38
  39 ve.ui.MWReferenceContextItem.static.modelClasses = [ ve.dm.MWReferenceNode ];
  40
  41 ve.ui.MWReferenceContextItem.static.commandName = 'reference';
  42
  43 /* Methods */
  44
  45 /**
  46  * Get a DOM rendering of the reference.
  47  *
  48  * @private
  49  * @return {jQuery} DOM rendering of reference
  50  */
  51 ve.ui.MWReferenceContextItem.prototype.getRendering = function () {
  52         var refNode = this.getReferenceNode();
  53         if ( refNode ) {
  54                 this.view = new ve.ui.MWPreviewElement( refNode );
  55
  56                 // The $element property may be rendered into asynchronously, update the context's size when the
  57                 // rendering is complete if that's the case
  58                 this.view.once( 'render', this.context.updateDimensions.bind( this.context ) );
  59
  60                 return this.view.$element;
  61         } else {
  62                 return $( '<div>' )
  63                         .addClass( 've-ui-mwReferenceContextItem-muted' )
  64                         .text( ve.msg( 'cite-ve-referenceslist-missingref' ) );
  65         }
  66 };
  67
  68 /**
  69  * Get the reference node in the containing document (not the internal list document)
  70  *
  71  * @return {ve.dm.InternalItemNode|null} Reference item node
  72  */
  73 ve.ui.MWReferenceContextItem.prototype.getReferenceNode = function () {
  74         var refModel;
  75         if ( !this.model.isEditable() ) {
  76                 return null;
  77         }
  78         if ( !this.referenceNode ) {
  79                 refModel = ve.dm.MWReferenceModel.static.newFromReferenceNode( this.model );
  80                 this.referenceNode = this.getFragment().getDocument().getInternalList().getItemNode( refModel.getListIndex() );
  81         }
  82         return this.referenceNode;
  83 };
  84
  85 /**
  86  * @inheritdoc
  87  */
  88 ve.ui.MWReferenceContextItem.prototype.getDescription = function () {
  89         return this.model.isEditable() ? this.getRendering().text() : ve.msg( 'cite-ve-referenceslist-missingref' );
  90 };
  91
  92 /**
  93  * @inheritdoc
  94  */
  95 ve.ui.MWReferenceContextItem.prototype.renderBody = function () {
  96         this.$body.empty().append( this.getRendering() );
  97 };
  98
  99 /**
 100  * @inheritdoc
 101  */
 102 ve.ui.MWReferenceContextItem.prototype.teardown = function () {
 103         if ( this.view ) {
 104                 this.view.destroy();
 105         }
 106
 107         // Call parent
 108         ve.ui.MWReferenceContextItem.super.prototype.teardown.call( this );
 109 };
 110
 111 /* Registration */
 112
 113 ve.ui.contextItemFactory.register( ve.ui.MWReferenceContextItem );