mediawiki-extensions-VisualEditor/modules/ve/ui/tools/ve.ui.AnnotationButtonTool.js

/**
 * VisualEditor user interface AnnotationButtonTool class.
 *
 * @copyright 2011-2012 VisualEditor Team and others; see AUTHORS.txt
 * @license The MIT License (MIT); see LICENSE.txt
 */

/**
 * Creates an ve.ui.AnnotationButtonTool object.
 *
 * @class
 * @constructor
 * @extends {ve.ui.ButtonTool}
 * @param {ve.ui.Toolbar} toolbar
 * @param {String} name
 * @param {Object} annotation
 */
ve.ui.AnnotationButtonTool = function ( toolbar, name, title, data ) {
	// Inheritance
	ve.ui.ButtonTool.call( this, toolbar, name, title );

	// Properties
	this.annotation = data.annotation;
	this.inspector = data.inspector;
	this.active = false;
};

/* Methods */

ve.ui.AnnotationButtonTool.prototype.onClick = function () {
	var surfaceView = this.toolbar.getSurfaceView(),
		surfaceModel = surfaceView.model,
		selection = surfaceModel.getSelection();
	if ( this.inspector ) {
		if ( selection && selection.getLength() ) {
			surfaceView.contextView.openInspector( this.inspector );
		}
	} else {
		surfaceModel.annotate( this.active ? 'clear' : 'set', this.annotation );
	}
};

ve.ui.AnnotationButtonTool.prototype.updateState = function ( annotations, nodes ) {
	var matches = ve.dm.Document.getMatchingAnnotations(
		annotations, new RegExp( '^' + this.annotation.type + '$' )
	);
	if ( ve.isEmptyObject( matches ) ) {
		this.$.removeClass( 've-ui-toolbarButtonTool-down' );
		this.active = false;
	} else {
		this.$.addClass( 've-ui-toolbarButtonTool-down' );
		this.active = true;
	}
};

/* Registration */

ve.ui.Tool.tools.bold = {
	'constructor': ve.ui.AnnotationButtonTool,
	'name': 'bold',
	'title': ve.msg( 'visualeditor-annotationbutton-bold-tooltip' ),
	'data': {
		'annotation': { 'type': 'textStyle/bold' }
	}
};

ve.ui.Tool.tools.italic = {
	'constructor': ve.ui.AnnotationButtonTool,
	'name': 'italic',
	'title': ve.msg( 'visualeditor-annotationbutton-italic-tooltip' ),
	'data': {
		'annotation': { 'type': 'textStyle/italic' }
	}
};

ve.ui.Tool.tools.link = {
	'constructor': ve.ui.AnnotationButtonTool,
	'name': 'link',
	'title': ve.msg( 'visualeditor-annotationbutton-link-tooltip' ),
	'data': {
		'annotation': { 'type': 'link/WikiLink', 'data': { 'title': '' } },
		'inspector': 'link'
	}
};

/* Inheritance */

ve.extendClass( ve.ui.AnnotationButtonTool, ve.ui.ButtonTool );