X-Git-Url: https://jasonwoof.com/gitweb/?a=blobdiff_plain;ds=sidebyside;f=_source%2Fplugins%2Fscayt%2Fplugin.js;h=f64d25e8c994f68a68ce4b7600a30910557b7c03;hb=e7789c1ad838194d45eeee6ac2eb6e55f5cf35a1;hp=718aee613969e56883989baa7a193ed754c3ea00;hpb=059b4c2fef02528bf1af189f7996e80652faddfb;p=ckeditor.git

diff --git a/_source/plugins/scayt/plugin.js b/_source/plugins/scayt/plugin.js
index 718aee6..f64d25e 100644
--- a/_source/plugins/scayt/plugin.js
+++ b/_source/plugins/scayt/plugin.js
@@ -12,7 +12,8 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
 {
 	var commandName 	= 'scaytcheck',
 		openPage		= '',
-		scayt_paused	= null;
+		scayt_paused	= null,
+		scayt_control_id = null;
 
 	// Checks if a value exists in an array
 	function in_array(needle, haystack)
@@ -37,21 +38,32 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
 		{
 			// Initialise Scayt instance.
 			var oParams = {};
-			oParams.srcNodeRef = editor.document.getWindow().$.frameElement; 		// Get the iframe.
+			// Get the iframe.
+			oParams.srcNodeRef = editor.document.getWindow().$.frameElement;
 			// syntax : AppName.AppVersion@AppRevision
-			oParams.assocApp  = "CKEDITOR." + CKEDITOR.version + "@" + CKEDITOR.revision;
-			oParams.customerid = editor.config.scayt_customerid  || "1:WvF0D4-UtPqN1-43nkD4-NKvUm2-daQqk3-LmNiI-z7Ysb4-mwry24-T8YrS3-Q2tpq2";
-			oParams.customDictionaryIds = editor.config.scayt_customDictionaryIds;
-			oParams.userDictionaryName = editor.config.scayt_userDictionaryName;
-			oParams.sLang = editor.config.scayt_sLang || "en_US";
+			oParams.assocApp  = 'CKEDITOR.' + CKEDITOR.version + '@' + CKEDITOR.revision;
+			oParams.customerid = editor.config.scayt_customerid  || '1:WvF0D4-UtPqN1-43nkD4-NKvUm2-daQqk3-LmNiI-z7Ysb4-mwry24-T8YrS3-Q2tpq2';
+			oParams.customDictionaryIds = editor.config.scayt_customDictionaryIds || '';
+			oParams.userDictionaryName = editor.config.scayt_userDictionaryName || '';
+			oParams.sLang = editor.config.scayt_sLang || 'en_US';
 
-			if ( CKEDITOR._scaytParams )
+			oParams.onBeforeChange = function()
 			{
-				for ( var k in CKEDITOR._scaytParams )
+				if ( !editor.checkDirty() )
+					setTimeout( function(){ editor.resetDirty(); } );
+			};
+
+			var scayt_custom_params = window.scayt_custom_params;
+			if ( typeof scayt_custom_params == 'object')
+			{
+				for ( var k in scayt_custom_params )
 				{
-					oParams[ k ] = CKEDITOR._scaytParams[ k ];
+					oParams[ k ] = scayt_custom_params[ k ];
 				}
 			}
+			// needs for restoring a specific scayt control settings
+			if ( scayt_control_id )
+				oParams.id = scayt_control_id;
 
 			var scayt_control = new window.scayt( oParams );
 
@@ -72,7 +84,7 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
 			var fTabs  = [];
 
 			for (var i = 0,l=4; i<l; i++)
-				fTabs.push( uiTabs[i] && plugin.uiTabs[i] );
+			    fTabs.push( uiTabs[i] && plugin.uiTabs[i] );
 
 			plugin.uiTabs = fTabs;
 			try {
@@ -105,26 +117,34 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
 			{
 				if ( (ev.data.name == 'source' ||  ev.data.name == 'newpage') && editor.mode == 'wysiwyg' )
 				{
-					var scayt_instanse = plugin.getScayt( editor );
-					if ( scayt_instanse )
+					var scayt_instance = plugin.getScayt( editor );
+					if ( scayt_instance )
 					{
-						scayt_paused = scayt_instanse.paused = !scayt_instanse.disabled;
-						scayt_instanse.destroy();
+						scayt_paused = scayt_instance.paused = !scayt_instance.disabled;
+						// store a control id for restore a specific scayt control settings
+						scayt_control_id = scayt_instance.id;
+						scayt_instance.destroy( true );
 						delete plugin.instances[ editor.name ];
 					}
 				}
 			});
 
-
-		editor.on( 'destroy', function()
+		editor.on( 'destroy', function( ev )
 			{
-				plugin.getScayt( editor ).destroy();
+				var editor = ev.editor,
+					scayt_instance = plugin.getScayt( editor );
+				// store a control id for restore a specific scayt control settings
+				scayt_control_id = scayt_instance.id;
+				scayt_instance.destroy( true );
+				delete plugin.instances[ editor.name ];
 			});
+
 		// Listen to data manipulation to reflect scayt markup.
 		editor.on( 'afterSetData', function()
 			{
-				if ( plugin.isScaytEnabled( editor ) )
-					plugin.getScayt( editor ).refresh();
+				if ( plugin.isScaytEnabled( editor ) ) {
+					window.setTimeout( function(){ plugin.getScayt( editor ).refresh(); }, 10 );
+				}
 			});
 
 		// Reload spell-checking for current word after insertion completed.
@@ -139,16 +159,12 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
 						editor.getSelection().unlock( true );
 
 					// Swallow any SCAYT engine errors.
-					try{
-						scayt_instance.refresh();
-					}catch( er )
-					{}
+					window.setTimeout( function(){ scayt_instance.refresh(); }, 10 );
 				}
 			}, this, null, 50 );
 
 		editor.on( 'insertHtml', function()
 			{
-
 				var scayt_instance = plugin.getScayt( editor );
 				if ( plugin.isScaytEnabled( editor ) )
 				{
@@ -158,10 +174,7 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
 						editor.getSelection().unlock( true );
 
 					// Swallow any SCAYT engine errors.
-					try{
-						scayt_instance.refresh();
-					}catch( er )
-					{}
+					window.setTimeout( function(){ scayt_instance.refresh(); },10 );
 				}
 			}, this, null, 50 );
 
