mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor
synced 2024-11-16 02:51:50 +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
49 lines
1.2 KiB
JavaScript
49 lines
1.2 KiB
JavaScript
/*!
|
|
* VisualEditor DataModel LeafNode class.
|
|
*
|
|
* @copyright 2011-2012 VisualEditor Team and others; see AUTHORS.txt
|
|
* @license The MIT License (MIT); see LICENSE.txt
|
|
*/
|
|
|
|
/**
|
|
* DataModel leaf node.
|
|
*
|
|
* Leaf nodes can not have any children.
|
|
*
|
|
* @abstract
|
|
* @extends ve.dm.Node
|
|
* @mixins ve.LeafNode
|
|
* @constructor
|
|
* @param {string} type Symbolic name of node type
|
|
* @param {number} [length] Length of content data in document
|
|
* @param {Object} [element] Reference to element in linear model
|
|
*/
|
|
ve.dm.LeafNode = function VeDmLeafNode( type, length, element ) {
|
|
// Mixin constructor
|
|
ve.LeafNode.call( this );
|
|
|
|
// Parent constructor
|
|
ve.dm.Node.call( this, type, length, element );
|
|
};
|
|
|
|
/* Inheritance */
|
|
|
|
ve.inheritClass( ve.dm.LeafNode, ve.dm.Node );
|
|
|
|
ve.mixinClass( ve.dm.LeafNode, ve.LeafNode );
|
|
|
|
/* Methods */
|
|
|
|
/**
|
|
* Get the annotations that apply to the node.
|
|
*
|
|
* Annotations are grabbed directly from the linear model, so they are updated live. If the linear
|
|
* model element doesn't have a .annotations property, an empty set is returned.
|
|
*
|
|
* @method
|
|
* @returns {ve.AnnotationSet} Annotation set (by reference!)
|
|
*/
|
|
ve.dm.LeafNode.prototype.getAnnotations = function () {
|
|
return this.element.annotations || new ve.AnnotationSet();
|
|
};
|