mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor
synced 2024-11-15 18:39:52 +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
278 lines
8.2 KiB
JavaScript
278 lines
8.2 KiB
JavaScript
/*!
|
|
* VisualEditor DataModel TextStyleAnnotation class.
|
|
*
|
|
* @copyright 2011-2013 VisualEditor Team and others; see AUTHORS.txt
|
|
* @license The MIT License (MIT); see LICENSE.txt
|
|
*/
|
|
|
|
/**
|
|
* DataModel text style annotation.
|
|
*
|
|
* Should not be instantiated directly, only use this for subclassing.
|
|
*
|
|
* @class
|
|
* @extends ve.dm.Annotation
|
|
* @constructor
|
|
* @param {Object} element
|
|
*/
|
|
ve.dm.TextStyleAnnotation = function VeDmTextStyleAnnotation( element ) {
|
|
ve.dm.Annotation.call( this, element );
|
|
};
|
|
|
|
/* Inheritance */
|
|
|
|
ve.inheritClass( ve.dm.TextStyleAnnotation, ve.dm.Annotation );
|
|
|
|
/* Static Properties */
|
|
|
|
ve.dm.TextStyleAnnotation.static.name = 'textStyle';
|
|
|
|
ve.dm.TextStyleAnnotation.static.matchTagNames = [];
|
|
|
|
ve.dm.TextStyleAnnotation.static.toDataElement = function ( domElements ) {
|
|
var types = {
|
|
'b': 'bold',
|
|
'i': 'italic',
|
|
'u': 'underline',
|
|
's': 'strike',
|
|
'small': 'small',
|
|
'big': 'big',
|
|
'span': 'span',
|
|
'strong': 'strong',
|
|
'em': 'emphasize',
|
|
'sup': 'superScript',
|
|
'sub': 'subScript',
|
|
'code': 'code'
|
|
};
|
|
return {
|
|
'type': 'textStyle/' + types[domElements[0].nodeName.toLowerCase()]
|
|
};
|
|
};
|
|
|
|
ve.dm.TextStyleAnnotation.static.toDomElements = function ( dataElement, doc ) {
|
|
var nodeNames = {
|
|
'bold': 'b',
|
|
'italic': 'i',
|
|
'underline': 'u',
|
|
'strike': 's',
|
|
'small': 'small',
|
|
'big': 'big',
|
|
'span': 'span',
|
|
'strong': 'strong',
|
|
'emphasize': 'em',
|
|
'superScript': 'sup',
|
|
'subScript': 'sub',
|
|
'code': 'code'
|
|
};
|
|
return [ doc.createElement( nodeNames[dataElement.type.substring( 10 )] ) ];
|
|
};
|
|
|
|
/* Methods */
|
|
|
|
/**
|
|
* @return {Object}
|
|
*/
|
|
ve.dm.TextStyleAnnotation.prototype.getComparableObject = function () {
|
|
return {
|
|
'type': this.getType()
|
|
};
|
|
};
|
|
|
|
/* Registration */
|
|
|
|
ve.dm.modelRegistry.register( ve.dm.TextStyleAnnotation );
|
|
|
|
/* Concrete Subclasses */
|
|
|
|
/**
|
|
* DataModel bold annotation.
|
|
*
|
|
* @class
|
|
* @extends ve.dm.TextStyleAnnotation
|
|
* @constructor
|
|
* @param {Object} element
|
|
*/
|
|
ve.dm.TextStyleBoldAnnotation = function VeDmTextStyleBoldAnnotation( element ) {
|
|
ve.dm.TextStyleAnnotation.call( this, element );
|
|
};
|
|
ve.inheritClass( ve.dm.TextStyleBoldAnnotation, ve.dm.TextStyleAnnotation );
|
|
ve.dm.TextStyleBoldAnnotation.static.name = 'textStyle/bold';
|
|
ve.dm.TextStyleBoldAnnotation.static.matchTagNames = ['b'];
|
|
ve.dm.modelRegistry.register( ve.dm.TextStyleBoldAnnotation );
|
|
|
|
/**
|
|
* DataModel italic annotation.
|
|
*
|
|
* @class
|
|
* @extends ve.dm.TextStyleAnnotation
|
|
* @constructor
|
|
* @param {Object} element
|
|
*/
|
|
ve.dm.TextStyleItalicAnnotation = function VeDmTextStyleItalicAnnotation( element ) {
|
|
ve.dm.TextStyleAnnotation.call( this, element );
|
|
};
|
|
ve.inheritClass( ve.dm.TextStyleItalicAnnotation, ve.dm.TextStyleAnnotation );
|
|
ve.dm.TextStyleItalicAnnotation.static.name = 'textStyle/italic';
|
|
ve.dm.TextStyleItalicAnnotation.static.matchTagNames = ['i'];
|
|
ve.dm.modelRegistry.register( ve.dm.TextStyleItalicAnnotation );
|
|
|
|
/**
|
|
* DataModel underline annotation.
|
|
*
|
|
* @class
|
|
* @extends ve.dm.TextStyleAnnotation
|
|
* @constructor
|
|
* @param {Object} element
|
|
*/
|
|
ve.dm.TextStyleUnderlineAnnotation = function VeDmTextStyleUnderlineAnnotation( element ) {
|
|
ve.dm.TextStyleAnnotation.call( this, element );
|
|
};
|
|
ve.inheritClass( ve.dm.TextStyleUnderlineAnnotation, ve.dm.TextStyleAnnotation );
|
|
ve.dm.TextStyleUnderlineAnnotation.static.name = 'textStyle/underline';
|
|
ve.dm.TextStyleUnderlineAnnotation.static.matchTagNames = ['u'];
|
|
ve.dm.modelRegistry.register( ve.dm.TextStyleUnderlineAnnotation );
|
|
|
|
/**
|
|
* DataModel strike annotation.
|
|
*
|
|
* @class
|
|
* @extends ve.dm.TextStyleAnnotation
|
|
* @constructor
|
|
* @param {Object} element
|
|
*/
|
|
ve.dm.TextStyleStrikeAnnotation = function VeDmTextStyleStrikeAnnotation( element ) {
|
|
ve.dm.TextStyleAnnotation.call( this, element );
|
|
};
|
|
ve.inheritClass( ve.dm.TextStyleStrikeAnnotation, ve.dm.TextStyleAnnotation );
|
|
ve.dm.TextStyleStrikeAnnotation.static.name = 'textStyle/strike';
|
|
ve.dm.TextStyleStrikeAnnotation.static.matchTagNames = ['s'];
|
|
ve.dm.modelRegistry.register( ve.dm.TextStyleStrikeAnnotation );
|
|
|
|
/**
|
|
* DataModel small annotation.
|
|
*
|
|
* @class
|
|
* @extends ve.dm.TextStyleAnnotation
|
|
* @constructor
|
|
* @param {Object} element
|
|
*/
|
|
ve.dm.TextStyleSmallAnnotation = function VeDmTextStyleSmallAnnotation( element ) {
|
|
ve.dm.TextStyleAnnotation.call( this, element );
|
|
};
|
|
ve.inheritClass( ve.dm.TextStyleSmallAnnotation, ve.dm.TextStyleAnnotation );
|
|
ve.dm.TextStyleSmallAnnotation.static.name = 'textStyle/small';
|
|
ve.dm.TextStyleSmallAnnotation.static.matchTagNames = ['small'];
|
|
ve.dm.modelRegistry.register( ve.dm.TextStyleSmallAnnotation );
|
|
|
|
/**
|
|
* DataModel big annotation.
|
|
*
|
|
* @class
|
|
* @extends ve.dm.TextStyleAnnotation
|
|
* @constructor
|
|
* @param {Object} element
|
|
*/
|
|
ve.dm.TextStyleBigAnnotation = function VeDmTextStyleBigAnnotation( element ) {
|
|
ve.dm.TextStyleAnnotation.call( this, element );
|
|
};
|
|
ve.inheritClass( ve.dm.TextStyleBigAnnotation, ve.dm.TextStyleAnnotation );
|
|
ve.dm.TextStyleBigAnnotation.static.name = 'textStyle/big';
|
|
ve.dm.TextStyleBigAnnotation.static.matchTagNames = ['big'];
|
|
ve.dm.modelRegistry.register( ve.dm.TextStyleBigAnnotation );
|
|
|
|
/**
|
|
* DataModel span annotation.
|
|
*
|
|
* @class
|
|
* @extends ve.dm.TextStyleAnnotation
|
|
* @constructor
|
|
* @param {Object} element
|
|
*/
|
|
ve.dm.TextStyleSpanAnnotation = function VeDmTextStyleSpanAnnotation( element ) {
|
|
ve.dm.TextStyleAnnotation.call( this, element );
|
|
};
|
|
ve.inheritClass( ve.dm.TextStyleSpanAnnotation, ve.dm.TextStyleAnnotation );
|
|
ve.dm.TextStyleSpanAnnotation.static.name = 'textStyle/span';
|
|
ve.dm.TextStyleSpanAnnotation.static.matchTagNames = ['span'];
|
|
ve.dm.modelRegistry.register( ve.dm.TextStyleSpanAnnotation );
|
|
|
|
/**
|
|
* DataModel strong annotation.
|
|
*
|
|
* @class
|
|
* @extends ve.dm.TextStyleAnnotation
|
|
* @constructor
|
|
* @param {Object} element
|
|
*/
|
|
ve.dm.TextStyleStrongAnnotation = function VeDmTextStyleStrongAnnotation( element ) {
|
|
ve.dm.TextStyleAnnotation.call( this, element );
|
|
};
|
|
ve.inheritClass( ve.dm.TextStyleStrongAnnotation, ve.dm.TextStyleAnnotation );
|
|
ve.dm.TextStyleStrongAnnotation.static.name = 'textStyle/strong';
|
|
ve.dm.TextStyleStrongAnnotation.static.matchTagNames = ['strong'];
|
|
ve.dm.modelRegistry.register( ve.dm.TextStyleStrongAnnotation );
|
|
|
|
/**
|
|
* DataModel emphasis annotation.
|
|
*
|
|
* @class
|
|
* @extends ve.dm.TextStyleAnnotation
|
|
* @constructor
|
|
* @param {Object} element
|
|
*/
|
|
ve.dm.TextStyleEmphasizeAnnotation = function VeDmTextStyleEmphasizeAnnotation( element ) {
|
|
ve.dm.TextStyleAnnotation.call( this, element );
|
|
};
|
|
ve.inheritClass( ve.dm.TextStyleEmphasizeAnnotation, ve.dm.TextStyleAnnotation );
|
|
ve.dm.TextStyleEmphasizeAnnotation.static.name = 'textStyle/emphasize';
|
|
ve.dm.TextStyleEmphasizeAnnotation.static.matchTagNames = ['em'];
|
|
ve.dm.modelRegistry.register( ve.dm.TextStyleEmphasizeAnnotation );
|
|
|
|
/**
|
|
* DataModel super script annotation.
|
|
*
|
|
* @class
|
|
* @extends ve.dm.TextStyleAnnotation
|
|
* @constructor
|
|
* @param {Object} element
|
|
*/
|
|
ve.dm.TextStyleSuperScriptAnnotation = function VeDmTextStyleSuperScriptAnnotation( element ) {
|
|
ve.dm.TextStyleAnnotation.call( this, element );
|
|
};
|
|
ve.inheritClass( ve.dm.TextStyleSuperScriptAnnotation, ve.dm.TextStyleAnnotation );
|
|
ve.dm.TextStyleSuperScriptAnnotation.static.name = 'textStyle/superScript';
|
|
ve.dm.TextStyleSuperScriptAnnotation.static.matchTagNames = ['sup'];
|
|
ve.dm.modelRegistry.register( ve.dm.TextStyleSuperScriptAnnotation );
|
|
|
|
/**
|
|
* DataModel sub script annotation.
|
|
*
|
|
* @class
|
|
* @extends ve.dm.TextStyleAnnotation
|
|
* @constructor
|
|
* @param {Object} element
|
|
*/
|
|
ve.dm.TextStyleSubScriptAnnotation = function VeDmTextStyleSubScriptAnnotation( element ) {
|
|
ve.dm.TextStyleAnnotation.call( this, element );
|
|
};
|
|
ve.inheritClass( ve.dm.TextStyleSubScriptAnnotation, ve.dm.TextStyleAnnotation );
|
|
ve.dm.TextStyleSubScriptAnnotation.static.name = 'textStyle/subScript';
|
|
ve.dm.TextStyleSubScriptAnnotation.static.matchTagNames = ['sub'];
|
|
ve.dm.modelRegistry.register( ve.dm.TextStyleSubScriptAnnotation );
|
|
|
|
/**
|
|
* DataModel code script annotation.
|
|
*
|
|
* @class
|
|
* @extends ve.dm.TextStyleAnnotation
|
|
* @constructor
|
|
* @param {Object} element
|
|
*/
|
|
ve.dm.TextStyleCodeAnnotation = function VeDmTextStyleCodeAnnotation( element ) {
|
|
ve.dm.TextStyleAnnotation.call( this, element );
|
|
};
|
|
ve.inheritClass( ve.dm.TextStyleCodeAnnotation, ve.dm.TextStyleAnnotation );
|
|
ve.dm.TextStyleCodeAnnotation.static.name = 'textStyle/code';
|
|
ve.dm.TextStyleCodeAnnotation.static.matchTagNames = ['code'];
|
|
ve.dm.modelRegistry.register( ve.dm.TextStyleCodeAnnotation );
|