mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor
synced 2024-11-06 06:29:11 +00:00
8dfbc5baa5
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
127 lines
3.3 KiB
JavaScript
127 lines
3.3 KiB
JavaScript
/*!
|
|
* VisualEditor UserInterface HistoryTool classes.
|
|
*
|
|
* @copyright 2011-2013 VisualEditor Team and others; see AUTHORS.txt
|
|
* @license The MIT License (MIT); see LICENSE.txt
|
|
*/
|
|
|
|
/**
|
|
* UserInterface history tool.
|
|
*
|
|
* @class
|
|
* @extends ve.ui.Tool
|
|
* @constructor
|
|
* @param {ve.ui.SurfaceToolbar} toolbar
|
|
* @param {Object} [config] Config options
|
|
*/
|
|
ve.ui.HistoryTool = function VeUiHistoryTool( toolbar, config ) {
|
|
// Parent constructor
|
|
ve.ui.Tool.call( this, toolbar, config );
|
|
|
|
// Events
|
|
this.toolbar.getSurface().getModel().connect( this, { 'history': 'onUpdateState' } );
|
|
|
|
// Initialization
|
|
this.setDisabled( true );
|
|
};
|
|
|
|
/* Inheritance */
|
|
|
|
ve.inheritClass( ve.ui.HistoryTool, ve.ui.Tool );
|
|
|
|
/* Static Properties */
|
|
|
|
/**
|
|
* History action method to use.
|
|
*
|
|
* @abstract
|
|
* @static
|
|
* @property {string}
|
|
* @inheritable
|
|
*/
|
|
ve.ui.HistoryTool.static.method = '';
|
|
|
|
/**
|
|
* Surface model method to check state with.
|
|
*
|
|
* @abstract
|
|
* @static
|
|
* @property {string}
|
|
* @inheritable
|
|
*/
|
|
ve.ui.HistoryTool.static.check = '';
|
|
|
|
/* Methods */
|
|
|
|
/**
|
|
* Handle the tool being selected.
|
|
*
|
|
* @method
|
|
*/
|
|
ve.ui.HistoryTool.prototype.onSelect = function () {
|
|
this.toolbar.getSurface().execute( 'history', this.constructor.static.method );
|
|
this.setActive( false );
|
|
};
|
|
|
|
/**
|
|
* 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.HistoryTool.prototype.onUpdateState = function () {
|
|
this.setDisabled( !this.toolbar.getSurface().getModel()[this.constructor.static.check]() );
|
|
};
|
|
|
|
/**
|
|
* @inheritdoc
|
|
*/
|
|
ve.ui.HistoryTool.prototype.destroy = function () {
|
|
this.toolbar.getSurface().getModel().disconnect( this );
|
|
ve.ui.Tool.prototype.destroy.call( this );
|
|
};
|
|
|
|
/**
|
|
* UserInterface undo tool.
|
|
*
|
|
* @class
|
|
* @extends ve.ui.HistoryTool
|
|
* @constructor
|
|
* @param {ve.ui.SurfaceToolbar} toolbar
|
|
* @param {Object} [config] Config options
|
|
*/
|
|
ve.ui.UndoHistoryTool = function VeUiUndoHistoryTool( toolbar, config ) {
|
|
ve.ui.HistoryTool.call( this, toolbar, config );
|
|
};
|
|
ve.inheritClass( ve.ui.UndoHistoryTool, ve.ui.HistoryTool );
|
|
ve.ui.UndoHistoryTool.static.name = 'undo';
|
|
ve.ui.UndoHistoryTool.static.group = 'history';
|
|
ve.ui.UndoHistoryTool.static.icon = 'undo';
|
|
ve.ui.UndoHistoryTool.static.titleMessage = 'visualeditor-historybutton-undo-tooltip';
|
|
ve.ui.UndoHistoryTool.static.method = 'undo';
|
|
ve.ui.UndoHistoryTool.static.check = 'hasPastState';
|
|
ve.ui.toolFactory.register( ve.ui.UndoHistoryTool );
|
|
|
|
/**
|
|
* UserInterface redo tool.
|
|
*
|
|
* @class
|
|
* @extends ve.ui.HistoryTool
|
|
* @constructor
|
|
* @param {ve.ui.SurfaceToolbar} toolbar
|
|
* @param {Object} [config] Config options
|
|
*/
|
|
ve.ui.RedoHistoryTool = function VeUiRedoHistoryTool( toolbar, config ) {
|
|
ve.ui.HistoryTool.call( this, toolbar, config );
|
|
};
|
|
ve.inheritClass( ve.ui.RedoHistoryTool, ve.ui.HistoryTool );
|
|
ve.ui.RedoHistoryTool.static.name = 'redo';
|
|
ve.ui.RedoHistoryTool.static.group = 'history';
|
|
ve.ui.RedoHistoryTool.static.icon = 'redo';
|
|
ve.ui.RedoHistoryTool.static.titleMessage = 'visualeditor-historybutton-redo-tooltip';
|
|
ve.ui.RedoHistoryTool.static.method = 'redo';
|
|
ve.ui.RedoHistoryTool.static.check = 'hasFutureState';
|
|
ve.ui.toolFactory.register( ve.ui.RedoHistoryTool );
|