Update to 4.7.3

[perso/Immae/Projets/packagist/ludivine-ckeditor-component.git] / sources / plugins / indentlist / 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 Handles the indentation of lists.\r
 */\r
\r
( function() {\r
	'use strict';\r
\r
	var isNotWhitespaces = CKEDITOR.dom.walker.whitespaces( true ),\r
		isNotBookmark = CKEDITOR.dom.walker.bookmark( false, true ),\r
		TRISTATE_DISABLED = CKEDITOR.TRISTATE_DISABLED,\r
		TRISTATE_OFF = CKEDITOR.TRISTATE_OFF;\r
\r
	CKEDITOR.plugins.add( 'indentlist', {\r
		requires: 'indent',\r
		init: function( editor ) {\r
			var globalHelpers = CKEDITOR.plugins.indent;\r
\r
			// Register commands.\r
			globalHelpers.registerCommands( editor, {\r
				indentlist: new commandDefinition( editor, 'indentlist', true ),\r
				outdentlist: new commandDefinition( editor, 'outdentlist' )\r
			} );\r
\r
			function commandDefinition( editor ) {\r
				globalHelpers.specificDefinition.apply( this, arguments );\r
\r
				// Require ul OR ol list.\r
				this.requiredContent = [ 'ul', 'ol' ];\r
\r
				// Indent and outdent lists with TAB/SHIFT+TAB key. Indenting can\r
				// be done for any list item that isn't the first child of the parent.\r
				editor.on( 'key', function( evt ) {\r
					var path = editor.elementPath();\r
\r
					if ( editor.mode != 'wysiwyg' )\r
						return;\r
\r
					if ( evt.data.keyCode == this.indentKey ) {\r
						// Prevent of getting context of empty path (#424)(https://dev.ckeditor.com/ticket/17028).\r
						if ( !path ) {\r
							return;\r
						}\r
\r
						var list = this.getContext( path );\r
\r
						if ( list ) {\r
							// Don't indent if in first list item of the parent.\r
							// Outdent, however, can always be done to collapse\r
							// the list into a paragraph (div).\r
							if ( this.isIndent && CKEDITOR.plugins.indentList.firstItemInPath( this.context, path, list ) )\r
								return;\r
\r
							// Exec related global indentation command. Global\r
							// commands take care of bookmarks and selection,\r
							// so it's much easier to use them instead of\r
							// content-specific commands.\r
							editor.execCommand( this.relatedGlobal );\r
\r
							// Cancel the key event so editor doesn't lose focus.\r
							evt.cancel();\r
						}\r
					}\r
				}, this );\r
\r
				// There are two different jobs for this plugin:\r
				//\r
				//	* Indent job (priority=10), before indentblock.\r
				//\r
				//	  This job is before indentblock because, if this plugin is\r
				//	  loaded it has higher priority over indentblock. It means that,\r
				//	  if possible, nesting is performed, and then block manipulation,\r
				//	  if necessary.\r
				//\r
				//	* Outdent job (priority=30), after outdentblock.\r
				//\r
				//	  This job got to be after outdentblock because in some cases\r
				//	  (margin, config#indentClass on list) outdent must be done on\r
				//	  block-level.\r
\r
				this.jobs[ this.isIndent ? 10 : 30 ] = {\r
					refresh: this.isIndent ?\r
						function( editor, path ) {\r
							var list = this.getContext( path ),\r
								inFirstListItem = CKEDITOR.plugins.indentList.firstItemInPath( this.context, path, list );\r
\r
							if ( !list || !this.isIndent || inFirstListItem )\r
								return TRISTATE_DISABLED;\r
\r
							return TRISTATE_OFF;\r
						} : function( editor, path ) {\r
							var list = this.getContext( path );\r
\r
							if ( !list || this.isIndent )\r
								return TRISTATE_DISABLED;\r
\r
							return TRISTATE_OFF;\r
						},\r
\r
					exec: CKEDITOR.tools.bind( indentList, this )\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: { ol: 1, ul: 1 }\r
			} );\r
		}\r
	} );\r
\r
	function indentList( editor ) {\r
		var that = this,\r
			database = this.database,\r
			context = this.context,\r
			range;\r
\r
		function indent( listNode ) {\r
			// Our starting and ending points of the range might be inside some blocks under a list item...\r
			// So before playing with the iterator, we need to expand the block to include the list items.\r
			var startContainer = range.startContainer,\r
				endContainer = range.endContainer;\r
			while ( startContainer && !startContainer.getParent().equals( listNode ) )\r
				startContainer = startContainer.getParent();\r
			while ( endContainer && !endContainer.getParent().equals( listNode ) )\r
				endContainer = endContainer.getParent();\r
\r
			if ( !startContainer || !endContainer )\r
				return false;\r
\r
			// Now we can iterate over the individual items on the same tree depth.\r
			var block = startContainer,\r
				itemsToMove = [],\r
				stopFlag = false;\r
\r
			while ( !stopFlag ) {\r
				if ( block.equals( endContainer ) )\r
					stopFlag = true;\r
\r
				itemsToMove.push( block );\r
				block = block.getNext();\r
			}\r
\r
			if ( itemsToMove.length < 1 )\r
				return false;\r
\r
			// Do indent or outdent operations on the array model of the list, not the\r
			// list's DOM tree itself. The array model demands that it knows as much as\r
			// possible about the surrounding lists, we need to feed it the further\r
			// ancestor node that is still a list.\r
			var listParents = listNode.getParents( true );\r
			for ( var i = 0; i < listParents.length; i++ ) {\r
				if ( listParents[ i ].getName && context[ listParents[ i ].getName() ] ) {\r
					listNode = listParents[ i ];\r
					break;\r
				}\r
			}\r
\r
			var indentOffset = that.isIndent ? 1 : -1,\r
				startItem = itemsToMove[ 0 ],\r
				lastItem = itemsToMove[ itemsToMove.length - 1 ],\r
\r
				// Convert the list DOM tree into a one dimensional array.\r
				listArray = CKEDITOR.plugins.list.listToArray( listNode, database ),\r
\r
				// Apply indenting or outdenting on the array.\r
				baseIndent = listArray[ lastItem.getCustomData( 'listarray_index' ) ].indent;\r
\r
			for ( i = startItem.getCustomData( 'listarray_index' ); i <= lastItem.getCustomData( 'listarray_index' ); i++ ) {\r
				listArray[ i ].indent += indentOffset;\r
				// Make sure the newly created sublist get a brand-new element of the same type. (http://dev.ckeditor.com/ticket/5372)\r
				if ( indentOffset > 0 ) {\r
					var listRoot = listArray[ i ].parent;\r
					listArray[ i ].parent = new CKEDITOR.dom.element( listRoot.getName(), listRoot.getDocument() );\r
				}\r
			}\r
\r
			for ( i = lastItem.getCustomData( 'listarray_index' ) + 1; i < listArray.length && listArray[ i ].indent > baseIndent; i++ )\r
				listArray[ i ].indent += indentOffset;\r
\r
			// Convert the array back to a DOM forest (yes we might have a few subtrees now).\r
			// And replace the old list with the new forest.\r
			var newList = CKEDITOR.plugins.list.arrayToList( listArray, database, null, editor.config.enterMode, listNode.getDirection() );\r
\r
			// Avoid nested <li> after outdent even they're visually same,\r
			// recording them for later refactoring.(http://dev.ckeditor.com/ticket/3982)\r
			if ( !that.isIndent ) {\r
				var parentLiElement;\r
				if ( ( parentLiElement = listNode.getParent() ) && parentLiElement.is( 'li' ) ) {\r
					var children = newList.listNode.getChildren(),\r
						pendingLis = [],\r
						count = children.count(),\r
						child;\r
\r
					for ( i = count - 1; i >= 0; i-- ) {\r
						if ( ( child = children.getItem( i ) ) && child.is && child.is( 'li' ) )\r
							pendingLis.push( child );\r
					}\r
				}\r
			}\r
\r
			if ( newList )\r
				newList.listNode.replace( listNode );\r
\r
			// Move the nested <li> to be appeared after the parent.\r
			if ( pendingLis && pendingLis.length ) {\r
				for ( i = 0; i < pendingLis.length; i++ ) {\r
					var li = pendingLis[ i ],\r
						followingList = li;\r
\r
					// Nest preceding <ul>/<ol> inside current <li> if any.\r
					while ( ( followingList = followingList.getNext() ) && followingList.is && followingList.getName() in context ) {\r
						// IE requires a filler NBSP for nested list inside empty list item,\r
						// otherwise the list item will be inaccessiable. (http://dev.ckeditor.com/ticket/4476)\r
						if ( CKEDITOR.env.needsNbspFiller && !li.getFirst( neitherWhitespacesNorBookmark ) )\r
							li.append( range.document.createText( '\u00a0' ) );\r
\r
						li.append( followingList );\r
					}\r
\r
					li.insertAfter( parentLiElement );\r
				}\r
			}\r
\r
			if ( newList )\r
				editor.fire( 'contentDomInvalidated' );\r
\r
			return true;\r
		}\r
\r
		var selection = editor.getSelection(),\r
			ranges = selection && selection.getRanges(),\r
			iterator = ranges.createIterator();\r
\r
		while ( ( range = iterator.getNextRange() ) ) {\r
			var nearestListBlock = range.getCommonAncestor();\r
\r
			while ( nearestListBlock && !( nearestListBlock.type == CKEDITOR.NODE_ELEMENT && context[ nearestListBlock.getName() ] ) ) {\r
				// Avoid having plugin propagate to parent of editor in inline mode by canceling the indentation. (http://dev.ckeditor.com/ticket/12796)\r
				if ( editor.editable().equals( nearestListBlock ) ) {\r
					nearestListBlock = false;\r
					break;\r
				}\r
				nearestListBlock = nearestListBlock.getParent();\r
			}\r
\r
			// Avoid having selection boundaries out of the list.\r
			// <ul><li>[...</li></ul><p>...]</p> => <ul><li>[...]</li></ul><p>...</p>\r
			if ( !nearestListBlock ) {\r
				if ( ( nearestListBlock = range.startPath().contains( context ) ) )\r
					range.setEndAt( nearestListBlock, CKEDITOR.POSITION_BEFORE_END );\r
			}\r
\r
			// Avoid having selection enclose the entire list. (http://dev.ckeditor.com/ticket/6138)\r
			// [<ul><li>...</li></ul>] =><ul><li>[...]</li></ul>\r
			if ( !nearestListBlock ) {\r
				var selectedNode = range.getEnclosedNode();\r
				if ( selectedNode && selectedNode.type == CKEDITOR.NODE_ELEMENT && selectedNode.getName() in context ) {\r
					range.setStartAt( selectedNode, CKEDITOR.POSITION_AFTER_START );\r
					range.setEndAt( selectedNode, CKEDITOR.POSITION_BEFORE_END );\r
					nearestListBlock = selectedNode;\r
				}\r
			}\r
\r
			// Avoid selection anchors under list root.\r
			// <ul>[<li>...</li>]</ul> =>	<ul><li>[...]</li></ul>\r
			if ( nearestListBlock && range.startContainer.type == CKEDITOR.NODE_ELEMENT && range.startContainer.getName() in context ) {\r
				var walker = new CKEDITOR.dom.walker( range );\r
				walker.evaluator = listItem;\r
				range.startContainer = walker.next();\r
			}\r
\r
			if ( nearestListBlock && range.endContainer.type == CKEDITOR.NODE_ELEMENT && range.endContainer.getName() in context ) {\r
				walker = new CKEDITOR.dom.walker( range );\r
				walker.evaluator = listItem;\r
				range.endContainer = walker.previous();\r
			}\r
\r
			if ( nearestListBlock )\r
				return indent( nearestListBlock );\r
		}\r
		return 0;\r
	}\r
\r
	// Determines whether a node is a list <li> element.\r
	function listItem( node ) {\r
		return node.type == CKEDITOR.NODE_ELEMENT && node.is( 'li' );\r
	}\r
\r
	function neitherWhitespacesNorBookmark( node ) {\r
		return isNotWhitespaces( node ) && isNotBookmark( node );\r
	}\r
\r
	/**\r
	 * Global namespace for methods exposed by the Indent List plugin.\r
	 *\r
	 * @singleton\r
	 * @class\r
	 */\r
	CKEDITOR.plugins.indentList = {};\r
\r
	/**\r
	 * Checks whether the first child of the list is in the path.\r
	 * The list can be extracted from the path or given explicitly\r
	 * e.g. for better performance if cached.\r
	 *\r
	 * @since 4.4.6\r
	 * @param {Object} query See the {@link CKEDITOR.dom.elementPath#contains} method arguments.\r
	 * @param {CKEDITOR.dom.elementPath} path\r
	 * @param {CKEDITOR.dom.element} [list]\r
	 * @returns {Boolean}\r
	 * @member CKEDITOR.plugins.indentList\r
	 */\r
	CKEDITOR.plugins.indentList.firstItemInPath = function( query, path, list ) {\r
		var firstListItemInPath = path.contains( listItem );\r
		if ( !list )\r
			list = path.contains( query );\r
\r
		return list && firstListItemInPath && firstListItemInPath.equals( list.getFirst( listItem ) );\r
	};\r
} )();\r