Update to 4.7.3

[perso/Immae/Projets/packagist/ludivine-ckeditor-component.git] / sources / plugins / indent / plugin.js

/**\r
 * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved.\r
 * For licensing, see LICENSE.md or http://ckeditor.com/license\r
 */\r
\r
/**\r
 * @fileOverview Increase and Decrease Indent commands.\r
 */\r
\r
( function() {\r
	'use strict';\r
\r
	var TRISTATE_DISABLED = CKEDITOR.TRISTATE_DISABLED,\r
		TRISTATE_OFF = CKEDITOR.TRISTATE_OFF;\r
\r
	CKEDITOR.plugins.add( 'indent', {\r
		// jscs:disable maximumLineLength\r
		lang: 'af,ar,az,bg,bn,bs,ca,cs,cy,da,de,de-ch,el,en,en-au,en-ca,en-gb,eo,es,es-mx,et,eu,fa,fi,fo,fr,fr-ca,gl,gu,he,hi,hr,hu,id,is,it,ja,ka,km,ko,ku,lt,lv,mk,mn,ms,nb,nl,no,oc,pl,pt,pt-br,ro,ru,si,sk,sl,sq,sr,sr-latn,sv,th,tr,tt,ug,uk,vi,zh,zh-cn', // %REMOVE_LINE_CORE%\r
		// jscs:enable maximumLineLength\r
		icons: 'indent,indent-rtl,outdent,outdent-rtl', // %REMOVE_LINE_CORE%\r
		hidpi: true, // %REMOVE_LINE_CORE%\r
\r
		init: function( editor ) {\r
			var genericDefinition = CKEDITOR.plugins.indent.genericDefinition;\r
\r
			// Register generic commands.\r
			setupGenericListeners( editor, editor.addCommand( 'indent', new genericDefinition( true ) ) );\r
			setupGenericListeners( editor, editor.addCommand( 'outdent', new genericDefinition() ) );\r
\r
			// Create and register toolbar button if possible.\r
			if ( editor.ui.addButton ) {\r
				editor.ui.addButton( 'Indent', {\r
					label: editor.lang.indent.indent,\r
					command: 'indent',\r
					directional: true,\r
					toolbar: 'indent,20'\r
				} );\r
\r
				editor.ui.addButton( 'Outdent', {\r
					label: editor.lang.indent.outdent,\r
					command: 'outdent',\r
					directional: true,\r
					toolbar: 'indent,10'\r
				} );\r
			}\r
\r
			// Register dirChanged listener.\r
			editor.on( 'dirChanged', function( evt ) {\r
				var range = editor.createRange(),\r
					dataNode = evt.data.node;\r
\r
				range.setStartBefore( dataNode );\r
				range.setEndAfter( dataNode );\r
\r
				var walker = new CKEDITOR.dom.walker( range ),\r
					node;\r
\r
				while ( ( node = walker.next() ) ) {\r
					if ( node.type == CKEDITOR.NODE_ELEMENT ) {\r
						// A child with the defined dir is to be ignored.\r
						if ( !node.equals( dataNode ) && node.getDirection() ) {\r
							range.setStartAfter( node );\r
							walker = new CKEDITOR.dom.walker( range );\r
							continue;\r
						}\r
\r
						// Switch alignment classes.\r
						var classes = editor.config.indentClasses;\r
						if ( classes ) {\r
							var suffix = ( evt.data.dir == 'ltr' ) ? [ '_rtl', '' ] : [ '', '_rtl' ];\r
							for ( var i = 0; i < classes.length; i++ ) {\r
								if ( node.hasClass( classes[ i ] + suffix[ 0 ] ) ) {\r
									node.removeClass( classes[ i ] + suffix[ 0 ] );\r
									node.addClass( classes[ i ] + suffix[ 1 ] );\r
								}\r
							}\r
						}\r
\r
						// Switch the margins.\r
						var marginLeft = node.getStyle( 'margin-right' ),\r
							marginRight = node.getStyle( 'margin-left' );\r
\r
						marginLeft ? node.setStyle( 'margin-left', marginLeft ) : node.removeStyle( 'margin-left' );\r
						marginRight ? node.setStyle( 'margin-right', marginRight ) : node.removeStyle( 'margin-right' );\r
					}\r
				}\r
			} );\r
		}\r
	} );\r
\r
	/**\r
	 * Global command class definitions and global helpers.\r
	 *\r
	 * @class\r
	 * @singleton\r
	 */\r
	CKEDITOR.plugins.indent = {\r
		/**\r
		 * A base class for a generic command definition, responsible mainly for creating\r
		 * Increase Indent and Decrease Indent toolbar buttons as well as for refreshing\r
		 * UI states.\r
		 *\r
		 * Commands of this class do not perform any indentation by themselves. They\r
		 * delegate this job to content-specific indentation commands (i.e. indentlist).\r
		 *\r
		 * @class CKEDITOR.plugins.indent.genericDefinition\r
		 * @extends CKEDITOR.commandDefinition\r
		 * @param {CKEDITOR.editor} editor The editor instance this command will be\r
		 * applied to.\r
		 * @param {String} name The name of the command.\r
		 * @param {Boolean} [isIndent] Defines the command as indenting or outdenting.\r
		 */\r
		genericDefinition: function( isIndent ) {\r
			/**\r
			 * Determines whether the command belongs to the indentation family.\r
			 * Otherwise it is assumed to be an outdenting command.\r
			 *\r
			 * @readonly\r
			 * @property {Boolean} [=false]\r
			 */\r
			this.isIndent = !!isIndent;\r
\r
			// Mimic naive startDisabled behavior for outdent.\r
			this.startDisabled = !this.isIndent;\r
		},\r
\r
		/**\r
		 * A base class for specific indentation command definitions responsible for\r
		 * handling a pre-defined set of elements i.e. indentlist for lists or\r
		 * indentblock for text block elements.\r
		 *\r
		 * Commands of this class perform indentation operations and modify the DOM structure.\r
		 * They listen for events fired by {@link CKEDITOR.plugins.indent.genericDefinition}\r
		 * and execute defined actions.\r
		 *\r
		 * **NOTE**: This is not an {@link CKEDITOR.command editor command}.\r
		 * Context-specific commands are internal, for indentation system only.\r
		 *\r
		 * @class CKEDITOR.plugins.indent.specificDefinition\r
		 * @param {CKEDITOR.editor} editor The editor instance this command will be\r
		 * applied to.\r
		 * @param {String} name The name of the command.\r
		 * @param {Boolean} [isIndent] Defines the command as indenting or outdenting.\r
		 */\r
		specificDefinition: function( editor, name, isIndent ) {\r
			this.name = name;\r
			this.editor = editor;\r
\r
			/**\r
			 * An object of jobs handled by the command. Each job consists\r
			 * of two functions: `refresh` and `exec` as well as the execution priority.\r
			 *\r
			 *	* The `refresh` function determines whether a job is doable for\r
			 *	  a particular context. These functions are executed in the\r
			 *	  order of priorities, one by one, for all plugins that registered\r
			 *	  jobs. As jobs are related to generic commands, refreshing\r
			 *	  occurs when the global command is firing the `refresh` event.\r
			 *\r
			 *	  **Note**: This function must return either {@link CKEDITOR#TRISTATE_DISABLED}\r
			 *	  or {@link CKEDITOR#TRISTATE_OFF}.\r
			 *\r
			 *	* The `exec` function modifies the DOM if possible. Just like\r
			 *	  `refresh`, `exec` functions are executed in the order of priorities\r
			 *	  while the generic command is executed. This function is not executed\r
			 *	  if `refresh` for this job returned {@link CKEDITOR#TRISTATE_DISABLED}.\r
			 *\r
			 *	  **Note**: This function must return a Boolean value, indicating whether it\r
			 *	  was successful. If a job was successful, then no other jobs are being executed.\r
			 *\r
			 * Sample definition:\r
			 *\r
			 *		command.jobs = {\r
			 *			// Priority = 20.\r
			 *			'20': {\r
			 *				refresh( editor, path ) {\r
			 *					if ( condition )\r
			 *						return CKEDITOR.TRISTATE_OFF;\r
			 *					else\r
			 *						return CKEDITOR.TRISTATE_DISABLED;\r
			 *				},\r
			 *				exec( editor ) {\r
			 *					// DOM modified! This was OK.\r
			 *					return true;\r
			 *				}\r
			 *			},\r
			 *			// Priority = 60. This job is done later.\r
			 *			'60': {\r
			 *				// Another job.\r
			 *			}\r
			 *		};\r
			 *\r
			 * For additional information, please check comments for\r
			 * the `setupGenericListeners` function.\r
			 *\r
			 * @readonly\r
			 * @property {Object} [={}]\r
			 */\r
			this.jobs = {};\r
\r
			/**\r
			 * Determines whether the editor that the command belongs to has\r
			 * {@link CKEDITOR.config#enterMode config.enterMode} set to {@link CKEDITOR#ENTER_BR}.\r
			 *\r
			 * @readonly\r
			 * @see CKEDITOR.config#enterMode\r
			 * @property {Boolean} [=false]\r
			 */\r
			this.enterBr = editor.config.enterMode == CKEDITOR.ENTER_BR;\r
\r
			/**\r
			 * Determines whether the command belongs to the indentation family.\r
			 * Otherwise it is assumed to be an outdenting command.\r
			 *\r
			 * @readonly\r
			 * @property {Boolean} [=false]\r
			 */\r
			this.isIndent = !!isIndent;\r
\r
			/**\r
			 * The name of the global command related to this one.\r
			 *\r
			 * @readonly\r
			 */\r
			this.relatedGlobal = isIndent ? 'indent' : 'outdent';\r
\r
			/**\r
			 * A keystroke associated with this command (*Tab* or *Shift+Tab*).\r
			 *\r
			 * @readonly\r
			 */\r
			this.indentKey = isIndent ? 9 : CKEDITOR.SHIFT + 9;\r
\r
			/**\r
			 * Stores created markers for the command so they can eventually be\r
			 * purged after the `exec` function is run.\r
			 */\r
			this.database = {};\r
		},\r
\r
		/**\r
		 * Registers content-specific commands as a part of the indentation system\r
		 * directed by generic commands. Once a command is registered,\r
		 * it listens for events of a related generic command.\r
		 *\r
		 *		CKEDITOR.plugins.indent.registerCommands( editor, {\r
		 *			'indentlist': new indentListCommand( editor, 'indentlist' ),\r
		 *			'outdentlist': new indentListCommand( editor, 'outdentlist' )\r
		 *		} );\r
		 *\r
		 * Content-specific commands listen for the generic command's `exec` and\r
		 * try to execute their own jobs, one after another. If some execution is\r
		 * successful, `evt.data.done` is set so no more jobs (commands) are involved.\r
		 *\r
		 * Content-specific commands also listen for the generic command's `refresh`\r
		 * and fill the `evt.data.states` object with states of jobs. A generic command\r
		 * uses this data to determine its own state and to update the UI.\r
		 *\r
		 * @member CKEDITOR.plugins.indent\r
		 * @param {CKEDITOR.editor} editor The editor instance this command is\r
		 * applied to.\r
		 * @param {Object} commands An object of {@link CKEDITOR.command}.\r
		 */\r
		registerCommands: function( editor, commands ) {\r
			editor.on( 'pluginsLoaded', function() {\r
				for ( var name in commands ) {\r
					( function( editor, command ) {\r
						var relatedGlobal = editor.getCommand( command.relatedGlobal );\r
\r
						for ( var priority in command.jobs ) {\r
							// Observe generic exec event and execute command when necessary.\r
							// If the command was successfully handled by the command and\r
							// DOM has been modified, stop event propagation so no other plugin\r
							// will bother. Job is done.\r
							relatedGlobal.on( 'exec', function( evt ) {\r
								if ( evt.data.done )\r
									return;\r
\r
								// Make sure that anything this command will do is invisible\r
								// for undoManager. What undoManager only can see and\r
								// remember is the execution of the global command (relatedGlobal).\r
								editor.fire( 'lockSnapshot' );\r
\r
								if ( command.execJob( editor, priority ) )\r
									evt.data.done = true;\r
\r
								editor.fire( 'unlockSnapshot' );\r
\r
								// Clean up the markers.\r
								CKEDITOR.dom.element.clearAllMarkers( command.database );\r
							}, this, null, priority );\r
\r
							// Observe generic refresh event and force command refresh.\r
							// Once refreshed, save command state in event data\r
							// so generic command plugin can update its own state and UI.\r
							relatedGlobal.on( 'refresh', function( evt ) {\r
								if ( !evt.data.states )\r
									evt.data.states = {};\r
\r
								evt.data.states[ command.name + '@' + priority ] =\r
									command.refreshJob( editor, priority, evt.data.path );\r
							}, this, null, priority );\r
						}\r
\r
						// Since specific indent commands have no UI elements,\r
						// they need to be manually registered as a editor feature.\r
						editor.addFeature( command );\r
					} )( this, commands[ name ] );\r
				}\r
			} );\r
		}\r
	};\r
\r
	CKEDITOR.plugins.indent.genericDefinition.prototype = {\r
		context: 'p',\r
\r
		exec: function() {}\r
	};\r
\r
	CKEDITOR.plugins.indent.specificDefinition.prototype = {\r
		/**\r
		 * Executes the content-specific procedure if the context is correct.\r
		 * It calls the `exec` function of a job of the given `priority`\r
		 * that modifies the DOM.\r
		 *\r
		 * @param {CKEDITOR.editor} editor The editor instance this command\r
		 * will be applied to.\r
		 * @param {Number} priority The priority of the job to be executed.\r
		 * @returns {Boolean} Indicates whether the job was successful.\r
		 */\r
		execJob: function( editor, priority ) {\r
			var job = this.jobs[ priority ];\r
\r
			if ( job.state != TRISTATE_DISABLED )\r
				return job.exec.call( this, editor );\r
		},\r
\r
		/**\r
		 * Calls the `refresh` function of a job of the given `priority`.\r
		 * The function returns the state of the job which can be either\r
		 * {@link CKEDITOR#TRISTATE_DISABLED} or {@link CKEDITOR#TRISTATE_OFF}.\r
		 *\r
		 * @param {CKEDITOR.editor} editor The editor instance this command\r
		 * will be applied to.\r
		 * @param {Number} priority The priority of the job to be executed.\r
		 * @returns {Number} The state of the job.\r
		 */\r
		refreshJob: function( editor, priority, path ) {\r
			var job = this.jobs[ priority ];\r
\r
			if ( !editor.activeFilter.checkFeature( this ) )\r
				job.state = TRISTATE_DISABLED;\r
			else\r
				job.state = job.refresh.call( this, editor, path );\r
\r
			return job.state;\r
		},\r
\r
		/**\r
		 * Checks if the element path contains the element handled\r
		 * by this indentation command.\r
		 *\r
		 * @param {CKEDITOR.dom.elementPath} node A path to be checked.\r
		 * @returns {CKEDITOR.dom.element}\r
		 */\r
		getContext: function( path ) {\r
			return path.contains( this.context );\r
		}\r
	};\r
\r
	/**\r
	 * Attaches event listeners for this generic command. Since the indentation\r
	 * system is event-oriented, generic commands communicate with\r
	 * content-specific commands using the `exec` and `refresh` events.\r
	 *\r
	 * Listener priorities are crucial. Different indentation phases\r
	 * are executed with different priorities.\r
	 *\r
	 * For the `exec` event:\r
	 *\r
	 *	* 0: Selection and bookmarks are saved by the generic command.\r
	 *	* 1-99: Content-specific commands try to indent the code by executing\r
	 *	  their own jobs ({@link CKEDITOR.plugins.indent.specificDefinition#jobs}).\r
	 *	* 100: Bookmarks are re-selected by the generic command.\r
	 *\r
	 * The visual interpretation looks as follows:\r
	 *\r
	 *		  +------------------+\r
	 *		  | Exec event fired |\r
	 *		  +------ + ---------+\r
	 *		          |\r
	 *		        0 -<----------+ Selection and bookmarks saved.\r
	 *		          |\r
	 *		          |\r
	 *		       25 -<---+ Exec 1st job of plugin#1 (return false, continuing...).\r
	 *		          |\r
	 *		          |\r
	 *		       50 -<---+ Exec 1st job of plugin#2 (return false, continuing...).\r
	 *		          |\r
	 *		          |\r
	 *		       75 -<---+ Exec 2nd job of plugin#1 (only if plugin#2 failed).\r
	 *		          |\r
	 *		          |\r
	 *		      100 -<-----------+ Re-select bookmarks, clean-up.\r
	 *		          |\r
	 *		+-------- v ----------+\r
	 *		| Exec event finished |\r
	 *		+---------------------+\r
	 *\r
	 * For the `refresh` event:\r
	 *\r
	 *	* <100: Content-specific commands refresh their job states according\r
	 *	  to the given path. Jobs save their states in the `evt.data.states` object\r
	 *	  passed along with the event. This can be either {@link CKEDITOR#TRISTATE_DISABLED}\r
	 *	  or {@link CKEDITOR#TRISTATE_OFF}.\r
	 *	* 100: Command state is determined according to what states\r
	 *	  have been returned by content-specific jobs (`evt.data.states`).\r
	 *	  UI elements are updated at this stage.\r
	 *\r
	 *	  **Note**: If there is at least one job with the {@link CKEDITOR#TRISTATE_OFF} state,\r
	 *	  then the generic command state is also {@link CKEDITOR#TRISTATE_OFF}. Otherwise,\r
	 *	  the command state is {@link CKEDITOR#TRISTATE_DISABLED}.\r
	 *\r
	 * @param {CKEDITOR.command} command The command to be set up.\r
	 * @private\r
	 */\r
	function setupGenericListeners( editor, command ) {\r
		var selection, bookmarks;\r
\r
		// Set the command state according to content-specific\r
		// command states.\r
		command.on( 'refresh', function( evt ) {\r
			// If no state comes with event data, disable command.\r
			var states = [ TRISTATE_DISABLED ];\r
\r
			for ( var s in evt.data.states )\r
				states.push( evt.data.states[ s ] );\r
\r
			this.setState( CKEDITOR.tools.search( states, TRISTATE_OFF ) ? TRISTATE_OFF : TRISTATE_DISABLED );\r
		}, command, null, 100 );\r
\r
		// Initialization. Save bookmarks and mark event as not handled\r
		// by any plugin (command) yet.\r
		command.on( 'exec', function( evt ) {\r
			selection = editor.getSelection();\r
			bookmarks = selection.createBookmarks( 1 );\r
\r
			// Mark execution as not handled yet.\r
			if ( !evt.data )\r
				evt.data = {};\r
\r
			evt.data.done = false;\r
		}, command, null, 0 );\r
\r
		// Housekeeping. Make sure selectionChange will be called.\r
		// Also re-select previously saved bookmarks.\r
		command.on( 'exec', function() {\r
			editor.forceNextSelectionCheck();\r
			selection.selectBookmarks( bookmarks );\r
		}, command, null, 100 );\r
	}\r
} )();\r