mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor
synced 2024-09-25 11:16:51 +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
60 lines
1.2 KiB
JavaScript
60 lines
1.2 KiB
JavaScript
/*!
|
|
* VisualEditor InspectorAction class.
|
|
*
|
|
* @copyright 2011-2012 VisualEditor Team and others; see AUTHORS.txt
|
|
* @license The MIT License (MIT); see LICENSE.txt
|
|
*/
|
|
|
|
/**
|
|
* Inspector action.
|
|
*
|
|
* @class
|
|
* @extends ve.Action
|
|
* @constructor
|
|
* @param {ve.Surface} surface Surface to act on
|
|
*/
|
|
ve.InspectorAction = function VeInspectorAction( surface ) {
|
|
// Parent constructor
|
|
ve.Action.call( this, surface );
|
|
};
|
|
|
|
/* Inheritance */
|
|
|
|
ve.inheritClass( ve.InspectorAction, ve.Action );
|
|
|
|
/* Static Properties */
|
|
|
|
/**
|
|
* List of allowed methods for the action.
|
|
*
|
|
* @static
|
|
* @property
|
|
*/
|
|
ve.InspectorAction.static.methods = ['open', 'close'];
|
|
|
|
/* Methods */
|
|
|
|
/**
|
|
* Open an inspector.
|
|
*
|
|
* @method
|
|
* @param {string} name Symbolic name of inspector to open
|
|
*/
|
|
ve.InspectorAction.prototype.open = function ( name ) {
|
|
this.surface.getContext().openInspector( name );
|
|
};
|
|
|
|
/**
|
|
* Close any open inspector.
|
|
*
|
|
* @method
|
|
* @param {boolean} remove Remove annotation being inspected
|
|
*/
|
|
ve.InspectorAction.prototype.close = function ( remove ) {
|
|
this.surface.getContext().closeInspector( remove );
|
|
};
|
|
|
|
/* Registration */
|
|
|
|
ve.actionFactory.register( 'inspector', ve.InspectorAction );
|