wikimedia/mediawiki-extensions-VisualEditor
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor synced 2024-11-25 14:56:20 +00:00
Code Issues Packages Projects Releases Wiki Activity
mediawiki-extensions-Visual.../modules/ve/ui/tools/ve.ui.HistoryTool.js

127 lines
3.4 KiB
JavaScript
Raw Normal View History

Make tools generic and add fancy tool groups 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
2013-08-27 23:28:29 +00:00
/*!
* 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
Split oojs-ui from ve.ui * Move and rename generic parts of ve.ui to OO.ui * We now have a UI test suite because ve.Element (outside ve.ui) is now part of oojs-ui, so it needs a test suite. * Added to the MW test run (just like we do for unicodejs). * Updated csslint config (also added ve-mw and syntaxhighlight which were missing). oojs-ui still depends on the TriggerRegistry in VE, this is addressed in a follow-up commit. Change-Id: Iec147155c1ddf20b73a4d15d87b8742207032312
2013-10-09 20:09:59 +00:00
* @extends OO.ui.Tool
Make tools generic and add fancy tool groups 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
2013-08-27 23:28:29 +00:00
* @constructor
Detangle triggers from OOUI Changes: * Pass toolGroup into tools instead of toolbar * Split tool labels into title and accel * Make toolbars provide accelerator labels * Remove getLabelText method since it's not being used and is likely not useful * Make tools update their own labels * Only show accelerator information for triggers that are active in the surface * Make surface toolbars listen to commands being added and update tools accordingly * Introduce command object to encapsulate command info Change-Id: Ieac4bfa63b63ac0a9dee154af3007a33b4d447ff
2013-10-23 23:27:12 +00:00
* @param {OO.ui.ToolGroup} toolGroup
'Config' -> 'Configuration' in all comments Because the former isn't a real word. Change-Id: Ie6ed15f9e390b357bbaa768b57f3c3fd7cf21181
2013-09-25 10:21:09 +00:00
* @param {Object} [config] Configuration options
Make tools generic and add fancy tool groups 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
2013-08-27 23:28:29 +00:00
*/
Detangle triggers from OOUI Changes: * Pass toolGroup into tools instead of toolbar * Split tool labels into title and accel * Make toolbars provide accelerator labels * Remove getLabelText method since it's not being used and is likely not useful * Make tools update their own labels * Only show accelerator information for triggers that are active in the surface * Make surface toolbars listen to commands being added and update tools accordingly * Introduce command object to encapsulate command info Change-Id: Ieac4bfa63b63ac0a9dee154af3007a33b4d447ff
2013-10-23 23:27:12 +00:00
ve.ui.HistoryTool = function VeUiHistoryTool( toolGroup, config ) {
Make tools generic and add fancy tool groups 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
2013-08-27 23:28:29 +00:00
// Parent constructor
Detangle triggers from OOUI Changes: * Pass toolGroup into tools instead of toolbar * Split tool labels into title and accel * Make toolbars provide accelerator labels * Remove getLabelText method since it's not being used and is likely not useful * Make tools update their own labels * Only show accelerator information for triggers that are active in the surface * Make surface toolbars listen to commands being added and update tools accordingly * Introduce command object to encapsulate command info Change-Id: Ieac4bfa63b63ac0a9dee154af3007a33b4d447ff
2013-10-23 23:27:12 +00:00
OO.ui.Tool.call( this, toolGroup, config );
Make tools generic and add fancy tool groups 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
2013-08-27 23:28:29 +00:00
// Events
this.toolbar.getSurface().getModel().connect( this, { 'history': 'onUpdateState' } );
// Initialization
this.setDisabled( true );
};
/* Inheritance */
Split oojs-ui from ve.ui * Move and rename generic parts of ve.ui to OO.ui * We now have a UI test suite because ve.Element (outside ve.ui) is now part of oojs-ui, so it needs a test suite. * Added to the MW test run (just like we do for unicodejs). * Updated csslint config (also added ve-mw and syntaxhighlight which were missing). oojs-ui still depends on the TriggerRegistry in VE, this is addressed in a follow-up commit. Change-Id: Iec147155c1ddf20b73a4d15d87b8742207032312
2013-10-09 20:09:59 +00:00
OO.inheritClass( ve.ui.HistoryTool, OO.ui.Tool );
Make tools generic and add fancy tool groups 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
2013-08-27 23:28:29 +00:00
/* 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 );
Split oojs-ui from ve.ui * Move and rename generic parts of ve.ui to OO.ui * We now have a UI test suite because ve.Element (outside ve.ui) is now part of oojs-ui, so it needs a test suite. * Added to the MW test run (just like we do for unicodejs). * Updated csslint config (also added ve-mw and syntaxhighlight which were missing). oojs-ui still depends on the TriggerRegistry in VE, this is addressed in a follow-up commit. Change-Id: Iec147155c1ddf20b73a4d15d87b8742207032312
2013-10-09 20:09:59 +00:00
OO.ui.Tool.prototype.destroy.call( this );
Make tools generic and add fancy tool groups 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
2013-08-27 23:28:29 +00:00
};
/**
* UserInterface undo tool.
*
* @class
* @extends ve.ui.HistoryTool
* @constructor
Detangle triggers from OOUI Changes: * Pass toolGroup into tools instead of toolbar * Split tool labels into title and accel * Make toolbars provide accelerator labels * Remove getLabelText method since it's not being used and is likely not useful * Make tools update their own labels * Only show accelerator information for triggers that are active in the surface * Make surface toolbars listen to commands being added and update tools accordingly * Introduce command object to encapsulate command info Change-Id: Ieac4bfa63b63ac0a9dee154af3007a33b4d447ff
2013-10-23 23:27:12 +00:00
* @param {OO.ui.ToolGroup} toolGroup
'Config' -> 'Configuration' in all comments Because the former isn't a real word. Change-Id: Ie6ed15f9e390b357bbaa768b57f3c3fd7cf21181
2013-09-25 10:21:09 +00:00
* @param {Object} [config] Configuration options
Make tools generic and add fancy tool groups 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
2013-08-27 23:28:29 +00:00
*/
Detangle triggers from OOUI Changes: * Pass toolGroup into tools instead of toolbar * Split tool labels into title and accel * Make toolbars provide accelerator labels * Remove getLabelText method since it's not being used and is likely not useful * Make tools update their own labels * Only show accelerator information for triggers that are active in the surface * Make surface toolbars listen to commands being added and update tools accordingly * Introduce command object to encapsulate command info Change-Id: Ieac4bfa63b63ac0a9dee154af3007a33b4d447ff
2013-10-23 23:27:12 +00:00
ve.ui.UndoHistoryTool = function VeUiUndoHistoryTool( toolGroup, config ) {
ve.ui.HistoryTool.call( this, toolGroup, config );
Make tools generic and add fancy tool groups 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
2013-08-27 23:28:29 +00:00
};
Remove ve.{inheritClass,mixinClass} and use OO instead Change-Id: I8df9226a358a76b661eab6e967ff0d63d361f691
2013-10-11 21:44:09 +00:00
OO.inheritClass( ve.ui.UndoHistoryTool, ve.ui.HistoryTool );
Make tools generic and add fancy tool groups 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
2013-08-27 23:28:29 +00:00
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
Detangle triggers from OOUI Changes: * Pass toolGroup into tools instead of toolbar * Split tool labels into title and accel * Make toolbars provide accelerator labels * Remove getLabelText method since it's not being used and is likely not useful * Make tools update their own labels * Only show accelerator information for triggers that are active in the surface * Make surface toolbars listen to commands being added and update tools accordingly * Introduce command object to encapsulate command info Change-Id: Ieac4bfa63b63ac0a9dee154af3007a33b4d447ff
2013-10-23 23:27:12 +00:00
* @param {OO.ui.ToolGroup} toolGroup
'Config' -> 'Configuration' in all comments Because the former isn't a real word. Change-Id: Ie6ed15f9e390b357bbaa768b57f3c3fd7cf21181
2013-09-25 10:21:09 +00:00
* @param {Object} [config] Configuration options
Make tools generic and add fancy tool groups 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
2013-08-27 23:28:29 +00:00
*/
Detangle triggers from OOUI Changes: * Pass toolGroup into tools instead of toolbar * Split tool labels into title and accel * Make toolbars provide accelerator labels * Remove getLabelText method since it's not being used and is likely not useful * Make tools update their own labels * Only show accelerator information for triggers that are active in the surface * Make surface toolbars listen to commands being added and update tools accordingly * Introduce command object to encapsulate command info Change-Id: Ieac4bfa63b63ac0a9dee154af3007a33b4d447ff
2013-10-23 23:27:12 +00:00
ve.ui.RedoHistoryTool = function VeUiRedoHistoryTool( toolGroup, config ) {
ve.ui.HistoryTool.call( this, toolGroup, config );
Make tools generic and add fancy tool groups 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
2013-08-27 23:28:29 +00:00
};
Remove ve.{inheritClass,mixinClass} and use OO instead Change-Id: I8df9226a358a76b661eab6e967ff0d63d361f691
2013-10-11 21:44:09 +00:00
OO.inheritClass( ve.ui.RedoHistoryTool, ve.ui.HistoryTool );
Make tools generic and add fancy tool groups 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
2013-08-27 23:28:29 +00:00
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 );
Reference in a new issue Copy permalink