@@ -175,6 +188,7 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
 
 		var dataProcessor = editor.dataProcessor,
 			htmlFilter = dataProcessor && dataProcessor.htmlFilter;
+
 		if ( htmlFilter )
 		{
 			htmlFilter.addRules(
@@ -213,15 +227,19 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
 		},
 		isScaytEnabled : function( editor )
 		{
-			var scayt_instanse = this.getScayt( editor );
-			return ( scayt_instanse ) ? scayt_instanse.disabled === false : false;
+			var scayt_instance = this.getScayt( editor );
+			return ( scayt_instance ) ? scayt_instance.disabled === false : false;
 		},
 		loadEngine : function( editor )
 		{
+			// SCAYT doesn't work with Opera.
+			if ( CKEDITOR.env.opera )
+				return null;
+
 			if ( this.engineLoaded === true )
 				return onEngineLoad.apply( editor );	// Add new instance.
 			else if ( this.engineLoaded == -1 )			// We are waiting.
-				return CKEDITOR.on( 'scaytReady', function(){ onEngineLoad.apply( editor );} );	// Use function(){} to avoid rejection as duplicate.
+				return CKEDITOR.on( 'scaytReady', function(){ onEngineLoad.apply( editor ); } );	// Use function(){} to avoid rejection as duplicate.
 
 			CKEDITOR.on( 'scaytReady', onEngineLoad, editor );
 			CKEDITOR.on( 'scaytReady', function()
@@ -230,7 +248,8 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
 				},
 				this,
 				null,
-				0 );	// First to run.
+				0
+			);	// First to run.
 
 			this.engineLoaded = -1;	// Loading in progress.
 
@@ -238,10 +257,10 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
 			var protocol = document.location.protocol;
 			// Default to 'http' for unknown.
 			protocol = protocol.search( /https?:/) != -1? protocol : 'http:';
-			var baseUrl  = "svc.spellchecker.net/spellcheck3/lf/scayt/scayt21.js";
+			var baseUrl  = 'svc.spellchecker.net/spellcheck31/lf/scayt/scayt22.js';
 
