mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor
synced 2024-09-27 04:06:51 +00:00
8f05cdbf70
Not having a description yet is fine, but they should at least be indexed as blocks so that they are searchable and listed in the jsduck generated pages. jsduck defaults to @method + name of prototype property. And it even guesses parameters sometimes. Search: \n\n([a-zA-Z\.]+\.prototype\.[a-zA-Z]+) Where: modules/ve,modules/ve-mw Where-Not: modules/ve/test Replace: \n\n/** */\n$1 Added @return in a few places where it was easy to add. Change-Id: I830c94cc7dbc261bd7a077391f930cbfff165f9d
79 lines
1.9 KiB
JavaScript
79 lines
1.9 KiB
JavaScript
/*!
|
|
* VisualEditor ContentEditable LeafNode class.
|
|
*
|
|
* @copyright 2011-2013 VisualEditor Team and others; see AUTHORS.txt
|
|
* @license The MIT License (MIT); see LICENSE.txt
|
|
*/
|
|
|
|
/**
|
|
* ContentEditable leaf node.
|
|
*
|
|
* Leaf nodes can not have any children.
|
|
*
|
|
* @abstract
|
|
* @extends ve.ce.Node
|
|
* @mixins ve.LeafNode
|
|
*
|
|
* @constructor
|
|
* @param {ve.dm.LeafNode} model Model to observe
|
|
* @param {Object} [config] Config options
|
|
*/
|
|
ve.ce.LeafNode = function VeCeLeafNode( model, config ) {
|
|
// Mixin constructor
|
|
ve.LeafNode.call( this );
|
|
|
|
// Parent constructor
|
|
ve.ce.Node.call( this, model, config );
|
|
|
|
// DOM Changes
|
|
if ( model.isWrapped() ) {
|
|
this.$.addClass( 've-ce-leafNode' );
|
|
}
|
|
};
|
|
|
|
/* Inheritance */
|
|
|
|
ve.inheritClass( ve.ce.LeafNode, ve.ce.Node );
|
|
|
|
ve.mixinClass( ve.ce.LeafNode, ve.LeafNode );
|
|
|
|
/* Static Properties */
|
|
|
|
ve.ce.LeafNode.static.tagName = 'span';
|
|
|
|
/* Methods */
|
|
|
|
/** */
|
|
ve.ce.LeafNode.prototype.onSetup = function () {
|
|
ve.ce.Node.prototype.onSetup.call( this );
|
|
this.$.addClass( 've-ce-leafNode' );
|
|
};
|
|
|
|
/** */
|
|
ve.ce.LeafNode.prototype.onTeardown = function () {
|
|
ve.ce.Node.prototype.onTeardown.call( this );
|
|
this.$.removeClass( 've-ce-leafNode' );
|
|
};
|
|
|
|
/**
|
|
* Get annotated HTML fragments.
|
|
*
|
|
* @see ve.ce.ContentBranchNode
|
|
*
|
|
* An HTML fragment can be:
|
|
* - a plain text string
|
|
* - a jQuery object
|
|
* - an array with a plain text string or jQuery object at index 0 and a ve.dm.AnnotationSet at index 1,
|
|
* i.e. ['textstring', ve.dm.AnnotationSet] or [$jQueryObj, ve.dm.AnnotationSet]
|
|
*
|
|
* The default implementation should be fine in most cases. A subclass only needs to override this
|
|
* if the annotations aren't necessarily the same across the entire node (like in ve.ce.TextNode).
|
|
*
|
|
* @method
|
|
* @returns {Array} Array of HTML fragments, i.e.
|
|
* [ string | jQuery | [string|jQuery, ve.dm.AnnotationSet] ]
|
|
*/
|
|
ve.ce.LeafNode.prototype.getAnnotatedHtml = function () {
|
|
return [ [ this.$, this.getModel().getAnnotations() ] ];
|
|
};
|