mediawiki-extensions-Visual.../modules/ve/ce/nodes/ve.ce.MWEntityNode.js
Trevor Parscal 8d33a3de0d Major Documentation Cleanup
* Made method descriptions imperative: "Do this" rather than "Does this"
* Changed use of "this object" to "the object" in method documentation
* Added missing documentation
* Fixed incorrect documentation
* Fixed incorrect debug method names (as in those VeDmClassName tags we add to functions so they make sense when dumped into in the console)
* Normalized use of package names throughout
* Normalized class descriptions
* Removed incorrect @abstract tags
* Added missing @method tags
* Lots of other minor cleanup

Change-Id: I4ea66a2dd107613e2ea3a5f56ff54d675d72957e
2013-01-16 15:37:59 -08:00

68 lines
1.4 KiB
JavaScript

/*!
* VisualEditor ContentEditable MWEntityNode class.
*
* @copyright 2011-2012 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.
*/
ve.ce.MWEntityNode = function VeCeMWEntityNode( model ) {
// Parent constructor
ve.ce.LeafNode.call( this, 'MWentity', model, $( '<span>' ) );
// DOM Changes
this.$.addClass( 've-ce-MWEntityNode' );
// Need cE=false to prevent selection issues
this.$.attr( 'contenteditable', false );
// Properties
this.currentSource = null;
// Events
this.model.addListenerMethod( this, 'update', 'onUpdate' );
// Initialization
this.onUpdate();
};
/* Inheritance */
ve.inheritClass( ve.ce.MWEntityNode, ve.ce.LeafNode );
/* Static Properties */
/**
* Node rules.
*
* @see ve.ce.NodeFactory
* @static
* @property
*/
ve.ce.MWEntityNode.rules = {
'canBeSplit': false
};
/* Methods */
/**
* Handle model update events.
*
* If the source changed since last update the image's src attribute will be updated accordingly.
*
* @method
*/
ve.ce.MWEntityNode.prototype.onUpdate = function () {
this.$.text( this.model.getAttribute( 'character' ) );
};
/* Registration */
ve.ce.nodeFactory.register( 'MWentity', ve.ce.MWEntityNode );