mediawiki-extensions-Visual.../modules/ve/init/ve.init.Platform.js
Timo Tijhof ab7d6bf082 Documentation & clean up
* Commands for Sublime:

  Find*: "(\* @[a-z]+) ([^{].*) \{(.*)\}"
  Replace: "$1 {$3} $2"

  Save all && Close all

  Find: " function("
  Replace: " function ("

  Save all && Close all

  Find: "Intialization"
  Replace: "Initialization"

  Save all && Close all

* Consistent use of types (documented in CODING.rm):
  - Merged {Integer} into {Number}.
  - Merged {DOM Node} into {DOMElement}.

* Remove work-around /*jshint newcap: false */ from ve.js
  Calling Object() as a function to to use the internal
  toObject no longer throws a newcap warning in JSHint.
  It only does that normal functions now .

  (e.g. var a = Cap(); or var a = new uncap();)

* Add missing annotations (@static, @method, ..).

* Remove unused variables

* Remove null-assignments to variables that should just be
  undefined. There's a few variables explicitly set to null
  whereas they are set a few lines under and not used otherwise
  (e.g. 'tx' in ve.ce.Surface.prototype.onPaste)

Change-Id: I0721a08f8ecd93c25595aedaa1aadb0e08b83799
2012-09-17 16:02:52 +02:00

72 lines
1.7 KiB
JavaScript

/**
* VisualEditor initialization Target class.
*
* @copyright 2011-2012 VisualEditor Team and others; see AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
/**
* Generic platform.
*
* @class
* @abstract
* @constructor
* @extends {ve.EventEmitter}
*/
ve.init.Platform = function VeInitPlatform() {
// Parent constructor
ve.EventEmitter.call( this );
};
/* Inheritance */
ve.inheritClass( ve.init.Platform, ve.EventEmitter );
/* Methods */
/**
* Gets a regular expression that matches allowed external link URLs.
*
* @method
* @abstract
* @returns {RegExp} Regular expression object
*/
ve.init.Platform.prototype.getExternalLinkUrlProtocolsRegExp = function () {
throw new Error( 've.init.Platform.getExternalLinkUrlProtocolsRegExp must be overridden in subclass' );
};
/**
* Gets a remotely accessible URL to the modules directory.
*
* @method
* @abstract
* @returns {String} Remote modules URL
*/
ve.init.Platform.prototype.getModulesUrl = function () {
throw new Error( 've.init.Platform.getModulesUrl must be overridden in subclass' );
};
/**
* Adds multiple messages to the localization system.
*
* @method
* @abstract
* @param {Object} messages Map of message-key/message-string pairs
*/
ve.init.Platform.prototype.addMessages = function () {
throw new Error( 've.init.Platform.addMessages must be overridden in subclass' );
};
/**
* Gets a message from the localization system.
*
* @method
* @abstract
* @param {String} key Message key
* @param {Mixed} [...] List of arguments which will be injected at $1, $2, etc. in the messaage
* @returns {String} Localized message
*/
ve.init.Platform.prototype.getMessage = function () {
throw new Error( 've.init.Platform.getMessage must be overridden in subclass' );
};