mediawiki-extensions-Visual.../modules/ve/ui/tools/ve.ui.ClearButtonTool.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

69 lines
1.7 KiB
JavaScript

/**
* VisualEditor user interface ClearButtonTool class.
*
* @copyright 2011-2012 VisualEditor Team and others; see AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
/**
* Creates an ve.ui.ClearButtonTool object.
*
* @class
* @constructor
* @extends {ve.ui.ButtonTool}
* @param {ve.ui.Toolbar} toolbar
* @param {String} name
* @param title
*/
ve.ui.ClearButtonTool = function VeUiClearButtonTool( toolbar, name, title ) {
// Parent constructor
ve.ui.ButtonTool.call( this, toolbar, name, title );
// Properties
this.$.addClass( 've-ui-toolbarButtonTool-disabled' );
this.pattern = /^(textStyle|link)\//;
};
/* Inheritance */
ve.inheritClass( ve.ui.ClearButtonTool, ve.ui.ButtonTool );
/* Methods */
ve.ui.ClearButtonTool.prototype.getAnnotations = function () {
var surface = this.toolbar.getSurfaceView(),
model = surface.getModel();
return model.getDocument().getAnnotationsFromRange( model.getSelection(), true );
};
ve.ui.ClearButtonTool.prototype.onClick = function () {
var i,
surfaceView = this.toolbar.getSurfaceView(),
model = surfaceView.getModel(),
annotations = this.getAnnotations(),
arr = annotations.get();
for ( i = 0; i < arr.length; i++ ) {
model.annotate( 'clear', arr[i] );
}
surfaceView.showSelection( model.getSelection() );
surfaceView.contextView.closeInspector();
};
ve.ui.ClearButtonTool.prototype.updateState = function () {
var allAnnotations = this.getAnnotations();
if ( allAnnotations.isEmpty() ) {
this.$.addClass( 've-ui-toolbarButtonTool-disabled' );
} else {
this.$.removeClass( 've-ui-toolbarButtonTool-disabled' );
}
};
/* Registration */
ve.ui.Tool.tools.clear = {
'constructor': ve.ui.ClearButtonTool,
'name': 'clear',
'title': ve.msg( 'visualeditor-clearbutton-tooltip' )
};