mediawiki-extensions-Visual.../modules/ve/ui/tools/ve.ui.AnnotationTool.js
Trevor Parscal 8dfbc5baa5 Make tools generic and add fancy tool groups
Objectives:

* Got rid of mw prefixing in tools, inspectors and dialogs
* Simplify tool classes so they can be generically used as items in bars, lists and menus
* Add support for a catch-all toolbar group
* Simplify tool registration, leaning on tool classes' static name property
* Move default commands to command registry
* Move default triggers to trigger registry
* Get language tool working in standalone

Change-Id: Ic97a636f9a193374728629931b6702bee1b3416a
2013-09-03 11:27:39 -07:00

156 lines
4 KiB
JavaScript

/*!
* VisualEditor UserInterface AnnotationTool classes.
*
* @copyright 2011-2013 VisualEditor Team and others; see AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
/**
* UserInterface annotation tool.
*
* @class
* @abstract
* @extends ve.ui.Tool
*
* @constructor
* @param {ve.ui.SurfaceToolbar} toolbar
* @param {Object} [config] Config options
*/
ve.ui.AnnotationTool = function VeUiAnnotationTool( toolbar, config ) {
// Parent constructor
ve.ui.Tool.call( this, toolbar, config );
};
/* Inheritance */
ve.inheritClass( ve.ui.AnnotationTool, ve.ui.Tool );
/* Static Properties */
/**
* Annotation name and data the tool applies.
*
* @abstract
* @static
* @property {Object}
* @inheritable
*/
ve.ui.AnnotationTool.static.annotation = { 'name': '' };
/* Methods */
/**
* Handle the tool being selected.
*
* @method
*/
ve.ui.AnnotationTool.prototype.onSelect = function () {
this.toolbar.getSurface().execute(
'annotation', 'toggle', this.constructor.static.annotation.name
);
};
/**
* Handle the toolbar state being updated.
*
* @method
* @param {ve.dm.Node[]} nodes List of nodes covered by the current selection
* @param {ve.dm.AnnotationSet} full Annotations that cover all of the current selection
* @param {ve.dm.AnnotationSet} partial Annotations that cover some or all of the current selection
*/
ve.ui.AnnotationTool.prototype.onUpdateState = function ( nodes, full ) {
this.setActive( full.hasAnnotationWithName( this.constructor.static.annotation.name ) );
};
/**
* UserInterface bold tool.
*
* @class
* @extends ve.ui.AnnotationTool
* @constructor
* @param {ve.ui.SurfaceToolbar} toolbar
* @param {Object} [config] Config options
*/
ve.ui.BoldAnnotationTool = function VeUiBoldAnnotationTool( toolbar, config ) {
ve.ui.AnnotationTool.call( this, toolbar, config );
};
ve.inheritClass( ve.ui.BoldAnnotationTool, ve.ui.AnnotationTool );
ve.ui.BoldAnnotationTool.static.name = 'bold';
ve.ui.BoldAnnotationTool.static.group = 'textStyle';
ve.ui.BoldAnnotationTool.static.icon = {
'default': 'bold-a',
'be-tarask': 'bold-cyrl-te-el',
'cs': 'bold-b',
'da': 'bold-f',
'de': 'bold-f',
'en': 'bold-b',
'es': 'bold-n',
'eu': 'bold-l',
'fr': 'bold-g',
'gl': 'bold-n',
'he': 'bold-b',
'hu': 'bold-f',
'it': 'bold-g',
'ka': 'bold-geor-man',
'ky': 'bold-cyrl-zhe',
'ml': 'bold-b',
'nl': 'bold-v',
'nn': 'bold-f',
'no': 'bold-f',
'os': 'bold-cyrl-be',
'pl': 'bold-b',
'pt': 'bold-n',
'pt-br': 'bold-n',
'ru': 'bold-cyrl-zhe',
'sv': 'bold-f'
};
ve.ui.BoldAnnotationTool.static.titleMessage = 'visualeditor-annotationbutton-bold-tooltip';
ve.ui.BoldAnnotationTool.static.annotation = { 'name': 'textStyle/bold' };
ve.ui.toolFactory.register( ve.ui.BoldAnnotationTool );
/**
* UserInterface italic tool.
*
* @class
* @extends ve.ui.AnnotationTool
* @constructor
* @param {ve.ui.SurfaceToolbar} toolbar
* @param {Object} [config] Config options
*/
ve.ui.ItalicAnnotationTool = function VeUiItalicAnnotationTool( toolbar, config ) {
ve.ui.AnnotationTool.call( this, toolbar, config );
};
ve.inheritClass( ve.ui.ItalicAnnotationTool, ve.ui.AnnotationTool );
ve.ui.ItalicAnnotationTool.static.name = 'italic';
ve.ui.ItalicAnnotationTool.static.group = 'textStyle';
ve.ui.ItalicAnnotationTool.static.icon = {
'default': 'italic-a',
'be-tarask': 'italic-cyrl-ka',
'cs': 'italic-i',
'da': 'italic-k',
'de': 'italic-k',
'en': 'italic-i',
'es': 'italic-c',
'eu': 'italic-e',
'fr': 'italic-i',
'gl': 'italic-c',
'he': 'italic-i',
'hu': 'italic-d',
'it': 'italic-c',
'ka': 'italic-geor-kan',
'ky': 'italic-cyrl-ka',
'ml': 'italic-i',
'nl': 'italic-c',
'nn': 'italic-k',
'no': 'italic-k',
'os': 'italic-cyrl-ka',
'pl': 'italic-i',
'pt': 'italic-i',
'pt-br': 'italic-i',
'ru': 'italic-cyrl-ka',
'sv': 'italic-k'
};
ve.ui.ItalicAnnotationTool.static.titleMessage = 'visualeditor-annotationbutton-italic-tooltip';
ve.ui.ItalicAnnotationTool.static.annotation = { 'name': 'textStyle/italic' };
ve.ui.toolFactory.register( ve.ui.ItalicAnnotationTool );