mediawiki-extensions-Visual.../modules/ve/ce/annotations/ve.ce.TextStyleAnnotation.js
James D. Forrester 79aff53400 De-alienate <code>foo</code> blocks (code element)
Adding the <code> element as a matched text style annotation, plus some
tests (for all the other un-tested text styles as well, whilst I'm at
it).

We'll need an icon, a button and a way of the buttons not forever
extending the length of the toolbar to properly edit <code> spans, but
this is a start.

Bonus: unit test coverage for all TextStyleAnnotations

Bug: 51590
Change-Id: I5438bcf2ec6eeb2e50400f8013964f91c33ce455
2013-07-19 00:48:46 +00:00

242 lines
8.5 KiB
JavaScript

/*!
* VisualEditor ContentEditable TextStyleAnnotation class.
*
* @copyright 2011-2013 VisualEditor Team and others; see AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
/**
* ContentEditable text style annotation.
*
* @class
* @extends ve.ce.Annotation
* @constructor
* @param {ve.dm.TextStyleAnnotation} model Model to observe
* @param {Object} [config] Config options
*/
ve.ce.TextStyleAnnotation = function VeCeTextStyleAnnotation( model, config ) {
// Parent constructor
ve.ce.Annotation.call( this, model, config );
// DOM changes
this.$.addClass( 've-ce-TextStyleAnnotation' );
};
/* Inheritance */
ve.inheritClass( ve.ce.TextStyleAnnotation, ve.ce.Annotation );
/* Static Properties */
ve.ce.TextStyleAnnotation.static.name = 'textStyle';
/* Registration */
ve.ce.annotationFactory.register( ve.ce.TextStyleAnnotation );
/* Concrete Subclasses */
/**
* ContentEditable bold annotation.
*
* @class
* @extends ve.ce.TextStyleAnnotation
* @constructor
* @param {ve.dm.TextStyleBoldAnnotation} model
*/
ve.ce.TextStyleBoldAnnotation = function VeCeTextStyleBoldAnnotation( model, config ) {
ve.ce.TextStyleAnnotation.call( this, model, config );
this.$.addClass( 've-ce-TextStyleBoldAnnotation' );
};
ve.inheritClass( ve.ce.TextStyleBoldAnnotation, ve.ce.TextStyleAnnotation );
ve.ce.TextStyleBoldAnnotation.static.name = 'textStyle/bold';
ve.ce.TextStyleBoldAnnotation.static.tagName = 'b';
ve.ce.annotationFactory.register( ve.ce.TextStyleBoldAnnotation );
/**
* ContentEditable italic annotation.
*
* @class
* @extends ve.ce.TextStyleAnnotation
* @constructor
* @param {ve.dm.TextStyleItalicAnnotation} model
*/
ve.ce.TextStyleItalicAnnotation = function VeCeTextStyleItalicAnnotation( model, config ) {
ve.ce.TextStyleAnnotation.call( this, model, config );
this.$.addClass( 've-ce-TextStyleItalicAnnotation' );
};
ve.inheritClass( ve.ce.TextStyleItalicAnnotation, ve.ce.TextStyleAnnotation );
ve.ce.TextStyleItalicAnnotation.static.name = 'textStyle/italic';
ve.ce.TextStyleItalicAnnotation.static.tagName = 'i';
ve.ce.annotationFactory.register( ve.ce.TextStyleItalicAnnotation );
/**
* ContentEditable underline annotation.
*
* @class
* @extends ve.ce.TextStyleAnnotation
* @constructor
* @param {ve.dm.TextStyleUnderlineAnnotation} model
*/
ve.ce.TextStyleUnderlineAnnotation = function VeCeTextStyleUnderlineAnnotation( model, config ) {
ve.ce.TextStyleAnnotation.call( this, model, config );
this.$.addClass( 've-ce-TextStyleUnderlineAnnotation' );
};
ve.inheritClass( ve.ce.TextStyleUnderlineAnnotation, ve.ce.TextStyleAnnotation );
ve.ce.TextStyleUnderlineAnnotation.static.name = 'textStyle/underline';
ve.ce.TextStyleUnderlineAnnotation.static.tagName = 'u';
ve.ce.annotationFactory.register( ve.ce.TextStyleUnderlineAnnotation );
/**
* ContentEditable strike annotation.
*
* @class
* @extends ve.ce.TextStyleAnnotation
* @constructor
* @param {ve.dm.TextStyleStrikeAnnotation} model
*/
ve.ce.TextStyleStrikeAnnotation = function VeCeTextStyleStrikeAnnotation( model, config ) {
ve.ce.TextStyleAnnotation.call( this, model, config );
this.$.addClass( 've-ce-TextStyleStrikeAnnotation' );
};
ve.inheritClass( ve.ce.TextStyleStrikeAnnotation, ve.ce.TextStyleAnnotation );
ve.ce.TextStyleStrikeAnnotation.static.name = 'textStyle/strike';
ve.ce.TextStyleStrikeAnnotation.static.tagName = 's';
ve.ce.annotationFactory.register( ve.ce.TextStyleStrikeAnnotation );
/**
* ContentEditable small annotation.
*
* @class
* @extends ve.ce.TextStyleAnnotation
* @constructor
* @param {ve.dm.TextStyleSmallAnnotation} model
*/
ve.ce.TextStyleSmallAnnotation = function VeCeTextStyleSmallAnnotation( model, config ) {
ve.ce.TextStyleAnnotation.call( this, model, config );
this.$.addClass( 've-ce-TextStyleSmallAnnotation' );
};
ve.inheritClass( ve.ce.TextStyleSmallAnnotation, ve.ce.TextStyleAnnotation );
ve.ce.TextStyleSmallAnnotation.static.name = 'textStyle/small';
ve.ce.TextStyleSmallAnnotation.static.tagName = 'small';
ve.ce.annotationFactory.register( ve.ce.TextStyleSmallAnnotation );
/**
* ContentEditable big annotation.
*
* @class
* @extends ve.ce.TextStyleAnnotation
* @constructor
* @param {ve.dm.TextStyleBigAnnotation} model
*/
ve.ce.TextStyleBigAnnotation = function VeCeTextStyleBigAnnotation( model, config ) {
ve.ce.TextStyleAnnotation.call( this, model, config );
this.$.addClass( 've-ce-TextStyleBigAnnotation' );
};
ve.inheritClass( ve.ce.TextStyleBigAnnotation, ve.ce.TextStyleAnnotation );
ve.ce.TextStyleBigAnnotation.static.name = 'textStyle/big';
ve.ce.TextStyleBigAnnotation.static.tagName = 'big';
ve.ce.annotationFactory.register( ve.ce.TextStyleBigAnnotation );
/**
* ContentEditable span annotation.
*
* @class
* @extends ve.ce.TextStyleAnnotation
* @constructor
* @param {ve.dm.TextStyleSpanAnnotation} model
*/
ve.ce.TextStyleSpanAnnotation = function VeCeTextStyleSpanAnnotation( model, config ) {
ve.ce.TextStyleAnnotation.call( this, model, config );
this.$.addClass( 've-ce-TextStyleSpanAnnotation' );
};
ve.inheritClass( ve.ce.TextStyleSpanAnnotation, ve.ce.TextStyleAnnotation );
ve.ce.TextStyleSpanAnnotation.static.name = 'textStyle/span';
ve.ce.TextStyleSpanAnnotation.static.tagName = 'span';
ve.ce.annotationFactory.register( ve.ce.TextStyleSpanAnnotation );
/**
* ContentEditable strong annotation.
*
* @class
* @extends ve.ce.TextStyleAnnotation
* @constructor
* @param {ve.dm.TextStyleStrongAnnotation} model
*/
ve.ce.TextStyleStrongAnnotation = function VeCeTextStyleStrongAnnotation( model, config ) {
ve.ce.TextStyleAnnotation.call( this, model, config );
this.$.addClass( 've-ce-TextStyleStrongAnnotation' );
};
ve.inheritClass( ve.ce.TextStyleStrongAnnotation, ve.ce.TextStyleAnnotation );
ve.ce.TextStyleStrongAnnotation.static.name = 'textStyle/strong';
ve.ce.TextStyleStrongAnnotation.static.tagName = 'strong';
ve.ce.annotationFactory.register( ve.ce.TextStyleStrongAnnotation );
/**
* ContentEditable emphasize annotation.
*
* @class
* @extends ve.ce.TextStyleAnnotation
* @constructor
* @param {ve.dm.TextStyleEmphasizeAnnotation} model
*/
ve.ce.TextStyleEmphasizeAnnotation = function VeCeTextStyleEmphasizeAnnotation( model, config ) {
ve.ce.TextStyleAnnotation.call( this, model, config );
this.$.addClass( 've-ce-TextStyleEmphasizeAnnotation' );
};
ve.inheritClass( ve.ce.TextStyleEmphasizeAnnotation, ve.ce.TextStyleAnnotation );
ve.ce.TextStyleEmphasizeAnnotation.static.name = 'textStyle/emphasize';
ve.ce.TextStyleEmphasizeAnnotation.static.tagName = 'em';
ve.ce.annotationFactory.register( ve.ce.TextStyleEmphasizeAnnotation );
/**
* ContentEditable superScript annotation.
*
* @class
* @extends ve.ce.TextStyleAnnotation
* @constructor
* @param {ve.dm.TextStyleSuperScriptAnnotation} model
*/
ve.ce.TextStyleSuperScriptAnnotation = function VeCeTextStyleSuperScriptAnnotation( model, config ) {
ve.ce.TextStyleAnnotation.call( this, model, config );
this.$.addClass( 've-ce-TextStyleSuperScriptAnnotation' );
};
ve.inheritClass( ve.ce.TextStyleSuperScriptAnnotation, ve.ce.TextStyleAnnotation );
ve.ce.TextStyleSuperScriptAnnotation.static.name = 'textStyle/superScript';
ve.ce.TextStyleSuperScriptAnnotation.static.tagName = 'sup';
ve.ce.annotationFactory.register( ve.ce.TextStyleSuperScriptAnnotation );
/**
* ContentEditable subScript annotation.
*
* @class
* @extends ve.ce.TextStyleAnnotation
* @constructor
* @param {ve.dm.TextStyleSubScriptAnnotation} model
*/
ve.ce.TextStyleSubScriptAnnotation = function VeCeTextStyleSubScriptAnnotation( model, config ) {
ve.ce.TextStyleAnnotation.call( this, model, config );
this.$.addClass( 've-ce-TextStyleSubScriptAnnotation' );
};
ve.inheritClass( ve.ce.TextStyleSubScriptAnnotation, ve.ce.TextStyleAnnotation );
ve.ce.TextStyleSubScriptAnnotation.static.name = 'textStyle/subScript';
ve.ce.TextStyleSubScriptAnnotation.static.tagName = 'sub';
ve.ce.annotationFactory.register( ve.ce.TextStyleSubScriptAnnotation );
/**
* ContentEditable code annotation.
*
* @class
* @extends ve.ce.TextStyleAnnotation
* @constructor
* @param {ve.dm.TextStyleCodeScriptAnnotation} model
*/
ve.ce.TextStyleCodeScriptAnnotation = function VeCeTextStyleCodeScriptAnnotation( model, config ) {
ve.ce.TextStyleAnnotation.call( this, model, config );
this.$.addClass( 've-ce-TextStyleCodeScriptAnnotation' );
};
ve.inheritClass( ve.ce.TextStyleCodeScriptAnnotation, ve.ce.TextStyleAnnotation );
ve.ce.TextStyleCodeScriptAnnotation.static.name = 'textStyle/code';
ve.ce.TextStyleCodeScriptAnnotation.static.tagName = 'code';
ve.ce.annotationFactory.register( ve.ce.TextStyleCodeScriptAnnotation );