mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor
synced 2024-12-04 18:58:37 +00:00
332e31fb00
Objectives: * Make it possible to add items to toolbars without having to have all toolbars know about the items in advance * Make it possible to specialize an existing tool and have it be used instead of the base implementation Approach: * Tools are named using a path-style category/id/ext system, making them selectable, the latter component being used to differentiate extended tools from their base classes, but is ignored during selection * Toolbars have ToolGroups, which include or exclude tools by category or category/id, and order them by promoting and demoting selections of tools by category or category/id Future: * Add a way to place available but not yet placed tools in an "overflow" group * Add a mode to ToolGroup to make the tools a multi-column drop-down style list with labels so tools with less obvious icons are easier to identify - and probably use this as the overflow group Change-Id: I7625f861435a99ce3d7a2b1ece9731aaab1776f8
70 lines
1.8 KiB
JavaScript
70 lines
1.8 KiB
JavaScript
/*!
|
|
* VisualEditor UserInterface ClearButtonTool class.
|
|
*
|
|
* @copyright 2011-2013 VisualEditor Team and others; see AUTHORS.txt
|
|
* @license The MIT License (MIT); see LICENSE.txt
|
|
*/
|
|
|
|
/**
|
|
* UserInterface clear button tool.
|
|
*
|
|
* @class
|
|
* @extends ve.ui.ButtonTool
|
|
* @constructor
|
|
* @param {ve.ui.SurfaceToolbar} toolbar
|
|
* @param {Object} [config] Config options
|
|
*/
|
|
ve.ui.ClearButtonTool = function VeUiClearButtonTool( toolbar, config ) {
|
|
// Parent constructor
|
|
ve.ui.ButtonTool.call( this, toolbar, config );
|
|
|
|
// Initialization
|
|
this.setDisabled( true );
|
|
};
|
|
|
|
/* Inheritance */
|
|
|
|
ve.inheritClass( ve.ui.ClearButtonTool, ve.ui.ButtonTool );
|
|
|
|
/* Static Properties */
|
|
|
|
ve.ui.ClearButtonTool.static.name = 'utility/clear';
|
|
|
|
ve.ui.ClearButtonTool.static.icon = 'clear';
|
|
|
|
ve.ui.ClearButtonTool.static.titleMessage = 'visualeditor-clearbutton-tooltip';
|
|
|
|
/* Methods */
|
|
|
|
/**
|
|
* Handle the button being clicked.
|
|
*
|
|
* @method
|
|
*/
|
|
ve.ui.ClearButtonTool.prototype.onClick = 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.ClearButtonTool.prototype.onUpdateState = function ( nodes, full, partial ) {
|
|
this.setDisabled( partial.isEmpty() );
|
|
};
|
|
|
|
/* Registration */
|
|
|
|
ve.ui.toolFactory.register( 'utility/clear', ve.ui.ClearButtonTool );
|
|
|
|
ve.ui.commandRegistry.register( 'utility/clear', 'annotation', 'clearAll' );
|
|
|
|
ve.ui.triggerRegistry.register(
|
|
'utility/clear',
|
|
{ 'mac': new ve.ui.Trigger( 'cmd+\\' ), 'pc': new ve.ui.Trigger( 'ctrl+\\' ) }
|
|
);
|