mediawiki-extensions-Visual.../modules/ve/ui/tools/ve.ui.ClearAnnotationTool.js
Ed Sanders e6f48c5c93 'Config' -> 'Configuration' in all comments
Because the former isn't a real word.

Change-Id: Ie6ed15f9e390b357bbaa768b57f3c3fd7cf21181
2013-09-25 11:23:16 +01:00

65 lines
1.6 KiB
JavaScript

/*!
* VisualEditor UserInterface ClearAnnotationTool class.
*
* @copyright 2011-2013 VisualEditor Team and others; see AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
/**
* UserInterface clear tool.
*
* @class
* @extends ve.ui.Tool
* @constructor
* @param {ve.ui.SurfaceToolbar} toolbar
* @param {Object} [config] Configuration options
*/
ve.ui.ClearAnnotationTool = function VeUiClearAnnotationTool( toolbar, config ) {
// Parent constructor
ve.ui.Tool.call( this, toolbar, config );
// Initialization
this.setDisabled( true );
};
/* Inheritance */
ve.inheritClass( ve.ui.ClearAnnotationTool, ve.ui.Tool );
/* Static Properties */
ve.ui.ClearAnnotationTool.static.name = 'clear';
ve.ui.ClearAnnotationTool.static.group = 'utility';
ve.ui.ClearAnnotationTool.static.icon = 'clear';
ve.ui.ClearAnnotationTool.static.titleMessage = 'visualeditor-clearbutton-tooltip';
/* Methods */
/**
* Handle the tool being selected.
*
* @method
*/
ve.ui.ClearAnnotationTool.prototype.onSelect = function () {
this.toolbar.getSurface().execute( 'annotation', 'clearAll' );
};
/**
* 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.ClearAnnotationTool.prototype.onUpdateState = function ( nodes, full, partial ) {
this.setDisabled( partial.isEmpty() );
};
/* Registration */
ve.ui.toolFactory.register( ve.ui.ClearAnnotationTool );