-			var scaytUrl  =  editor.config.scayt_srcUrl || ( protocol + "//" + baseUrl );
-			var scaytConfigBaseUrl =  plugin.parseUrl( scaytUrl ).path +  "/";
+			var scaytUrl  =  editor.config.scayt_srcUrl || ( protocol + '//' + baseUrl );
+			var scaytConfigBaseUrl =  plugin.parseUrl( scaytUrl ).path +  '/';
 
 			CKEDITOR._djScaytConfig =
 			{
@@ -250,7 +269,7 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
 				[
 					function()
 					{
-						CKEDITOR.fireOnce( "scaytReady" );
+						CKEDITOR.fireOnce( 'scaytReady' );
 					}
 				],
 				isDebug: false
@@ -350,14 +369,15 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
 			// Add Options dialog.
 			CKEDITOR.dialog.add( commandName, CKEDITOR.getUrl( this.path + 'dialogs/options.js' ) );
 			// read ui tags
-			var confuiTabs = editor.config.scayt_uiTabs || "1,1,1";
+			var confuiTabs = editor.config.scayt_uiTabs || '1,1,1';
 			var uiTabs =[];
-			// string tp array convert
-			confuiTabs = confuiTabs.split(",");
-			// check array length ! allwaays must be 3 filled with 1 or 0
-			for (var i=0,l=3; i<l; i++){
-				var flag = parseInt(confuiTabs[i] || "1" ,10);
-				uiTabs.push(  flag  );
+			// string to array convert
+			confuiTabs = confuiTabs.split( ',' );
+			// check array length ! always must be 3 filled with 1 or 0
+			for (var i=0,l=3; i<l; i++)
+			{
+				var flag = parseInt(confuiTabs[i] || '1' ,10);
+				uiTabs.push( flag );
 			}
 
 			var menuGroup = 'scaytButton';
@@ -365,7 +385,7 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
 			// combine menu items to render
 			var uiMuneItems = {};
 
-			// allways added
+			// always added
 			uiMuneItems.scaytToggle =
 				{
 					label : editor.lang.scayt.enable,
@@ -407,7 +427,7 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
 						editor.openDialog( commandName );
 					}
 				};
-			// allways added
+			// always added
 			uiMuneItems.scaytAbout =
 				{
 					label : editor.lang.scayt.about,
@@ -420,7 +440,7 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
 				}
 			;
 
-			uiTabs[3] = 1; // about us tab is allways on
+			uiTabs[3] = 1; // about us tab is always on
 			plugin.uiTabs = uiTabs;
 
 			editor.addMenuItems( uiMuneItems );
@@ -457,13 +477,18 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
 			// If the "contextmenu" plugin is loaded, register the listeners.
 			if ( editor.contextMenu && editor.addMenuItems )
 			{
-				editor.contextMenu.addListener( function( element )
+				editor.contextMenu.addListener( function(  )
 					{
-						if ( !( plugin.isScaytEnabled( editor ) && element ) )
+						if ( !plugin.isScaytEnabled( editor ) )
 							return null;
 
 						var scayt_control = plugin.getScayt( editor ),
-							word = scayt_control.getWord( element.$ );
+							node = scayt_control.getScaytNode();
+
+						if ( !node )
+							return null;
+
+							var word = scayt_control.getWord( node );
 
 						if ( !word )
 							return null;
@@ -471,7 +496,7 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
 						var sLang = scayt_control.getLang(),
 							_r = {},
 							items_suggestion = window.scayt.getSuggestion( word, sLang );
-						if (!items_suggestion || !items_suggestion.length )
+						if ( !items_suggestion || !items_suggestion.length )
 							return null;
 						// Remove unused commands and menuitems
 						for ( i in moreSuggestions )
@@ -487,15 +512,15 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
 						moreSuggestions = {};		// Reset items.
 						mainSuggestions = {};
 
-						var moreSuggestionsUnable = editor.config.scayt_moreSuggestions || "on";
+						var moreSuggestionsUnable = editor.config.scayt_moreSuggestions || 'on';
 						var moreSuggestionsUnableAdded = false;
 
 						var maxSuggestions = editor.config.scayt_maxSuggestions;
 						( typeof maxSuggestions != 'number' ) && ( maxSuggestions = 5 );
 						!maxSuggestions && ( maxSuggestions = items_suggestion.length );
 
-						var contextCommands = editor.config.scayt_contextCommands || "all";
-						contextCommands = contextCommands.split("|");
+						var contextCommands = editor.config.scayt_contextCommands || 'all';
+						contextCommands = contextCommands.split( '|' );
 
 						for ( var i = 0, l = items_suggestion.length; i < l; i += 1 )
 						{
@@ -508,7 +533,7 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
 											scayt_control.replace(el, s);
 										}
 									};
-								})( element.$, items_suggestion[i] );
+								})( node, items_suggestion[i] );
 
 							if ( i < maxSuggestions )
 							{
@@ -517,7 +542,7 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
 								_r[ commandName ] = CKEDITOR.TRISTATE_OFF;
 								mainSuggestions[ commandName ] = CKEDITOR.TRISTATE_OFF;
 							}
