mediawiki-extensions-Visual.../modules/ve/ve.AnnotationSet.js
Trevor Parscal a379e0f91e More {String} -> {string} conversions in documentation
Follow up for I6a7c9e8ee8f995731bc205d666167874eb2ebe23

The first pass that Timo took missed the following cases

* "{Array|String}": string is just one of the values
* "{String[]}": string is followed by [] to indicate an array of strings

Change-Id: I65e595e8d37fb624802d84af9536a2d3c5d73c7d
2013-01-08 13:02:12 -08:00

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
*/
/**
* Ordered set of annotations.
*
* @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 */
/**
* Gets a clone.
*
* @method
* @returns {ve.AnnotationSet} Copy of annotation set
*/
ve.AnnotationSet.prototype.clone = function () {
return new ve.AnnotationSet( this );
};
/**
* Gets an annotation set containing only annotations within this set with a given 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 );
};
/**
* Checks if any annotations in this set have a given name
*
* @method
* @param {string|RegExp} name Regular expression or string to compare names with
* @returns {boolean} Annotation of given type exists in this set
*/
ve.AnnotationSet.prototype.hasAnnotationWithName = function ( name ) {
return this.containsMatching( 'name', name );
};