mediawiki-extensions-Visual.../modules/ve/ve.Action.js
Trevor Parscal a4e0e83f24 Cleanup tool API
* Moved to tool specific configuration to static properties (left tool instance specific stuff in the constructors)
* Added documentation for tool configurations
* Centralized typePattern matching for inspectors

Change-Id: Ieacf61b320c10fd37ea69a05e543313fa990b403
2012-10-31 11:10:17 -07:00

37 lines
888 B
JavaScript

/**
* VisualEditor Action class.
*
* @copyright 2011-2012 VisualEditor Team and others; see AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
/**
* Generic action.
*
* An action is built around a surface for one-time use. It is a generic way of extending the
* functionality of a surface. Actions are accessible via {ve.Surface.prototype.execute}.
*
* @class
* @constructor
* @param {ve.Surface} surface Surface to act on
*/
ve.Action = function VeAction( surface ) {
// Properties
this.surface = surface;
};
/* Static Members */
ve.Action.static = {};
/**
* List of allowed methods for this action.
*
* To avoid use of methods not intended to be executed via surface.execute(), the methods must be
* whitelisted here. This information is checked by ve.Surface before executing an action.
*
* @static
* @member
*/
ve.Action.static.methods = [];