-							else if ( moreSuggestionsUnable == "on" )
+							else if ( moreSuggestionsUnable == 'on' )
 							{
 								addButtonCommand( editor, 'button_' + commandName, items_suggestion[i],
 									commandName, exec, 'scayt_moresuggest', i + 1 );
@@ -526,8 +551,9 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
 							}
 						}
 
-						if ( moreSuggestionsUnableAdded ){
-							// Rgister the More suggestions group;
+						if ( moreSuggestionsUnableAdded )
+						{
+							// Register the More suggestions group;
 							editor.addMenuItem( 'scayt_moresuggest',
 							{
 								label : editor.lang.scayt.moreSuggestions,
@@ -539,36 +565,35 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
 								}
 							});
 							mainSuggestions[ 'scayt_moresuggest' ] = CKEDITOR.TRISTATE_OFF;
-
 						}
 
-						if ( in_array( "all",contextCommands )  || in_array("ignore",contextCommands)  )
+						if ( in_array( 'all', contextCommands )  || in_array( 'ignore', contextCommands)  )
 						{
 							var ignore_command = {
 								exec: function(){
-									scayt_control.ignore(element.$);
+									scayt_control.ignore( node );
 								}
 							};
-							addButtonCommand(editor, 'ignore', editor.lang.scayt.ignore, 'scayt_ignore', ignore_command, 'scayt_control', 1);
-							mainSuggestions['scayt_ignore'] = CKEDITOR.TRISTATE_OFF;
+							addButtonCommand( editor, 'ignore', editor.lang.scayt.ignore, 'scayt_ignore', ignore_command, 'scayt_control', 1 );
+							mainSuggestions[ 'scayt_ignore' ] = CKEDITOR.TRISTATE_OFF;
 						}
 
-						if ( in_array( "all",contextCommands )  || in_array("ignoreall",contextCommands)  )
+						if ( in_array( 'all', contextCommands )  || in_array( 'ignoreall', contextCommands ) )
 						{
 							var ignore_all_command = {
 								exec: function(){
-									scayt_control.ignoreAll(element.$);
+									scayt_control.ignoreAll( node );
 								}
 							};
 							addButtonCommand(editor, 'ignore_all', editor.lang.scayt.ignoreAll, 'scayt_ignore_all', ignore_all_command, 'scayt_control', 2);
 							mainSuggestions['scayt_ignore_all'] = CKEDITOR.TRISTATE_OFF;
 						}
 
-						if ( in_array( "all",contextCommands )  || in_array("add",contextCommands)  )
+						if ( in_array( 'all', contextCommands )  || in_array( 'add', contextCommands ) )
 						{
 							var addword_command = {
 								exec: function(){
-									window.scayt.addWordToUserDictionary(element.$);
+									window.scayt.addWordToUserDictionary( node );
 								}
 							};
 							addButtonCommand(editor, 'add_word', editor.lang.scayt.addWord, 'scayt_add_word', addword_command, 'scayt_control', 3);
@@ -591,13 +616,152 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
 					command.setState( plugin.isScaytEnabled( editor ) ? CKEDITOR.TRISTATE_ON : CKEDITOR.TRISTATE_OFF );
 				};
 				editor.on( 'showScaytState', showInitialState );
+				editor.on( 'instanceReady', function()
+				{
+					plugin.loadEngine( editor );
+				});
+			}
+		},
 
-				plugin.loadEngine( editor );
+		afterInit : function( editor )
+		{
+			// Prevent word marker line from displaying in elements path. (#3570)
+			var elementsPathFilters;
+			if ( editor._.elementsPath && ( elementsPathFilters = editor._.elementsPath.filters ) )
+			{
+				elementsPathFilters.push( function( element )
+				{
+					if ( element.hasAttribute( 'scaytid' ) )
+						return false;
+				} );
 			}
+
 		}
 	});
 })();
 
