mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor
synced 2024-09-25 03:08:42 +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
57 lines
1.4 KiB
JavaScript
57 lines
1.4 KiB
JavaScript
/*!
|
|
* VisualEditor AnnotationSet class.
|
|
*
|
|
* @copyright 2011-2012 VisualEditor Team and others; see AUTHORS.txt
|
|
* @license The MIT License (MIT); see LICENSE.txt
|
|
*/
|
|
|
|
/**
|
|
* Annotation set.
|
|
*
|
|
* @extends ve.OrderedHashSet
|
|
* @constructor
|
|
* @param {Object[]} annotations Array of annotation objects
|
|
*/
|
|
ve.AnnotationSet = function VeAnnotationSet( annotations ) {
|
|
// Parent constructor
|
|
ve.OrderedHashSet.call( this, ve.getHash, annotations );
|
|
};
|
|
|
|
/* Inheritance */
|
|
|
|
ve.inheritClass( ve.AnnotationSet, ve.OrderedHashSet );
|
|
|
|
/* Methods */
|
|
|
|
/**
|
|
* Get a clone.
|
|
*
|
|
* @method
|
|
* @returns {ve.AnnotationSet} Copy of annotation set
|
|
*/
|
|
ve.AnnotationSet.prototype.clone = function () {
|
|
return new ve.AnnotationSet( this );
|
|
};
|
|
|
|
/**
|
|
* Get an annotation set containing only annotations within the set with a specific name.
|
|
*
|
|
* @method
|
|
* @param {string|RegExp} name Regular expression or string to compare types with
|
|
* @returns {ve.AnnotationSet} Copy of annotation set
|
|
*/
|
|
ve.AnnotationSet.prototype.getAnnotationsByName = function ( name ) {
|
|
return this.filter( 'name', name );
|
|
};
|
|
|
|
/**
|
|
* Check if any annotations in the set have a specific name.
|
|
*
|
|
* @method
|
|
* @param {string|RegExp} name Regular expression or string to compare names with
|
|
* @returns {boolean} Annotation of given type exists in the set
|
|
*/
|
|
ve.AnnotationSet.prototype.hasAnnotationWithName = function ( name ) {
|
|
return this.containsMatching( 'name', name );
|
|
};
|