Initial commit

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

/**\r
 * @license Copyright (c) 2003-2016, CKSource - Frederico Knabben. All rights reserved.\r
 * For licensing, see LICENSE.md or http://ckeditor.com/license\r
 */\r
\r
/**\r
 * @fileOverview Handles the indentation of block elements.\r
 */\r
\r
( function() {\r
	'use strict';\r
\r
	var $listItem = CKEDITOR.dtd.$listItem,\r
		$list = CKEDITOR.dtd.$list,\r
		TRISTATE_DISABLED = CKEDITOR.TRISTATE_DISABLED,\r
		TRISTATE_OFF = CKEDITOR.TRISTATE_OFF;\r
\r
	CKEDITOR.plugins.add( 'indentblock', {\r
		requires: 'indent',\r
		init: function( editor ) {\r
			var globalHelpers = CKEDITOR.plugins.indent,\r
				classes = editor.config.indentClasses;\r
\r
			// Register commands.\r
			globalHelpers.registerCommands( editor, {\r
				indentblock: new commandDefinition( editor, 'indentblock', true ),\r
				outdentblock: new commandDefinition( editor, 'outdentblock' )\r
			} );\r
\r
			function commandDefinition() {\r
				globalHelpers.specificDefinition.apply( this, arguments );\r
\r
				this.allowedContent = {\r
					'div h1 h2 h3 h4 h5 h6 ol p pre ul': {\r
						// Do not add elements, but only text-align style if element is validated by other rule.\r
						propertiesOnly: true,\r
						styles: !classes ? 'margin-left,margin-right' : null,\r
						classes: classes || null\r
					}\r
				};\r
\r
				if ( this.enterBr )\r
					this.allowedContent.div = true;\r
\r
				this.requiredContent = ( this.enterBr ? 'div' : 'p' ) +\r
					( classes ? '(' + classes.join( ',' ) + ')' : '{margin-left}' );\r
\r
				this.jobs = {\r
					'20': {\r
						refresh: function( editor, path ) {\r
							var firstBlock = path.block || path.blockLimit;\r
\r
							// Switch context from somewhere inside list item to list item,\r
							// if not found just assign self (doing nothing).\r
							if ( !firstBlock.is( $listItem ) ) {\r
								var ascendant = firstBlock.getAscendant( $listItem );\r
\r
								firstBlock = ( ascendant && path.contains( ascendant ) ) || firstBlock;\r
							}\r
\r
							// Switch context from list item to list\r
							// because indentblock can indent entire list\r
							// but not a single list element.\r
\r
							if ( firstBlock.is( $listItem ) )\r
								firstBlock = firstBlock.getParent();\r
\r
							//	[-] Context in the path or ENTER_BR\r
							//\r
							//		Don't try to indent if the element is out of\r
							//		this plugin's scope. This assertion is omitted\r
							//		if ENTER_BR is in use since there may be no block\r
							//		in the path.\r
\r
							if ( !this.enterBr && !this.getContext( path ) )\r
								return TRISTATE_DISABLED;\r
\r
							else if ( classes ) {\r
\r
								//	[+] Context in the path or ENTER_BR\r
								//	[+] IndentClasses\r
								//\r
								//		If there are indentation classes, check if reached\r
								//		the highest level of indentation. If so, disable\r
								//		the command.\r
\r
								if ( indentClassLeft.call( this, firstBlock, classes ) )\r
									return TRISTATE_OFF;\r
								else\r
									return TRISTATE_DISABLED;\r
							} else {\r
\r
								//	[+] Context in the path or ENTER_BR\r
								//	[-] IndentClasses\r
								//	[+] Indenting\r
								//\r
								//		No indent-level limitations due to indent classes.\r
								//		Indent-like command can always be executed.\r
\r
								if ( this.isIndent )\r
									return TRISTATE_OFF;\r
\r
								//	[+] Context in the path or ENTER_BR\r
								//	[-] IndentClasses\r
								//	[-] Indenting\r
								//	[-] Block in the path\r
								//\r
								//		No block in path. There's no element to apply indentation\r
								//		so disable the command.\r
\r
								else if ( !firstBlock )\r
									return TRISTATE_DISABLED;\r
\r
								//	[+] Context in the path or ENTER_BR\r
								//	[-] IndentClasses\r
								//	[-] Indenting\r
								//	[+] Block in path.\r
								//\r
								//		Not using indentClasses but there is firstBlock.\r
								//		We can calculate current indentation level and\r
								//		try to increase/decrease it.\r
\r
								else {\r
									return CKEDITOR[\r
										( getIndent( firstBlock ) || 0 ) <= 0 ? 'TRISTATE_DISABLED' : 'TRISTATE_OFF'\r
									];\r
								}\r
							}\r
						},\r
\r
						exec: function( editor ) {\r
							var selection = editor.getSelection(),\r
								range = selection && selection.getRanges()[ 0 ],\r
								nearestListBlock;\r
\r
							// If there's some list in the path, then it will be\r
							// a full-list indent by increasing or decreasing margin property.\r
							if ( ( nearestListBlock = editor.elementPath().contains( $list ) ) )\r
								indentElement.call( this, nearestListBlock, classes );\r
\r
							// If no list in the path, use iterator to indent all the possible\r
							// paragraphs in the range, creating them if necessary.\r
							else {\r
								var iterator = range.createIterator(),\r
									enterMode = editor.config.enterMode,\r
									block;\r
\r
								iterator.enforceRealBlocks = true;\r
								iterator.enlargeBr = enterMode != CKEDITOR.ENTER_BR;\r
\r
								while ( ( block = iterator.getNextParagraph( enterMode == CKEDITOR.ENTER_P ? 'p' : 'div' ) ) ) {\r
									if ( !block.isReadOnly() )\r
										indentElement.call( this, block, classes );\r
								}\r
							}\r
\r
							return true;\r
						}\r
					}\r
				};\r
			}\r
\r
			CKEDITOR.tools.extend( commandDefinition.prototype, globalHelpers.specificDefinition.prototype, {\r
				// Elements that, if in an elementpath, will be handled by this\r
				// command. They restrict the scope of the plugin.\r
				context: { div: 1, dl: 1, h1: 1, h2: 1, h3: 1, h4: 1, h5: 1, h6: 1, ul: 1, ol: 1, p: 1, pre: 1, table: 1 },\r
\r
				// A regex built on config#indentClasses to detect whether an\r
				// element has some indentClass or not.\r
				classNameRegex: classes ? new RegExp( '(?:^|\\s+)(' + classes.join( '|' ) + ')(?=$|\\s)' ) : null\r
			} );\r
		}\r
	} );\r
\r
	// Generic indentation procedure for indentation of any element\r
	// either with margin property or config#indentClass.\r
	function indentElement( element, classes, dir ) {\r
		if ( element.getCustomData( 'indent_processed' ) )\r
			return;\r
\r
		var editor = this.editor,\r
			isIndent = this.isIndent;\r
\r
		if ( classes ) {\r
			// Transform current class f to indent step index.\r
			var indentClass = element.$.className.match( this.classNameRegex ),\r
				indentStep = 0;\r
\r
			if ( indentClass ) {\r
				indentClass = indentClass[ 1 ];\r
				indentStep = CKEDITOR.tools.indexOf( classes, indentClass ) + 1;\r
			}\r
\r
			// Operate on indent step index, transform indent step index\r
			// back to class name.\r
			if ( ( indentStep += isIndent ? 1 : -1 ) < 0 )\r
				return;\r
\r
			indentStep = Math.min( indentStep, classes.length );\r
			indentStep = Math.max( indentStep, 0 );\r
			element.$.className = CKEDITOR.tools.ltrim( element.$.className.replace( this.classNameRegex, '' ) );\r
\r
			if ( indentStep > 0 )\r
				element.addClass( classes[ indentStep - 1 ] );\r
		} else {\r
			var indentCssProperty = getIndentCss( element, dir ),\r
				currentOffset = parseInt( element.getStyle( indentCssProperty ), 10 ),\r
				indentOffset = editor.config.indentOffset || 40;\r
\r
			if ( isNaN( currentOffset ) )\r
				currentOffset = 0;\r
\r
			currentOffset += ( isIndent ? 1 : -1 ) * indentOffset;\r
\r
			if ( currentOffset < 0 )\r
				return;\r
\r
			currentOffset = Math.max( currentOffset, 0 );\r
			currentOffset = Math.ceil( currentOffset / indentOffset ) * indentOffset;\r
\r
			element.setStyle(\r
				indentCssProperty,\r
				currentOffset ? currentOffset + ( editor.config.indentUnit || 'px' ) : ''\r
			);\r
\r
			if ( element.getAttribute( 'style' ) === '' )\r
				element.removeAttribute( 'style' );\r
		}\r
\r
		CKEDITOR.dom.element.setMarker( this.database, element, 'indent_processed', 1 );\r
\r
		return;\r
	}\r
\r
	// Method that checks if current indentation level for an element\r
	// reached the limit determined by config#indentClasses.\r
	function indentClassLeft( node, classes ) {\r
		var indentClass = node.$.className.match( this.classNameRegex ),\r
			isIndent = this.isIndent;\r
\r
		// If node has one of the indentClasses:\r
		//	* If it holds the topmost indentClass, then\r
		//	  no more classes have left.\r
		//	* If it holds any other indentClass, it can use the next one\r
		//	  or the previous one.\r
		//	* Outdent is always possible. We can remove indentClass.\r
		if ( indentClass )\r
			return isIndent ? indentClass[ 1 ] != classes.slice( -1 ) : true;\r
\r
		// If node has no class which belongs to indentClasses,\r
		// then it is at 0-level. It can be indented but not outdented.\r
		else\r
			return isIndent;\r
	}\r
\r
	// Determines indent CSS property for an element according to\r
	// what is the direction of such element. It can be either `margin-left`\r
	// or `margin-right`.\r
	function getIndentCss( element, dir ) {\r
		return ( dir || element.getComputedStyle( 'direction' ) ) == 'ltr' ? 'margin-left' : 'margin-right';\r
	}\r
\r
	// Return the numerical indent value of margin-left|right of an element,\r
	// considering element's direction. If element has no margin specified,\r
	// NaN is returned.\r
	function getIndent( element ) {\r
		return parseInt( element.getStyle( getIndentCss( element ) ), 10 );\r
	}\r
} )();\r
\r
/**\r
 * A list of classes to use for indenting the contents. If set to `null`, no classes will be used\r
 * and instead the {@link #indentUnit} and {@link #indentOffset} properties will be used.\r
 *\r
 *		// Use the 'Indent1', 'Indent2', 'Indent3' classes.\r
 *		config.indentClasses = ['Indent1', 'Indent2', 'Indent3'];\r
 *\r
 * @cfg {Array} [indentClasses=null]\r
 * @member CKEDITOR.config\r
 */\r
\r
/**\r
 * The size in {@link CKEDITOR.config#indentUnit indentation units} of each indentation step.\r
 *\r
 *		config.indentOffset = 4;\r
 *\r
 * @cfg {Number} [indentOffset=40]\r
 * @member CKEDITOR.config\r
 */\r
\r
/**\r
 * The unit used for {@link CKEDITOR.config#indentOffset indentation offset}.\r
 *\r
 *		config.indentUnit = 'em';\r
 *\r
 * @cfg {String} [indentUnit='px']\r
 * @member CKEDITOR.config\r
 */\r