mediawiki-extensions-VisualEditor/modules/ve/ui/tools/ve.ui.InspectorButtonTool.js

/**
 * VisualEditor user interface InspectorButtonTool class.
 *
 * @copyright 2011-2012 VisualEditor Team and others; see AUTHORS.txt
 * @license The MIT License (MIT); see LICENSE.txt
 */

/**
 * Creates an ve.ui.InspectorButtonTool object.
 *
 * @abstract
 * @class
 * @constructor
 * @extends {ve.ui.ButtonTool}
 * @param {ve.ui.Toolbar} toolbar
 */
ve.ui.InspectorButtonTool = function VeUiInspectorButtonTool( toolbar ) {
	// Parent constructor
	ve.ui.ButtonTool.call( this, toolbar );
};

/* Inheritance */

ve.inheritClass( ve.ui.InspectorButtonTool, ve.ui.ButtonTool );

/* Static Members */

/**
 * Symbolic name of inspector this button opens.
 *
 * @abstract
 * @static
 * @member
 * @type {String}
 */
ve.ui.InspectorButtonTool.static.inspector = '';

/* Methods */

/**
 * Responds to the button being clicked.
 *
 * @method
 */
ve.ui.InspectorButtonTool.prototype.onClick = function () {
	this.toolbar.getSurface().execute( 'inspector', 'open', this.constructor.static.inspector );
};

/**
 * Responds to the toolbar state being updated.
 *
 * @method
 * @param {ve.dm.Node[]} nodes List of nodes covered by the current selection
 * @param {ve.dm.AnnotationSet} full Annotations that cover all of the current selection
 * @param {ve.dm.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 )
		)
	);
};