mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor
synced 2024-11-15 18:39:52 +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
68 lines
1.5 KiB
JavaScript
68 lines
1.5 KiB
JavaScript
/*!
|
|
* VisualEditor UserInterface IndentationButtonTool class.
|
|
*
|
|
* @copyright 2011-2012 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
|
|
*/
|
|
ve.ui.IndentationButtonTool = function VeUiIndentationButtonTool( toolbar ) {
|
|
// Parent constructor
|
|
ve.ui.ButtonTool.call( this, toolbar );
|
|
};
|
|
|
|
/* Inheritance */
|
|
|
|
ve.inheritClass( ve.ui.IndentationButtonTool, ve.ui.ButtonTool );
|
|
|
|
/* Static Properties */
|
|
|
|
/**
|
|
* Indentation method the button applies.
|
|
*
|
|
* @abstract
|
|
* @static
|
|
* @property
|
|
* @type {string}
|
|
*/
|
|
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 );
|
|
};
|