mediawiki-extensions-Visual.../modules/ve/actions/ve.InspectorAction.js
James D. Forrester 82114467f1 Bump copyright notice year range to -2013 over -2012
199 files touched. Whee!

Change-Id: Id82ce4a32f833406db4a1cc585674f2bdb39ba0d
2013-02-19 15:37:34 -08:00

60 lines
1.2 KiB
JavaScript

/*!
* VisualEditor InspectorAction class.
*
* @copyright 2011-2013 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 );