mediawiki-extensions-Visual.../modules/ve/ui/tools/ve.ui.IndentationButtonTool.js
Timo Tijhof c53685b865 Doc: Replace "@property @type {Type}" with "@property {Type}".
Also removed a few redundant headings in class documentation
comments. There is already an @class and it looks a bit odd  in
the generated pages:
 <h2>TextString</h2>
 <p>TextString</p>
 <p>This class provides a ...</p>

Change-Id: Ie311c6993ed02e79272dbde71f6a1bc252ef3037
2013-03-28 21:21:56 +01:00

69 lines
1.6 KiB
JavaScript

/*!
* VisualEditor UserInterface IndentationButtonTool class.
*
* @copyright 2011-2013 VisualEditor Team and others; see AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
/**
* UserInterface intentation button tool.
*
* @abstract
* @class
* @extends ve.ui.ButtonTool
* @constructor
* @param {ve.ui.Toolbar} toolbar
* @param {Object} [config] Config options
*/
ve.ui.IndentationButtonTool = function VeUiIndentationButtonTool( toolbar, config ) {
// Parent constructor
ve.ui.ButtonTool.call( this, toolbar, config );
};
/* Inheritance */
ve.inheritClass( ve.ui.IndentationButtonTool, ve.ui.ButtonTool );
/* Static Properties */
/**
* Indentation method the button applies.
*
* @abstract
* @static
* @property {string}
* @inheritable
*/
ve.ui.IndentationButtonTool.static.method = '';
/* Methods */
/**
* Handle the button being clicked.
*
* @method
*/
ve.ui.IndentationButtonTool.prototype.onClick = function () {
this.toolbar.getSurface().execute( 'indentation', this.constructor.static.method );
};
/**
* 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.IndentationButtonTool.prototype.onUpdateState = function ( nodes ) {
var i, len,
any = false;
for ( i = 0, len = nodes.length; i < len; i++ ) {
if ( nodes[i].hasMatchingAncestor( 'listItem' ) ) {
any = true;
break;
}
}
this.setDisabled( !any );
};