mediawiki-extensions-Visual.../modules/ve-mw/ce/nodes/ve.ce.MWEntityNode.js
Bartosz Dziewoński 84d548e7b1 Remove redundant @method annotations
A @method annotation is only necessary when the docblock is not
directly followed by a function declaration (in which case JSDuck
assumes it documents a property), e.g. when defining an abstract
function or referencing a function from another library.

I verified that JSDuck generates exactly the same output before and
after this change (docs/data-<hash>.js files are identical).

Change-Id: I7edf51a8560ab9978b42800ab1026f0b5555c3bf
2019-08-21 23:33:15 +02:00

62 lines
1.4 KiB
JavaScript

/*!
* VisualEditor ContentEditable MWEntityNode class.
*
* @copyright 2011-2019 VisualEditor Team and others; see AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
/**
* ContentEditable MediaWiki entity node.
*
* @class
* @extends ve.ce.LeafNode
* @constructor
* @param {ve.dm.MWEntityNode} model Model to observe
* @param {Object} [config] Configuration options
*/
ve.ce.MWEntityNode = function VeCeMWEntityNode() {
// Parent constructor
ve.ce.MWEntityNode.super.apply( this, arguments );
// DOM changes
this.$element.addClass( 've-ce-mwEntityNode' );
// Need CE=false to prevent selection issues
this.$element.prop( 'contentEditable', 'false' );
// Events
this.model.connect( this, { update: 'onUpdate' } );
// Initialization
this.onUpdate();
};
/* Inheritance */
OO.inheritClass( ve.ce.MWEntityNode, ve.ce.LeafNode );
/* Static Properties */
ve.ce.MWEntityNode.static.name = 'mwEntity';
/* Methods */
/**
* Handle model update events.
*/
ve.ce.MWEntityNode.prototype.onUpdate = function () {
var
chr = this.model.getAttribute( 'character' ),
whitespaceHtmlChars = ve.visibleWhitespaceCharacters,
significantWhitespace = this.getModel().getParent().hasSignificantWhitespace();
if ( !significantWhitespace && Object.prototype.hasOwnProperty.call( whitespaceHtmlChars, chr ) ) {
chr = whitespaceHtmlChars[ chr ];
}
this.$element.text( chr );
};
/* Registration */
ve.ce.nodeFactory.register( ve.ce.MWEntityNode );