mediawiki-extensions-Visual.../modules/ve/ui/tools/ve.ui.HistoryButtonTool.js
Timo Tijhof ab7d6bf082 Documentation & clean up
* Commands for Sublime:

  Find*: "(\* @[a-z]+) ([^{].*) \{(.*)\}"
  Replace: "$1 {$3} $2"

  Save all && Close all

  Find: " function("
  Replace: " function ("

  Save all && Close all

  Find: "Intialization"
  Replace: "Initialization"

  Save all && Close all

* Consistent use of types (documented in CODING.rm):
  - Merged {Integer} into {Number}.
  - Merged {DOM Node} into {DOMElement}.

* Remove work-around /*jshint newcap: false */ from ve.js
  Calling Object() as a function to to use the internal
  toObject no longer throws a newcap warning in JSHint.
  It only does that normal functions now .

  (e.g. var a = Cap(); or var a = new uncap();)

* Add missing annotations (@static, @method, ..).

* Remove unused variables

* Remove null-assignments to variables that should just be
  undefined. There's a few variables explicitly set to null
  whereas they are set a few lines under and not used otherwise
  (e.g. 'tx' in ve.ce.Surface.prototype.onPaste)

Change-Id: I0721a08f8ecd93c25595aedaa1aadb0e08b83799
2012-09-17 16:02:52 +02:00

83 lines
2 KiB
JavaScript

/**
* VisualEditor user interface HistoryButtonTool class.
*
* @copyright 2011-2012 VisualEditor Team and others; see AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
/**
* Creates an ve.ui.HistoryButtonTool object.
*
* @class
* @constructor
* @extends {ve.ui.ButtonTool}
* @param {ve.ui.Toolbar} toolbar
* @param {String} name
* @param title
* @param data
*/
ve.ui.HistoryButtonTool = function VeUiHistoryButtonTool( toolbar, name, title, data ) {
// Parent constructor
ve.ui.ButtonTool.call( this, toolbar, name, title );
// Properties
this.data = data;
this.enabled = false;
this.toolbar.getSurfaceView().model.on( 'history', ve.bind( this.updateState, this ) );
};
/* Inheritance */
ve.inheritClass( ve.ui.HistoryButtonTool, ve.ui.ButtonTool );
/* Methods */
ve.ui.HistoryButtonTool.prototype.onClick = function () {
switch ( this.name ) {
case 'undo':
case 'redo':
if ( this.isButtonEnabled( this.name ) ) {
var surfaceView = this.toolbar.getSurfaceView();
surfaceView.stopPolling();
surfaceView.showSelection(
surfaceView.getModel()[this.name]( 1 ) || surfaceView.model.selection
);
surfaceView.clearPollData();
surfaceView.startPolling();
}
break;
}
};
ve.ui.HistoryButtonTool.prototype.updateState = function () {
this.enabled = this.isButtonEnabled( this.name );
this.updateEnabled();
};
ve.ui.HistoryButtonTool.prototype.isButtonEnabled = function ( name ) {
var surfaceModel = this.toolbar.getSurfaceView().getModel();
switch ( name ) {
case 'undo':
return surfaceModel.bigStack.length - surfaceModel.undoIndex > 0;
case 'redo':
return surfaceModel.undoIndex > 0;
default:
return false;
}
};
/* Registration */
ve.ui.Tool.tools.undo = {
'constructor': ve.ui.HistoryButtonTool,
'name': 'undo',
'title': ve.msg( 'visualeditor-historybutton-undo-tooltip' )
};
ve.ui.Tool.tools.redo = {
'constructor': ve.ui.HistoryButtonTool,
'name': 'redo',
'title': ve.msg( 'visualeditor-historybutton-redo-tooltip' )
};