mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor
synced 2024-09-27 20:26:46 +00:00
c53685b865
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
65 lines
1.6 KiB
JavaScript
65 lines
1.6 KiB
JavaScript
/*!
|
|
* VisualEditor UserInterface InspectorButtonTool class.
|
|
*
|
|
* @copyright 2011-2013 VisualEditor Team and others; see AUTHORS.txt
|
|
* @license The MIT License (MIT); see LICENSE.txt
|
|
*/
|
|
|
|
/**
|
|
* UserInterface inspector button tool.
|
|
*
|
|
* @abstract
|
|
* @class
|
|
* @extends ve.ui.ButtonTool
|
|
* @constructor
|
|
* @param {ve.ui.Toolbar} toolbar
|
|
* @param {Object} [config] Config options
|
|
*/
|
|
ve.ui.InspectorButtonTool = function VeUiInspectorButtonTool( toolbar, config ) {
|
|
// Parent constructor
|
|
ve.ui.ButtonTool.call( this, toolbar, config );
|
|
};
|
|
|
|
/* Inheritance */
|
|
|
|
ve.inheritClass( ve.ui.InspectorButtonTool, ve.ui.ButtonTool );
|
|
|
|
/* Static Properties */
|
|
|
|
/**
|
|
* Symbolic name of inspector the button opens.
|
|
*
|
|
* @abstract
|
|
* @static
|
|
* @property {string}
|
|
* @inheritable
|
|
*/
|
|
ve.ui.InspectorButtonTool.static.inspector = '';
|
|
|
|
/* Methods */
|
|
|
|
/**
|
|
* Handle the button being clicked.
|
|
*
|
|
* @method
|
|
*/
|
|
ve.ui.InspectorButtonTool.prototype.onClick = function () {
|
|
this.toolbar.getSurface().execute( 'inspector', 'open', this.constructor.static.inspector );
|
|
};
|
|
|
|
/**
|
|
* 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.InspectorButtonTool.prototype.onUpdateState = function ( nodes, full ) {
|
|
this.setActive(
|
|
full.hasAnnotationWithName(
|
|
ve.ui.inspectorFactory.getTypePattern( this.constructor.static.inspector )
|
|
)
|
|
);
|
|
};
|