mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor
synced 2024-09-27 12:16:51 +00:00
8d33a3de0d
* 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
63 lines
1.7 KiB
JavaScript
63 lines
1.7 KiB
JavaScript
/*!
|
|
* VisualEditor ContentEditable LeafNode class.
|
|
*
|
|
* @copyright 2011-2012 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 {string} type Symbolic name of node type
|
|
* @param {ve.dm.LeafNode} model Model to observe
|
|
* @param {jQuery} [$element] Element to use as a container
|
|
*/
|
|
ve.ce.LeafNode = function VeCeLeafNode( type, model, $element ) {
|
|
// Mixin constructor
|
|
ve.LeafNode.call( this );
|
|
|
|
// Parent constructor
|
|
ve.ce.Node.call( this, type, model, $element );
|
|
|
|
// 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 );
|
|
|
|
/* Methods */
|
|
|
|
/**
|
|
* Get annotated HTML fragments.
|
|
*
|
|
* @see ve.ce.ContentBranchNode.
|
|
*
|
|
* An HTML fragment can be:
|
|
* - an HTML string
|
|
* - a jQuery object
|
|
* - an array with an HTML string or jQuery object at index 0 and a ve.AnnotationSet at index 1,
|
|
* i.e. ['htmlstring', ve.AnnotationSet] or [$jQueryObj, ve.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.AnnotationSet] ]
|
|
*/
|
|
ve.ce.LeafNode.prototype.getAnnotatedHtml = function () {
|
|
return [ [ this.$, this.getModel().getAnnotations() ] ];
|
|
};
|