mediawiki-extensions-Visual.../modules/ve/ve.ActionFactory.js
Trevor Parscal 8d33a3de0d Major Documentation Cleanup
* 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
2013-01-16 15:37:59 -08:00

44 lines
942 B
JavaScript

/*!
* VisualEditor ActionFactory class.
*
* @copyright 2011-2012 VisualEditor Team and others; see AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
/**
* Action factory.
*
* @class
* @extends ve.Factory
* @constructor
*/
ve.ActionFactory = function VeActionFactory() {
// Parent constructor
ve.Factory.call( this );
};
/* Inheritance */
ve.inheritClass( ve.ActionFactory, ve.Factory );
/* Methods */
/**
* Check if an action supports a method.
*
* @method
* @param {string} action Name of action
* @param {string} method Name of method
* @returns {boolean} The action supports the method
*/
ve.ActionFactory.prototype.doesActionSupportMethod = function ( action, method ) {
if ( action in this.registry ) {
return this.registry[action].static.methods.indexOf( method ) !== -1;
}
throw new Error( 'Unknown action: ' + action );
};
/* Initialization */
ve.actionFactory = new ve.ActionFactory();