mediawiki-extensions-Visual.../modules/ve/ve.Factory.js
Trevor Parscal 443c5438ab Refactored commands into a registry
* Now ve.Factory inherits from the more general ve.Registry
* New class ve.CommandRegistry
* Refactored setupToolbar and command setup code into setupComands

Change-Id: Ic548e5de95b77889727362d3e66d7be83c12a603
2012-11-07 15:52:30 -08:00

77 lines
2.2 KiB
JavaScript

/**
* VisualEditor Factory class.
*
* @copyright 2011-2012 VisualEditor Team and others; see AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
/**
* Generic object factory.
*
* @class
* @abstract
* @constructor
* @extends {ve.Registry}
*/
ve.Factory = function VeFactory() {
// Parent constructor
ve.Registry.call( this );
// Properties
this.registry = [];
};
/* Inheritance */
ve.inheritClass( ve.Factory, ve.Registry );
/* Methods */
/**
* Register a constructor with the factory.
*
* @method
* @param {String|String[]} name Symbolic name or list of symbolic names
* @param {Function} constructor Constructor to use when creating object
* @throws 'constructor must be a function'
*/
ve.Factory.prototype.register = function ( name, constructor ) {
if ( typeof constructor !== 'function' ) {
throw new Error( 'constructor must be a function, cannot be a ' + typeof constructor );
}
ve.Registry.prototype.register.call( this, name, constructor );
};
/**
* Create an object based on a name.
*
* Name is used to look up the constructor to use, while all additional arguments are passed to the
* constructor directly, so leaving one out will pass an undefined to the constructor.
*
* @method
* @param {string} name Object name.
* @param {mixed} [...] Arguments to pass to the constructor.
* @returns {Object} The new object.
* @throws 'Unknown object name'
*/
ve.Factory.prototype.create = function ( name ) {
var args, obj,
constructor = this.registry[name];
if ( constructor === undefined ) {
throw new Error( 'No class registered by that name: ' + name );
}
// Convert arguments to array and shift the first argument (name) off
args = Array.prototype.slice.call( arguments, 1 );
// We can't use the "new" operator with .apply directly because apply needs a
// context. So instead just do what "new" does: create an object that inherits from
// the constructor's prototype (which also makes it an "instanceof" the constructor),
// then invoke the constructor with the object as context, and return it (ignoring
// the constructor's return value).
obj = ve.createObject( constructor.prototype );
constructor.apply( obj, args );
return obj;
};