mediawiki-extensions-Visual.../modules/ve/ui/tools/buttons/ve.ui.UndoButtonTool.js
Trevor Parscal 8d33a3de0d Major Documentation Cleanup
* 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
2013-01-16 15:37:59 -08:00

63 lines
1.5 KiB
JavaScript

/*!
* VisualEditor UserInterface UndoButtonTool class.
*
* @copyright 2011-2012 VisualEditor Team and others; see AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
/**
* UserInterface undo button tool.
*
* @class
* @extends ve.ui.ButtonTool
* @constructor
* @param {ve.ui.Toolbar} toolbar
*/
ve.ui.UndoButtonTool = function VeUiUndoButtonTool( toolbar ) {
// Parent constructor
ve.ui.ButtonTool.call( this, toolbar );
// Events
this.toolbar.getSurface().getModel().addListenerMethod( this, 'history', 'onUpdateState' );
// Initialization
this.setDisabled( true );
};
/* Inheritance */
ve.inheritClass( ve.ui.UndoButtonTool, ve.ui.ButtonTool );
/* Static Properties */
ve.ui.UndoButtonTool.static.name = 'undo';
ve.ui.UndoButtonTool.static.titleMessage = 'visualeditor-historybutton-undo-tooltip';
/* Methods */
/**
* Handle the button being clicked.
*
* @method
*/
ve.ui.UndoButtonTool.prototype.onClick = function () {
this.toolbar.getSurface().execute( 'history', 'undo' );
};
/**
* Handle the toolbar state being updated.
*
* @method
* @param {ve.dm.Node[]} nodes List of nodes covered by the current selection
* @param {ve.AnnotationSet} full Annotations that cover all of the current selection
* @param {ve.AnnotationSet} partial Annotations that cover some or all of the current selection
*/
ve.ui.UndoButtonTool.prototype.onUpdateState = function () {
this.setDisabled( !this.toolbar.getSurface().getModel().hasPastState() );
};
/* Registration */
ve.ui.toolFactory.register( 'undo', ve.ui.UndoButtonTool );