mediawiki-extensions-Visual.../modules/ve/ui/tools/ve.ui.AnnotationButtonTool.js
Trevor Parscal a4e0e83f24 Cleanup tool API
* Moved to tool specific configuration to static properties (left tool instance specific stuff in the constructors)
* Added documentation for tool configurations
* Centralized typePattern matching for inspectors

Change-Id: Ieacf61b320c10fd37ea69a05e543313fa990b403
2012-10-31 11:10:17 -07:00

62 lines
1.5 KiB
JavaScript

/**
* 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.
*
* @abstract
* @class
* @constructor
* @extends {ve.ui.ButtonTool}
* @param {ve.ui.Toolbar} toolbar
*/
ve.ui.AnnotationButtonTool = function VeUiAnnotationButtonTool( toolbar ) {
// Parent constructor
ve.ui.ButtonTool.call( this, toolbar );
};
/* Inheritance */
ve.inheritClass( ve.ui.AnnotationButtonTool, ve.ui.ButtonTool );
/* Static Members */
/**
* Annotation name and data this button applies.
*
* @abstract
* @static
* @member
* @type {Object}
*/
ve.ui.AnnotationButtonTool.static.annotation = { 'name': '' };
/* Methods */
/**
* Responds to the button being clicked.
*
* @method
*/
ve.ui.AnnotationButtonTool.prototype.onClick = function () {
this.toolbar.getSurface().execute(
'annotation', 'toggle', this.constructor.static.annotation.name
);
};
/**
* Responds to 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.AnnotationButtonTool.prototype.onUpdateState = function ( nodes, full ) {
this.setActive( full.hasAnnotationWithName( this.constructor.static.annotation.name ) );
};