mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor
synced 2024-11-25 14:56:20 +00:00
8d33a3de0d
* Made method descriptions imperative: "Do this" rather than "Does this" * Changed use of "this object" to "the object" in method documentation * Added missing documentation * Fixed incorrect documentation * Fixed incorrect debug method names (as in those VeDmClassName tags we add to functions so they make sense when dumped into in the console) * Normalized use of package names throughout * Normalized class descriptions * Removed incorrect @abstract tags * Added missing @method tags * Lots of other minor cleanup Change-Id: I4ea66a2dd107613e2ea3a5f56ff54d675d72957e
64 lines
1.1 KiB
JavaScript
64 lines
1.1 KiB
JavaScript
/*!
|
|
* VisualEditor HistoryAction class.
|
|
*
|
|
* @copyright 2011-2012 VisualEditor Team and others; see AUTHORS.txt
|
|
* @license The MIT License (MIT); see LICENSE.txt
|
|
*/
|
|
|
|
/**
|
|
* History action.
|
|
*
|
|
* @class
|
|
* @extends ve.Action
|
|
* @constructor
|
|
* @param {ve.Surface} surface Surface to act on
|
|
*/
|
|
ve.HistoryAction = function VeHistoryAction( surface ) {
|
|
// Parent constructor
|
|
ve.Action.call( this, surface );
|
|
};
|
|
|
|
/* Inheritance */
|
|
|
|
ve.inheritClass( ve.HistoryAction, ve.Action );
|
|
|
|
/* Static Properties */
|
|
|
|
/**
|
|
* List of allowed methods for the action.
|
|
*
|
|
* @static
|
|
* @property
|
|
*/
|
|
ve.HistoryAction.static.methods = ['undo', 'redo'];
|
|
|
|
/* Methods */
|
|
|
|
/**
|
|
* Step backwards in time.
|
|
*
|
|
* @method
|
|
*/
|
|
ve.HistoryAction.prototype.undo = function () {
|
|
var range = this.surface.getModel().undo();
|
|
if ( range ) {
|
|
this.surface.getView().showSelection( range );
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Step forwards in time.
|
|
*
|
|
* @method
|
|
*/
|
|
ve.HistoryAction.prototype.redo = function () {
|
|
var range = this.surface.getModel().redo();
|
|
if ( range ) {
|
|
this.surface.getView().showSelection( range );
|
|
}
|
|
};
|
|
|
|
/* Registration */
|
|
|
|
ve.actionFactory.register( 'history', ve.HistoryAction );
|