--- /dev/null
+/*\r
+Copyright (c) 2003-2009, CKSource - Frederico Knabben. All rights reserved.\r
+For licensing, see LICENSE.html or http://ckeditor.com/license\r
+*/\r
+\r
+/**\r
+ * @fileOverview Defines the {@link CKEDITOR.editor} class, which represents an\r
+ * editor instance.\r
+ */\r
+\r
+(function()\r
+{\r
+ // The counter for automatic instance names.\r
+ var nameCounter = 0;\r
+\r
+ var getNewName = function()\r
+ {\r
+ var name = 'editor' + ( ++nameCounter );\r
+ return ( CKEDITOR.instances && CKEDITOR.instances[ name ] ) ? getNewName() : name;\r
+ };\r
+\r
+ // ##### START: Config Privates\r
+\r
+ // These function loads custom configuration files and cache the\r
+ // CKEDITOR.editorConfig functions defined on them, so there is no need to\r
+ // download them more than once for several instances.\r
+ var loadConfigLoaded = {};\r
+ var loadConfig = function( editor )\r
+ {\r
+ var customConfig = editor.config.customConfig;\r
+\r
+ // Check if there is a custom config to load.\r
+ if ( !customConfig )\r
+ return false;\r
+\r
+ var loadedConfig = loadConfigLoaded[ customConfig ] || ( loadConfigLoaded[ customConfig ] = {} );\r
+\r
+ // If the custom config has already been downloaded, reuse it.\r
+ if ( loadedConfig.fn )\r
+ {\r
+ // Call the cached CKEDITOR.editorConfig defined in the custom\r
+ // config file for the editor instance depending on it.\r
+ loadedConfig.fn.call( editor, editor.config );\r
+\r
+ // If there is no other customConfig in the chain, fire the\r
+ // "configLoaded" event.\r
+ if ( editor.config.customConfig == customConfig || !loadConfig( editor ) )\r
+ editor.fireOnce( 'customConfigLoaded' );\r
+ }\r
+ else\r
+ {\r
+ // Load the custom configuration file.\r
+ CKEDITOR.scriptLoader.load( customConfig, function()\r
+ {\r
+ // If the CKEDITOR.editorConfig function has been properly\r
+ // defined in the custom configuration file, cache it.\r
+ if ( CKEDITOR.editorConfig )\r
+ loadedConfig.fn = CKEDITOR.editorConfig;\r
+ else\r
+ loadedConfig.fn = function(){};\r
+\r
+ // Call the load config again. This time the custom\r
+ // config is already cached and so it will get loaded.\r
+ loadConfig( editor );\r
+ });\r
+ }\r
+\r
+ return true;\r
+ };\r
+\r
+ var initConfig = function( editor, instanceConfig )\r
+ {\r
+ // Setup the lister for the "customConfigLoaded" event.\r
+ editor.on( 'customConfigLoaded', function()\r
+ {\r
+ if ( instanceConfig )\r
+ {\r
+ // Register the events that may have been set at the instance\r
+ // configuration object.\r
+ if ( instanceConfig.on )\r
+ {\r
+ for ( var eventName in instanceConfig.on )\r
+ {\r
+ editor.on( eventName, instanceConfig.on[ eventName ] );\r
+ }\r
+ }\r
+\r
+ // Overwrite the settings from the in-page config.\r
+ CKEDITOR.tools.extend( editor.config, instanceConfig, true );\r
+\r
+ delete editor.config.on;\r
+ }\r
+\r
+ onConfigLoaded( editor );\r
+ });\r
+\r
+ // The instance config may override the customConfig setting to avoid\r
+ // loading the default ~/config.js file.\r
+ if ( instanceConfig && instanceConfig.customConfig != undefined )\r
+ editor.config.customConfig = instanceConfig.customConfig;\r
+\r
+ // Load configs from the custom configuration files.\r
+ if ( !loadConfig( editor ) )\r
+ editor.fireOnce( 'customConfigLoaded' );\r
+ };\r
+\r
+ // ##### END: Config Privates\r
+\r
+ var onConfigLoaded = function( editor )\r
+ {\r
+ // Set config related properties.\r
+\r
+ var skin = editor.config.skin.split( ',' ),\r
+ skinName = skin[ 0 ],\r
+ skinPath = CKEDITOR.getUrl( skin[ 1 ] || (\r
+ 'skins/' + skinName + '/' ) );\r
+\r
+ editor.skinName = skinName;\r
+ editor.skinPath = skinPath;\r
+ editor.skinClass = 'cke_skin_' + skinName;\r
+\r
+ // Fire the "configLoaded" event.\r
+ editor.fireOnce( 'configLoaded' );\r
+\r
+ // Load language file.\r
+ loadLang( editor );\r
+ };\r
+\r
+ var loadLang = function( editor )\r
+ {\r
+ CKEDITOR.lang.load( editor.config.language, editor.config.defaultLanguage, function( languageCode, lang )\r
+ {\r
+ editor.langCode = languageCode;\r
+\r
+ // As we'll be adding plugin specific entries that could come\r
+ // from different language code files, we need a copy of lang,\r
+ // not a direct reference to it.\r
+ editor.lang = CKEDITOR.tools.prototypedCopy( lang );\r
+\r
+ // We're not able to support RTL in Firefox 2 at this time.\r
+ if ( CKEDITOR.env.gecko && CKEDITOR.env.version < 10900 && editor.lang.dir == 'rtl' )\r
+ editor.lang.dir = 'ltr';\r
+\r
+ loadPlugins( editor );\r
+ });\r
+ };\r
+\r
+ var loadPlugins = function( editor )\r
+ {\r
+ var config = editor.config,\r
+ plugins = config.plugins,\r
+ extraPlugins = config.extraPlugins,\r
+ removePlugins = config.removePlugins;\r
+\r
+ if ( extraPlugins )\r
+ {\r
+ // Remove them first to avoid duplications.\r
+ var removeRegex = new RegExp( '(?:^|,)(?:' + extraPlugins.replace( /\s*,\s*/g, '|' ) + ')(?=,|$)' , 'g' );\r
+ plugins = plugins.replace( removeRegex, '' );\r
+\r
+ plugins += ',' + extraPlugins;\r
+ }\r
+\r
+ if ( removePlugins )\r
+ {\r
+ removeRegex = new RegExp( '(?:^|,)(?:' + removePlugins.replace( /\s*,\s*/g, '|' ) + ')(?=,|$)' , 'g' );\r
+ plugins = plugins.replace( removeRegex, '' );\r
+ }\r
+\r
+ // Load all plugins defined in the "plugins" setting.\r
+ CKEDITOR.plugins.load( plugins.split( ',' ), function( plugins )\r
+ {\r
+ // The list of plugins.\r
+ var pluginsArray = [];\r
+\r
+ // The language code to get loaded for each plugin. Null\r
+ // entries will be appended for plugins with no language files.\r
+ var languageCodes = [];\r
+\r
+ // The list of URLs to language files.\r
+ var languageFiles = [];\r
+\r
+ // Cache the loaded plugin names.\r
+ editor.plugins = plugins;\r
+\r
+ // Loop through all plugins, to build the list of language\r
+ // files to get loaded.\r
+ for ( var pluginName in plugins )\r
+ {\r
+ var plugin = plugins[ pluginName ],\r
+ pluginLangs = plugin.lang,\r
+ pluginPath = CKEDITOR.plugins.getPath( pluginName ),\r
+ lang = null;\r
+\r
+ // Set the plugin path in the plugin.\r
+ plugin.path = pluginPath;\r
+\r
+ // If the plugin has "lang".\r
+ if ( pluginLangs )\r
+ {\r
+ // Resolve the plugin language. If the current language\r
+ // is not available, get the first one (default one).\r
+ lang = ( CKEDITOR.tools.indexOf( pluginLangs, editor.langCode ) >= 0 ? editor.langCode : pluginLangs[ 0 ] );\r
+\r
+ if ( !plugin.lang[ lang ] )\r
+ {\r
+ // Put the language file URL into the list of files to\r
+ // get downloaded.\r
+ languageFiles.push( CKEDITOR.getUrl( pluginPath + 'lang/' + lang + '.js' ) );\r
+ }\r
+ else\r
+ {\r
+ CKEDITOR.tools.extend( editor.lang, plugin.lang[ lang ] );\r
+ lang = null;\r
+ }\r
+ }\r
+\r
+ // Save the language code, so we know later which\r
+ // language has been resolved to this plugin.\r
+ languageCodes.push( lang );\r
+\r
+ pluginsArray.push( plugin );\r
+ }\r
+\r
+ // Load all plugin specific language files in a row.\r
+ CKEDITOR.scriptLoader.load( languageFiles, function()\r
+ {\r
+ // Initialize all plugins that have the "beforeInit" and "init" methods defined.\r
+ var methods = [ 'beforeInit', 'init', 'afterInit' ];\r
+ for ( var m = 0 ; m < methods.length ; m++ )\r
+ {\r
+ for ( var i = 0 ; i < pluginsArray.length ; i++ )\r
+ {\r
+ var plugin = pluginsArray[ i ];\r
+\r
+ // Uses the first loop to update the language entries also.\r
+ if ( m === 0 && languageCodes[ i ] && plugin.lang )\r
+ CKEDITOR.tools.extend( editor.lang, plugin.lang[ languageCodes[ i ] ] );\r
+\r
+ // Call the plugin method (beforeInit and init).\r
+ if ( plugin[ methods[ m ] ] )\r
+ plugin[ methods[ m ] ]( editor );\r
+ }\r
+ }\r
+\r
+ // Load the editor skin.\r
+ editor.fire( 'pluginsLoaded' );\r
+ loadSkin( editor );\r
+ });\r
+ });\r
+ };\r
+\r
+ var loadSkin = function( editor )\r
+ {\r
+ CKEDITOR.skins.load( editor, 'editor', function()\r
+ {\r
+ loadTheme( editor );\r
+ });\r
+ };\r
+\r
+ var loadTheme = function( editor )\r
+ {\r
+ var theme = editor.config.theme;\r
+ CKEDITOR.themes.load( theme, function()\r
+ {\r
+ var editorTheme = editor.theme = CKEDITOR.themes.get( theme );\r
+ editorTheme.path = CKEDITOR.themes.getPath( theme );\r
+ editorTheme.build( editor );\r
+\r
+ if ( editor.config.autoUpdateElement )\r
+ attachToForm( editor );\r
+ });\r
+ };\r
+\r
+ var attachToForm = function( editor )\r
+ {\r
+ var element = editor.element;\r
+\r
+ // If are replacing a textarea, we must\r
+ if ( editor.elementMode == CKEDITOR.ELEMENT_MODE_REPLACE && element.is( 'textarea' ) )\r
+ {\r
+ var form = element.$.form && new CKEDITOR.dom.element( element.$.form );\r
+ if ( form )\r
+ {\r
+ function onSubmit()\r
+ {\r
+ editor.updateElement();\r
+ }\r
+ form.on( 'submit',onSubmit );\r
+\r
+ // Setup the submit function because it doesn't fire the\r
+ // "submit" event.\r
+ if ( !form.$.submit.nodeName )\r
+ {\r
+ form.$.submit = CKEDITOR.tools.override( form.$.submit, function( originalSubmit )\r
+ {\r
+ return function()\r
+ {\r
+ editor.updateElement();\r
+\r
+ // For IE, the DOM submit function is not a\r
+ // function, so we need thid check.\r
+ if ( originalSubmit.apply )\r
+ originalSubmit.apply( this, arguments );\r
+ else\r
+ originalSubmit();\r
+ };\r
+ });\r
+ }\r
+\r
+ // Remove 'submit' events registered on form element before destroying.(#3988)\r
+ editor.on( 'destroy', function()\r
+ {\r
+ form.removeListener( 'submit', onSubmit );\r
+ } );\r
+ }\r
+ }\r
+ };\r
+\r
+ function updateCommandsMode()\r
+ {\r
+ var command,\r
+ commands = this._.commands,\r
+ mode = this.mode;\r
+\r
+ for ( var name in commands )\r
+ {\r
+ command = commands[ name ];\r
+ command[ command.modes[ mode ] ? 'enable' : 'disable' ]();\r
+ }\r
+ }\r
+\r
+ /**\r
+ * Initializes the editor instance. This function is called by the editor\r
+ * contructor (editor_basic.js).\r
+ * @private\r
+ */\r
+ CKEDITOR.editor.prototype._init = function()\r
+ {\r
+ // Get the properties that have been saved in the editor_base\r
+ // implementation.\r
+ var element = CKEDITOR.dom.element.get( this._.element ),\r
+ instanceConfig = this._.instanceConfig;\r
+ delete this._.element;\r
+ delete this._.instanceConfig;\r
+\r
+ this._.commands = {};\r
+ this._.styles = [];\r
+\r
+ /**\r
+ * The DOM element that has been replaced by this editor instance. This\r
+ * element holds the editor data on load and post.\r
+ * @name CKEDITOR.editor.prototype.element\r
+ * @type CKEDITOR.dom.element\r
+ * @example\r
+ * var editor = CKEDITOR.instances.editor1;\r
+ * alert( <b>editor.element</b>.getName() ); "textarea"\r
+ */\r
+ this.element = element;\r
+\r
+ /**\r
+ * The editor instance name. It hay be the replaced element id, name or\r
+ * a default name using a progressive counter (editor1, editor2, ...).\r
+ * @name CKEDITOR.editor.prototype.name\r
+ * @type String\r
+ * @example\r
+ * var editor = CKEDITOR.instances.editor1;\r
+ * alert( <b>editor.name</b> ); "editor1"\r
+ */\r
+ this.name = ( element && ( this.elementMode == CKEDITOR.ELEMENT_MODE_REPLACE )\r
+ && ( element.getId() || element.getNameAtt() ) )\r
+ || getNewName();\r
+\r
+ if ( this.name in CKEDITOR.instances )\r
+ throw '[CKEDITOR.editor] The instance "' + this.name + '" already exists.';\r
+\r
+ /**\r
+ * The configurations for this editor instance. It inherits all\r
+ * settings defined in (@link CKEDITOR.config}, combined with settings\r
+ * loaded from custom configuration files and those defined inline in\r
+ * the page when creating the editor.\r
+ * @name CKEDITOR.editor.prototype.config\r
+ * @type Object\r
+ * @example\r
+ * var editor = CKEDITOR.instances.editor1;\r
+ * alert( <b>editor.config.theme</b> ); "default" e.g.\r
+ */\r
+ this.config = CKEDITOR.tools.prototypedCopy( CKEDITOR.config );\r
+\r
+ /**\r
+ * Namespace containing UI features related to this editor instance.\r
+ * @name CKEDITOR.editor.prototype.ui\r
+ * @type CKEDITOR.ui\r
+ * @example\r
+ */\r
+ this.ui = new CKEDITOR.ui( this );\r
+\r
+ /**\r
+ * Controls the focus state of this editor instance. This property\r
+ * is rarely used for normal API operations. It is mainly\r
+ * destinated to developer adding UI elements to the editor interface.\r
+ * @name CKEDITOR.editor.prototype.focusManager\r
+ * @type CKEDITOR.focusManager\r
+ * @example\r
+ */\r
+ this.focusManager = new CKEDITOR.focusManager( this );\r
+\r
+ CKEDITOR.fire( 'instanceCreated', null, this );\r
+\r
+ this.on( 'mode', updateCommandsMode, null, null, 1 );\r
+\r
+ initConfig( this, instanceConfig );\r
+ };\r
+})();\r
+\r
+CKEDITOR.tools.extend( CKEDITOR.editor.prototype,\r
+ /** @lends CKEDITOR.editor.prototype */\r
+ {\r
+ /**\r
+ * Adds a command definition to the editor instance. Commands added with\r
+ * this function can be later executed with {@link #execCommand}.\r
+ * @param {String} commandName The indentifier name of the command.\r
+ * @param {CKEDITOR.commandDefinition} commandDefinition The command definition.\r
+ * @example\r
+ * editorInstance.addCommand( 'sample',\r
+ * {\r
+ * exec : function( editor )\r
+ * {\r
+ * alert( 'Executing a command for the editor name "' + editor.name + '"!' );\r
+ * }\r
+ * });\r
+ */\r
+ addCommand : function( commandName, commandDefinition )\r
+ {\r
+ return this._.commands[ commandName ] = new CKEDITOR.command( this, commandDefinition );\r
+ },\r
+\r
+ addCss : function( css )\r
+ {\r
+ this._.styles.push( css );\r
+ },\r
+\r
+ /**\r
+ * Destroys the editor instance, releasing all resources used by it.\r
+ * If the editor replaced an element, the element will be recovered.\r
+ * @param {Boolean} [noUpdate] If the instance is replacing a DOM\r
+ * element, this parameter indicates whether or not to update the\r
+ * element with the instance contents.\r
+ * @example\r
+ * alert( CKEDITOR.instances.editor1 ); e.g "object"\r
+ * <b>CKEDITOR.instances.editor1.destroy()</b>;\r
+ * alert( CKEDITOR.instances.editor1 ); "undefined"\r
+ */\r
+ destroy : function( noUpdate )\r
+ {\r
+ if ( !noUpdate )\r
+ this.updateElement();\r
+\r
+ this.theme.destroy( this );\r
+ this.fire( 'destroy' );\r
+ CKEDITOR.remove( this );\r
+ },\r
+\r
+ /**\r
+ * Executes a command.\r
+ * @param {String} commandName The indentifier name of the command.\r
+ * @param {Object} [data] Data to be passed to the command\r
+ * @returns {Boolean} "true" if the command has been successfuly\r
+ * executed, otherwise "false".\r
+ * @example\r
+ * editorInstance.execCommand( 'Bold' );\r
+ */\r
+ execCommand : function( commandName, data )\r
+ {\r
+ var command = this.getCommand( commandName );\r
+\r
+ var eventData =\r
+ {\r
+ name: commandName,\r
+ commandData: data,\r
+ command: command\r
+ };\r
+\r
+ if ( command && command.state != CKEDITOR.TRISTATE_DISABLED )\r
+ {\r
+ if ( this.fire( 'beforeCommandExec', eventData ) !== true )\r
+ {\r
+ eventData.returnValue = command.exec( eventData.commandData );\r
+\r
+ // Fire the 'afterCommandExec' immediately if command is synchronous.\r
+ if ( !command.async && this.fire( 'afterCommandExec', eventData ) !== true )\r
+ return eventData.returnValue;\r
+ }\r
+ }\r
+\r
+ // throw 'Unknown command name "' + commandName + '"';\r
+ return false;\r
+ },\r
+\r
+ /**\r
+ * Gets one of the registered commands. Note that, after registering a\r
+ * command definition with addCommand, it is transformed internally\r
+ * into an instance of {@link CKEDITOR.command}, which will be then\r
+ * returned by this function.\r
+ * @param {String} commandName The name of the command to be returned.\r
+ * This is the same used to register the command with addCommand.\r
+ * @returns {CKEDITOR.command} The command object identified by the\r
+ * provided name.\r
+ */\r
+ getCommand : function( commandName )\r
+ {\r
+ return this._.commands[ commandName ];\r
+ },\r
+\r
+ /**\r
+ * Gets the editor data. The data will be in raw format. It is the same\r
+ * data that is posted by the editor.\r
+ * @type String\r
+ * @returns (String) The editor data.\r
+ * @example\r
+ * if ( CKEDITOR.instances.editor1.<b>getData()</b> == '' )\r
+ * alert( 'There is no data available' );\r
+ */\r
+ getData : function()\r
+ {\r
+ this.fire( 'beforeGetData' );\r
+\r
+ var eventData = this._.data;\r
+\r
+ if ( typeof eventData != 'string' )\r
+ {\r
+ var element = this.element;\r
+ if ( element && this.elementMode == CKEDITOR.ELEMENT_MODE_REPLACE )\r
+ eventData = element.is( 'textarea' ) ? element.getValue() : element.getHtml();\r
+ else\r
+ eventData = '';\r
+ }\r
+\r
+ eventData = { dataValue : eventData };\r
+\r
+ // Fire "getData" so data manipulation may happen.\r
+ this.fire( 'getData', eventData );\r
+\r
+ return eventData.dataValue;\r
+ },\r
+\r
+ getSnapshot : function()\r
+ {\r
+ var data = this.fire( 'getSnapshot' );\r
+\r
+ if ( typeof data != 'string' )\r
+ {\r
+ var element = this.element;\r
+ if ( element && this.elementMode == CKEDITOR.ELEMENT_MODE_REPLACE )\r
+ data = element.is( 'textarea' ) ? element.getValue() : element.getHtml();\r
+ }\r
+\r
+ return data;\r
+ },\r
+\r
+ loadSnapshot : function( snapshot )\r
+ {\r
+ this.fire( 'loadSnapshot', snapshot );\r
+ },\r
+\r
+ /**\r
+ * Sets the editor data. The data must be provided in raw format.\r
+ * @param {String} data HTML code to replace the curent content in the editor.\r
+ * @example\r
+ * CKEDITOR.instances.editor1.<b>setData( '<p>This is the editor data.</p>' )</b>;\r
+ */\r
+ setData : function( data )\r
+ {\r
+ // Fire "setData" so data manipulation may happen.\r
+ var eventData = { dataValue : data };\r
+ this.fire( 'setData', eventData );\r
+\r
+ this._.data = eventData.dataValue;\r
+\r
+ this.fire( 'afterSetData', eventData );\r
+ },\r
+\r
+ /**\r
+ * Inserts HTML into the currently selected position in the editor.\r
+ * @param {String} data HTML code to be inserted into the editor.\r
+ * @example\r
+ * CKEDITOR.instances.editor1.<b>insertHtml( '<p>This is a new paragraph.</p>' )</b>;\r
+ */\r
+ insertHtml : function( data )\r
+ {\r
+ this.fire( 'insertHtml', data );\r
+ },\r
+\r
+ /**\r
+ * Inserts an element into the currently selected position in the\r
+ * editor.\r
+ * @param {CKEDITOR.dom.element} element The element to be inserted\r
+ * into the editor.\r
+ * @example\r
+ * var element = CKEDITOR.dom.element.createFromHtml( '<img src="hello.png" border="0" title="Hello" />' );\r
+ * CKEDITOR.instances.editor1.<b>insertElement( element )</b>;\r
+ */\r
+ insertElement : function( element )\r
+ {\r
+ this.fire( 'insertElement', element );\r
+ },\r
+\r
+ checkDirty : function()\r
+ {\r
+ return ( this.mayBeDirty && this._.previousValue !== this.getSnapshot() );\r
+ },\r
+\r
+ resetDirty : function()\r
+ {\r
+ if ( this.mayBeDirty )\r
+ this._.previousValue = this.getSnapshot();\r
+ },\r
+\r
+ /**\r
+ * Updates the <textarea> element that has been replaced by the editor with\r
+ * the current data available in the editor.\r
+ * @example\r
+ * CKEDITOR.instances.editor1.updateElement();\r
+ * alert( document.getElementById( 'editor1' ).value ); // The current editor data.\r
+ */\r
+ updateElement : function()\r
+ {\r
+ var element = this.element;\r
+ if ( element && this.elementMode == CKEDITOR.ELEMENT_MODE_REPLACE )\r
+ {\r
+ if ( element.is( 'textarea' ) )\r
+ element.setValue( this.getData() );\r
+ else\r
+ element.setHtml( this.getData() );\r
+ }\r
+ }\r
+ });\r
+\r
+CKEDITOR.on( 'loaded', function()\r
+ {\r
+ // Run the full initialization for pending editors.\r
+ var pending = CKEDITOR.editor._pending;\r
+ if ( pending )\r
+ {\r
+ delete CKEDITOR.editor._pending;\r
+\r
+ for ( var i = 0 ; i < pending.length ; i++ )\r
+ pending[ i ]._init();\r
+ }\r
+ });\r
Got questions, comments, patches, etc.? Contact Jason Woofenden