254 lines
8.0 KiB
JavaScript
254 lines
8.0 KiB
JavaScript
/**
|
|
* AddOnManager.js
|
|
*
|
|
* Copyright, Moxiecode Systems AB
|
|
* Released under LGPL License.
|
|
*
|
|
* License: http://www.tinymce.com/license
|
|
* Contributing: http://www.tinymce.com/contributing
|
|
*/
|
|
|
|
/**
|
|
* This class handles the loading of themes/plugins or other add-ons and their language packs.
|
|
*
|
|
* @class tinymce.AddOnManager
|
|
*/
|
|
define("tinymce/AddOnManager", [
|
|
"tinymce/dom/ScriptLoader",
|
|
"tinymce/util/Tools"
|
|
], function(ScriptLoader, Tools) {
|
|
var each = Tools.each;
|
|
|
|
function AddOnManager() {
|
|
var self = this;
|
|
|
|
self.items = [];
|
|
self.urls = {};
|
|
self.lookup = {};
|
|
}
|
|
|
|
AddOnManager.prototype = {
|
|
/**
|
|
* Returns the specified add on by the short name.
|
|
*
|
|
* @method get
|
|
* @param {String} name Add-on to look for.
|
|
* @return {tinymce.Theme/tinymce.Plugin} Theme or plugin add-on instance or undefined.
|
|
*/
|
|
get: function(name) {
|
|
if (this.lookup[name]) {
|
|
return this.lookup[name].instance;
|
|
} else {
|
|
return undefined;
|
|
}
|
|
},
|
|
|
|
dependencies: function(name) {
|
|
var result;
|
|
|
|
if (this.lookup[name]) {
|
|
result = this.lookup[name].dependencies;
|
|
}
|
|
|
|
return result || [];
|
|
},
|
|
|
|
/**
|
|
* Loads a language pack for the specified add-on.
|
|
*
|
|
* @method requireLangPack
|
|
* @param {String} name Short name of the add-on.
|
|
*/
|
|
requireLangPack: function(name) {
|
|
var settings = AddOnManager.settings;
|
|
|
|
if (settings && settings.language && settings.language_load !== false) {
|
|
ScriptLoader.ScriptLoader.add(this.urls[name] + '/langs/' + settings.language + '.js');
|
|
}
|
|
},
|
|
|
|
/**
|
|
* Adds a instance of the add-on by it's short name.
|
|
*
|
|
* @method add
|
|
* @param {String} id Short name/id for the add-on.
|
|
* @param {tinymce.Theme/tinymce.Plugin} addOn Theme or plugin to add.
|
|
* @return {tinymce.Theme/tinymce.Plugin} The same theme or plugin instance that got passed in.
|
|
* @example
|
|
* // Create a simple plugin
|
|
* tinymce.create('tinymce.plugins.TestPlugin', {
|
|
* TestPlugin: function(ed, url) {
|
|
* ed.on('click', function(e) {
|
|
* ed.windowManager.alert('Hello World!');
|
|
* });
|
|
* }
|
|
* });
|
|
*
|
|
* // Register plugin using the add method
|
|
* tinymce.PluginManager.add('test', tinymce.plugins.TestPlugin);
|
|
*
|
|
* // Initialize TinyMCE
|
|
* tinymce.init({
|
|
* ...
|
|
* plugins: '-test' // Init the plugin but don't try to load it
|
|
* });
|
|
*/
|
|
add: function(id, addOn, dependencies) {
|
|
this.items.push(addOn);
|
|
this.lookup[id] = {instance: addOn, dependencies: dependencies};
|
|
|
|
return addOn;
|
|
},
|
|
|
|
createUrl: function(baseUrl, dep) {
|
|
if (typeof dep === "object") {
|
|
return dep;
|
|
} else {
|
|
return {prefix: baseUrl.prefix, resource: dep, suffix: baseUrl.suffix};
|
|
}
|
|
},
|
|
|
|
/**
|
|
* Add a set of components that will make up the add-on. Using the url of the add-on name as the base url.
|
|
* This should be used in development mode. A new compressor/javascript munger process will ensure that the
|
|
* components are put together into the plugin.js file and compressed correctly.
|
|
*
|
|
* @method addComponents
|
|
* @param {String} pluginName name of the plugin to load scripts from (will be used to get the base url for the plugins).
|
|
* @param {Array} scripts Array containing the names of the scripts to load.
|
|
*/
|
|
addComponents: function(pluginName, scripts) {
|
|
var pluginUrl = this.urls[pluginName];
|
|
|
|
each(scripts, function(script) {
|
|
ScriptLoader.ScriptLoader.add(pluginUrl + "/" + script);
|
|
});
|
|
},
|
|
|
|
/**
|
|
* Loads an add-on from a specific url.
|
|
*
|
|
* @method load
|
|
* @param {String} n Short name of the add-on that gets loaded.
|
|
* @param {String} u URL to the add-on that will get loaded.
|
|
* @param {function} cb Optional callback to execute ones the add-on is loaded.
|
|
* @param {Object} s Optional scope to execute the callback in.
|
|
* @example
|
|
* // Loads a plugin from an external URL
|
|
* tinymce.PluginManager.load('myplugin', '/some/dir/someplugin/plugin.js');
|
|
*
|
|
* // Initialize TinyMCE
|
|
* tinymce.init({
|
|
* ...
|
|
* plugins: '-myplugin' // Don't try to load it again
|
|
* });
|
|
*/
|
|
load: function(n, u, cb, s) {
|
|
var t = this, url = u;
|
|
|
|
function loadDependencies() {
|
|
var dependencies = t.dependencies(n);
|
|
|
|
each(dependencies, function(dep) {
|
|
var newUrl = t.createUrl(u, dep);
|
|
|
|
t.load(newUrl.resource, newUrl, undefined, undefined);
|
|
});
|
|
|
|
if (cb) {
|
|
if (s) {
|
|
cb.call(s);
|
|
} else {
|
|
cb.call(ScriptLoader);
|
|
}
|
|
}
|
|
}
|
|
|
|
if (t.urls[n]) {
|
|
return;
|
|
}
|
|
|
|
if (typeof u === "object") {
|
|
url = u.prefix + u.resource + u.suffix;
|
|
}
|
|
|
|
if (url.indexOf('/') !== 0 && url.indexOf('://') == -1) {
|
|
url = AddOnManager.baseURL + '/' + url;
|
|
}
|
|
|
|
t.urls[n] = url.substring(0, url.lastIndexOf('/'));
|
|
|
|
if (t.lookup[n]) {
|
|
loadDependencies();
|
|
} else {
|
|
ScriptLoader.ScriptLoader.add(url, loadDependencies, s);
|
|
}
|
|
}
|
|
};
|
|
|
|
AddOnManager.PluginManager = new AddOnManager();
|
|
AddOnManager.ThemeManager = new AddOnManager();
|
|
|
|
return AddOnManager;
|
|
});
|
|
|
|
/**
|
|
* TinyMCE theme class.
|
|
*
|
|
* @class tinymce.Theme
|
|
*/
|
|
|
|
/**
|
|
* This method is responsible for rendering/generating the overall user interface with toolbars, buttons, iframe containers etc.
|
|
*
|
|
* @method renderUI
|
|
* @param {Object} obj Object parameter containing the targetNode DOM node that will be replaced visually with an editor instance.
|
|
* @return {Object} an object with items like iframeContainer, editorContainer, sizeContainer, deltaWidth, deltaHeight.
|
|
*/
|
|
|
|
/**
|
|
* Plugin base class, this is a pseudo class that describes how a plugin is to be created for TinyMCE. The methods below are all optional.
|
|
*
|
|
* @class tinymce.Plugin
|
|
* @example
|
|
* tinymce.PluginManager.add('example', function(editor, url) {
|
|
* // Add a button that opens a window
|
|
* editor.addButton('example', {
|
|
* text: 'My button',
|
|
* icon: false,
|
|
* onclick: function() {
|
|
* // Open window
|
|
* editor.windowManager.open({
|
|
* title: 'Example plugin',
|
|
* body: [
|
|
* {type: 'textbox', name: 'title', label: 'Title'}
|
|
* ],
|
|
* onsubmit: function(e) {
|
|
* // Insert content when the window form is submitted
|
|
* editor.insertContent('Title: ' + e.data.title);
|
|
* }
|
|
* });
|
|
* }
|
|
* });
|
|
*
|
|
* // Adds a menu item to the tools menu
|
|
* editor.addMenuItem('example', {
|
|
* text: 'Example plugin',
|
|
* context: 'tools',
|
|
* onclick: function() {
|
|
* // Open window with a specific url
|
|
* editor.windowManager.open({
|
|
* title: 'TinyMCE site',
|
|
* url: 'http://www.tinymce.com',
|
|
* width: 800,
|
|
* height: 600,
|
|
* buttons: [{
|
|
* text: 'Close',
|
|
* onclick: 'close'
|
|
* }]
|
|
* });
|
|
* }
|
|
* });
|
|
* });
|
|
*/
|