mediawiki-extensions-Visual.../modules/ve/ve.TriggerRegistry.js
Rob Moen 8ba81f4d67 Add interplatform, i18n shortcuts to ui buttons.
Objective:
* Put command shortcuts in button title attributes. (Bug 42919)
* Provide a registry for platform specific command triggers and their
corresponding i18n messages. (Bug 44012)
* Enable loading of triggers after ve.Surface is created. (lazy load)

Changes:

VisualEditor.i18n.php
* Add default trigger i18n messags for mac and pc system platforms

VisusalEditor.php, demos/ve/index.php
* Add links to files

ve.init.mw.Platform.js
* Define getUserLanguage and getSystemPlatform methods.

ve.init.sa.Platform.js
* Define getUserLanguage and getSystemPlatform methods.

ve.init.Platform.js
* Define abstract methods: getUserLangauge, getSystemPlatform

ve.ui.BoldBUttonTool.js, ve.ui.IndentButtonTool.js, ve.ui.ItalicButtonTool.js,
ve.ui.LinkButtonTool.js, ve.ui.OutdentButtonTool.js, ve.ui.RedoButtonTool.js,
ve.ui.UndoButtonTool.js
* Add registration for command triggers.

ve.Surface.js
* Methodize loading of triggers.
* Bind register event to ve.triggerRegistry to allow lazy loading of triggers.

ve.ui.Tool.js
* Init pre-registered tooltip messages.
* Update tool titles when new triggers are loaded.

ve.CommandRegistry.js
* Remove command registration ( moved to buttons themselves )

ve.TriggerRegistry.js
* New class for registering triggers.

ve.init.mw.ViewPageTarget.js
* Changed instance of unindent command to outdent.

Change-Id: Id8580a3f81aac751db0b7482422a73912648dfed
2013-01-17 15:28:32 -08:00

59 lines
1.8 KiB
JavaScript

/*!
* VisualEditor TriggerRegistry class.
*
* @copyright 2011-2012 VisualEditor Team and others; see AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
/**
* Trigger registry.
*
* @class
* @extends ve.Registry
* @constructor
*/
ve.TriggerRegistry = function VeTriggerRegistry() {
// Parent constructor
ve.Registry.call( this );
};
/* Inheritance */
ve.inheritClass( ve.TriggerRegistry, ve.Registry );
/* Methods */
/**
* Register a constructor with the factory.
*
* @method
* @param {string|string[]} config.name Symbolic name or list of symbolic names
* @param {object} config.trigger Command string of keys that should trigger the command
* @param {string|string[]} config.trigger Command string of keys that should trigger the command
*/
ve.TriggerRegistry.prototype.register = function ( config ) {
var platform = ve.init.platform.getSystemPlatform(),
key = platform === 'mac' ? 'mac' : 'pc';
if ( typeof config.name !== 'string' && !ve.isArray( config.name ) ) {
throw new Error( 'name must be a string or array, cannot be a ' + typeof config.name );
}
if ( typeof config.trigger !== 'string' && !ve.isPlainObject( config.trigger ) ) {
throw new Error( 'trigger must be a string or an object, cannot be a ' + typeof config.trigger );
}
if ( typeof config.labelMessage !== 'string' && !ve.isPlainObject( config.labelMessage ) ) {
throw new Error( 'label must be a string or an object, cannot be a ' + typeof config.labelMessage );
}
ve.Registry.prototype.register.call(
this, config.name,
{
'trigger': ve.isPlainObject( config.trigger ) ? config.trigger[key] : config.trigger,
'labelMessage': ve.isPlainObject( config.labelMessage ) ? config.labelMessage[key] : config.labelMessage
}
);
};
/* Initialization */
ve.triggerRegistry = new ve.TriggerRegistry();