-// TODO: Documentation
-// CKEDITOR.config.scayt_maxSuggestions
-// CKEDITOR.config.scayt_autoStartup
+/**
+ * If enabled (true), turns on SCAYT automatically after loading the editor.
+ * @name CKEDITOR.config.scayt_autoStartup
+ * @type Boolean
+ * @default false
+ * @example
+ * config.scayt_autoStartup = true;
+ */
+
+/**
+ * Defines the number of SCAYT suggestions to show in the main context menu.
+ * The possible values are:
+ * <ul>
+ *	<li>0 (zero): All suggestions are displayed in the main context menu.</li>
+ *	<li>Positive number: The maximum number of suggestions to shown in context
+ *		menu. Other entries will be shown in "More Suggestions" sub-menu.</li>
+ *	<li>Negative number: No suggestions are shown in the main context menu. All
+ *		entries will be listed in the "Suggestions" sub-menu.</li>
+ * </ul>
+ * @name CKEDITOR.config.scayt_maxSuggestions
+ * @type Number
+ * @default 5
+ * @example
+ * // Display only three suggestions in the main context menu.
+ * config.scayt_maxSuggestions = 3;
+ * @example
+ * // Do not show the suggestions directly.
+ * config.scayt_maxSuggestions = -1;
+ */
+
+/**
+ * Sets the customer ID for SCAYT. Required for migration from free version
+ * with banner to paid version.
+ * @name CKEDITOR.config.scayt_customerid
+ * @type String
+ * @default ''
+ * @example
+ * // Load SCAYT using my customer ID.
+ * config.scayt_customerid  = 'your-encrypted-customer-id';
+ */
+
+/**
+ * Enables/disables the "More Suggestions" sub-menu in the context menu.
+ * The possible values are "on" or "off".
+ * @name CKEDITOR.config.scayt_moreSuggestions
+ * @type String
+ * @default 'on'
+ * @example
+ * // Disables the "More Suggestions" sub-menu.
+ * config.scayt_moreSuggestions = 'off';
+ */
+
+/**
+ * Customizes the display of SCAYT context menu commands ("Add Word", "Ignore"
+ * and "Ignore All"). It must be a string with one or more of the following
+ * words separated by a pipe ("|"):
+ * <ul>
+ *	<li>"off": disables all options.</li>
+ *	<li>"all": enables all options.</li>
+ *	<li>"ignore": enables the "Ignore" option.</li>
+ *	<li>"ignoreall": enables the "Ignore All" option.</li>
+ *	<li>"add": enables the "Add Word" option.</li>
+ * </ul>
+ * @name CKEDITOR.config.scayt_contextCommands
+ * @type String
+ * @default 'all'
+ * @example
+ * // Show only "Add Word" and "Ignore All" in the context menu.
+ * config.scayt_contextCommands = 'add|ignoreall';
+ */
+
+/**
+ * Sets the default spellchecking language for SCAYT.
+ * @name CKEDITOR.config.scayt_sLang
+ * @type String
+ * @default 'en_US'
+ * @example
+ * // Sets SCAYT to German.
+ * config.scayt_sLang = 'de_DE';
+ */
+
+/**
+ * Sets the visibility of the SCAYT tabs in the settings dialog and toolbar
+ * button. The value must contain a "1" (enabled) or "0" (disabled) number for
+ * each of the following entries, in this precise order, separated by a
+ * comma (","): "Options", "Languages" and "Dictionary".
+ * @name CKEDITOR.config.scayt_uiTabs
+ * @type String
+ * @default '1,1,1'
+ * @example
+ * // Hide the "Languages" tab.
+ * config.scayt_uiTabs = '1,0,1';
+ */
+
+
+/**
+ * Set the URL to SCAYT core. Required to switch to licensed version of SCAYT application.
+ * Further details at http://wiki.spellchecker.net/doku.php?id=3rd:wysiwyg:fckeditor:wscckf3l .
+ * @name CKEDITOR.config.scayt_srcUrl
+ * @type String
+ * @default ''
+ * @example
+ * config.scayt_srcUrl = "http://my-host/spellcheck/lf/scayt/scayt.js";
+ */
+
+/**
+ * Links SCAYT to custom dictionaries. It's a string containing dictionary ids
+ * separared by commas (","). Available only for licensed version.
+ * Further details at http://wiki.spellchecker.net/doku.php?id=custom_dictionary_support .
+ * @name CKEDITOR.config.scayt_customDictionaryIds
+ * @type String
+ * @default ''
+ * @example
+ * config.scayt_customDictionaryIds = '3021,3456,3478"';
+ */
+
+/**
+ * Makes it possible to activate a custom dictionary on SCAYT. The user
+ * dictionary name must be used. Available only for licensed version.
+ * @name CKEDITOR.config.scayt_userDictionaryName
+ * @type String
+ * @default ''
+ * @example
+ * config.scayt_userDictionaryName = 'MyDictionary';
+ */