2 Copyright (c) 2003-2011, CKSource - Frederico Knabben. All rights reserved.
3 For licensing, see LICENSE.html or http://ckeditor.com/license
7 * @file Increse and decrease indent commands.
12 var listNodeNames = { ol : 1, ul : 1 },
13 isNotWhitespaces = CKEDITOR.dom.walker.whitespaces( true ),
14 isNotBookmark = CKEDITOR.dom.walker.bookmark( false, true );
16 function onSelectionChange( evt )
18 var editor = evt.editor;
20 var elementPath = evt.data.path,
21 list = elementPath && elementPath.contains( listNodeNames );
24 return this.setState( CKEDITOR.TRISTATE_OFF );
26 if ( !this.useIndentClasses && this.name == 'indent' )
27 return this.setState( CKEDITOR.TRISTATE_OFF );
29 var path = evt.data.path,
30 firstBlock = path.block || path.blockLimit;
32 return this.setState( CKEDITOR.TRISTATE_DISABLED );
34 if ( this.useIndentClasses )
36 var indentClass = firstBlock.$.className.match( this.classNameRegex ),
40 indentClass = indentClass[1];
41 indentStep = this.indentClassMap[ indentClass ];
43 if ( ( this.name == 'outdent' && !indentStep ) ||
44 ( this.name == 'indent' && indentStep == editor.config.indentClasses.length ) )
45 return this.setState( CKEDITOR.TRISTATE_DISABLED );
46 return this.setState( CKEDITOR.TRISTATE_OFF );
50 var indent = parseInt( firstBlock.getStyle( getIndentCssProperty( firstBlock ) ), 10 );
51 if ( isNaN( indent ) )
54 return this.setState( CKEDITOR.TRISTATE_DISABLED );
55 return this.setState( CKEDITOR.TRISTATE_OFF );
59 function indentCommand( editor, name )
62 this.useIndentClasses = editor.config.indentClasses && editor.config.indentClasses.length > 0;
63 if ( this.useIndentClasses )
65 this.classNameRegex = new RegExp( '(?:^|\\s+)(' + editor.config.indentClasses.join( '|' ) + ')(?=$|\\s)' );
66 this.indentClassMap = {};
67 for ( var i = 0 ; i < editor.config.indentClasses.length ; i++ )
68 this.indentClassMap[ editor.config.indentClasses[i] ] = i + 1;
71 this.startDisabled = name == 'outdent';
74 // Returns the CSS property to be used for identing a given element.
75 function getIndentCssProperty( element, dir )
77 return ( dir || element.getComputedStyle( 'direction' ) ) == 'ltr' ? 'margin-left' : 'margin-right';
80 function isListItem( node )
82 return node.type = CKEDITOR.NODE_ELEMENT && node.is( 'li' );
85 indentCommand.prototype = {
86 exec : function( editor )
88 var self = this, database = {};
90 function indentList( listNode )
92 // Our starting and ending points of the range might be inside some blocks under a list item...
93 // So before playing with the iterator, we need to expand the block to include the list items.
94 var startContainer = range.startContainer,
95 endContainer = range.endContainer;
96 while ( startContainer && !startContainer.getParent().equals( listNode ) )
97 startContainer = startContainer.getParent();
98 while ( endContainer && !endContainer.getParent().equals( listNode ) )
99 endContainer = endContainer.getParent();
101 if ( !startContainer || !endContainer )
104 // Now we can iterate over the individual items on the same tree depth.
105 var block = startContainer,
110 if ( block.equals( endContainer ) )
112 itemsToMove.push( block );
113 block = block.getNext();
115 if ( itemsToMove.length < 1 )
118 // Do indent or outdent operations on the array model of the list, not the
119 // list's DOM tree itself. The array model demands that it knows as much as
120 // possible about the surrounding lists, we need to feed it the further
121 // ancestor node that is still a list.
122 var listParents = listNode.getParents( true );
123 for ( var i = 0 ; i < listParents.length ; i++ )
125 if ( listParents[i].getName && listNodeNames[ listParents[i].getName() ] )
127 listNode = listParents[i];
131 var indentOffset = self.name == 'indent' ? 1 : -1,
132 startItem = itemsToMove[0],
133 lastItem = itemsToMove[ itemsToMove.length - 1 ];
135 // Convert the list DOM tree into a one dimensional array.
136 var listArray = CKEDITOR.plugins.list.listToArray( listNode, database );
138 // Apply indenting or outdenting on the array.
139 var baseIndent = listArray[ lastItem.getCustomData( 'listarray_index' ) ].indent;
140 for ( i = startItem.getCustomData( 'listarray_index' ); i <= lastItem.getCustomData( 'listarray_index' ); i++ )
142 listArray[ i ].indent += indentOffset;
143 // Make sure the newly created sublist get a brand-new element of the same type. (#5372)
144 var listRoot = listArray[ i ].parent;
145 listArray[ i ].parent = new CKEDITOR.dom.element( listRoot.getName(), listRoot.getDocument() );
148 for ( i = lastItem.getCustomData( 'listarray_index' ) + 1 ;
149 i < listArray.length && listArray[i].indent > baseIndent ; i++ )
150 listArray[i].indent += indentOffset;
152 // Convert the array back to a DOM forest (yes we might have a few subtrees now).
153 // And replace the old list with the new forest.
154 var newList = CKEDITOR.plugins.list.arrayToList( listArray, database, null, editor.config.enterMode, listNode.getDirection() );
156 // Avoid nested <li> after outdent even they're visually same,
157 // recording them for later refactoring.(#3982)
158 if ( self.name == 'outdent' )
161 if ( ( parentLiElement = listNode.getParent() ) && parentLiElement.is( 'li' ) )
163 var children = newList.listNode.getChildren(),
165 count = children.count(),
168 for ( i = count - 1 ; i >= 0 ; i-- )
170 if ( ( child = children.getItem( i ) ) && child.is && child.is( 'li' ) )
171 pendingLis.push( child );
177 newList.listNode.replace( listNode );
179 // Move the nested <li> to be appeared after the parent.
180 if ( pendingLis && pendingLis.length )
182 for ( i = 0; i < pendingLis.length ; i++ )
184 var li = pendingLis[ i ],
187 // Nest preceding <ul>/<ol> inside current <li> if any.
188 while ( ( followingList = followingList.getNext() ) &&
190 followingList.getName() in listNodeNames )
192 // IE requires a filler NBSP for nested list inside empty list item,
193 // otherwise the list item will be inaccessiable. (#4476)
194 if ( CKEDITOR.env.ie && !li.getFirst( function( node ){ return isNotWhitespaces( node ) && isNotBookmark( node ); } ) )
195 li.append( range.document.createText( '\u00a0' ) );
197 li.append( followingList );
200 li.insertAfter( parentLiElement );
205 function indentBlock()
207 var iterator = range.createIterator(),
208 enterMode = editor.config.enterMode;
209 iterator.enforceRealBlocks = true;
210 iterator.enlargeBr = enterMode != CKEDITOR.ENTER_BR;
212 while ( ( block = iterator.getNextParagraph( enterMode == CKEDITOR.ENTER_P ? 'p' : 'div' ) ) )
213 indentElement( block );
216 function indentElement( element, dir )
218 if ( element.getCustomData( 'indent_processed' ) )
221 if ( self.useIndentClasses )
223 // Transform current class name to indent step index.
224 var indentClass = element.$.className.match( self.classNameRegex ),
228 indentClass = indentClass[1];
229 indentStep = self.indentClassMap[ indentClass ];
232 // Operate on indent step index, transform indent step index back to class
234 if ( self.name == 'outdent' )
239 if ( indentStep < 0 )
242 indentStep = Math.min( indentStep, editor.config.indentClasses.length );
243 indentStep = Math.max( indentStep, 0 );
244 element.$.className = CKEDITOR.tools.ltrim( element.$.className.replace( self.classNameRegex, '' ) );
245 if ( indentStep > 0 )
246 element.addClass( editor.config.indentClasses[ indentStep - 1 ] );
250 var indentCssProperty = getIndentCssProperty( element, dir ),
251 currentOffset = parseInt( element.getStyle( indentCssProperty ), 10 );
252 if ( isNaN( currentOffset ) )
254 var indentOffset = editor.config.indentOffset || 40;
255 currentOffset += ( self.name == 'indent' ? 1 : -1 ) * indentOffset;
257 if ( currentOffset < 0 )
260 currentOffset = Math.max( currentOffset, 0 );
261 currentOffset = Math.ceil( currentOffset / indentOffset ) * indentOffset;
262 element.setStyle( indentCssProperty, currentOffset ? currentOffset + ( editor.config.indentUnit || 'px' ) : '' );
263 if ( element.getAttribute( 'style' ) === '' )
264 element.removeAttribute( 'style' );
267 CKEDITOR.dom.element.setMarker( database, element, 'indent_processed', 1 );
271 var selection = editor.getSelection(),
272 bookmarks = selection.createBookmarks( 1 ),
273 ranges = selection && selection.getRanges( 1 ),
277 var iterator = ranges.createIterator();
278 while ( ( range = iterator.getNextRange() ) )
280 var rangeRoot = range.getCommonAncestor(),
281 nearestListBlock = rangeRoot;
283 while ( nearestListBlock && !( nearestListBlock.type == CKEDITOR.NODE_ELEMENT &&
284 listNodeNames[ nearestListBlock.getName() ] ) )
285 nearestListBlock = nearestListBlock.getParent();
287 // Avoid having selection enclose the entire list. (#6138)
288 // [<ul><li>...</li></ul>] =><ul><li>[...]</li></ul>
289 if ( !nearestListBlock )
291 var selectedNode = range.getEnclosedNode();
293 && selectedNode.type == CKEDITOR.NODE_ELEMENT
294 && selectedNode.getName() in listNodeNames)
296 range.setStartAt( selectedNode, CKEDITOR.POSITION_AFTER_START );
297 range.setEndAt( selectedNode, CKEDITOR.POSITION_BEFORE_END );
298 nearestListBlock = selectedNode;
302 // Avoid selection anchors under list root.
303 // <ul>[<li>...</li>]</ul> => <ul><li>[...]</li></ul>
304 if ( nearestListBlock && range.startContainer.type == CKEDITOR.NODE_ELEMENT
305 && range.startContainer.getName() in listNodeNames )
307 var walker = new CKEDITOR.dom.walker( range );
308 walker.evaluator = isListItem;
309 range.startContainer = walker.next();
312 if ( nearestListBlock && range.endContainer.type == CKEDITOR.NODE_ELEMENT
313 && range.endContainer.getName() in listNodeNames )
315 walker = new CKEDITOR.dom.walker( range );
316 walker.evaluator = isListItem;
317 range.endContainer = walker.previous();
320 if ( nearestListBlock )
322 var firstListItem = nearestListBlock.getFirst( isListItem ),
323 hasMultipleItems = !!firstListItem.getNext( isListItem ),
324 rangeStart = range.startContainer,
325 indentWholeList = firstListItem.equals( rangeStart ) || firstListItem.contains( rangeStart );
327 // Indent the entire list if cursor is inside the first list item. (#3893)
328 // Only do that for indenting or when using indent classes or when there is something to outdent. (#6141)
329 if ( !( indentWholeList &&
330 ( self.name == 'indent' || self.useIndentClasses || parseInt( nearestListBlock.getStyle( getIndentCssProperty( nearestListBlock ) ), 10 ) ) &&
331 indentElement( nearestListBlock, !hasMultipleItems && firstListItem.getDirection() ) ) )
332 indentList( nearestListBlock );
338 // Clean up the markers.
339 CKEDITOR.dom.element.clearAllMarkers( database );
341 editor.forceNextSelectionCheck();
342 selection.selectBookmarks( bookmarks );
346 CKEDITOR.plugins.add( 'indent',
348 init : function( editor )
350 // Register commands.
351 var indent = editor.addCommand( 'indent', new indentCommand( editor, 'indent' ) ),
352 outdent = editor.addCommand( 'outdent', new indentCommand( editor, 'outdent' ) );
354 // Register the toolbar buttons.
355 editor.ui.addButton( 'Indent',
357 label : editor.lang.indent,
360 editor.ui.addButton( 'Outdent',
362 label : editor.lang.outdent,
366 // Register the state changing handlers.
367 editor.on( 'selectionChange', CKEDITOR.tools.bind( onSelectionChange, indent ) );
368 editor.on( 'selectionChange', CKEDITOR.tools.bind( onSelectionChange, outdent ) );
370 // [IE6/7] Raw lists are using margin instead of padding for visual indentation in wysiwyg mode. (#3893)
371 if ( CKEDITOR.env.ie6Compat || CKEDITOR.env.ie7Compat )
376 " margin-left: 0px;" +
377 " padding-left: 40px;" +
381 // Register dirChanged listener.
382 editor.on( 'dirChanged', function( e )
384 var range = new CKEDITOR.dom.range( editor.document );
385 range.setStartBefore( e.data.node );
386 range.setEndAfter( e.data.node );
388 var walker = new CKEDITOR.dom.walker( range ),
391 while ( ( node = walker.next() ) )
393 if ( node.type == CKEDITOR.NODE_ELEMENT )
395 // A child with the defined dir is to be ignored.
396 if ( !node.equals( e.data.node ) && node.getDirection() )
398 range.setStartAfter( node );
399 walker = new CKEDITOR.dom.walker( range );
403 // Switch alignment classes.
404 var classes = editor.config.indentClasses;
407 var suffix = ( e.data.dir == 'ltr' ) ? [ '_rtl', '' ] : [ '', '_rtl' ];
408 for ( var i = 0; i < classes.length; i++ )
410 if ( node.hasClass( classes[ i ] + suffix[ 0 ] ) )
412 node.removeClass( classes[ i ] + suffix[ 0 ] );
413 node.addClass( classes[ i ] + suffix[ 1 ] );
418 // Switch the margins.
419 var marginLeft = node.getStyle( 'margin-right' ),
420 marginRight = node.getStyle( 'margin-left' );
422 marginLeft ? node.setStyle( 'margin-left', marginLeft ) : node.removeStyle( 'margin-left' );
423 marginRight ? node.setStyle( 'margin-right', marginRight ) : node.removeStyle( 'margin-right' );
429 requires : [ 'domiterator', 'list' ]
434 * Size of each indentation step
435 * @name CKEDITOR.config.indentOffset
439 * config.indentOffset = 4;
443 * Unit for the indentation style
444 * @name CKEDITOR.config.indentUnit
448 * config.indentUnit = 'em';
452 * List of classes to use for indenting the contents. If it's null, no classes will be used
453 * and instead the {@link #indentUnit} and {@link #indentOffset} properties will be used.
454 * @name CKEDITOR.config.indentClasses
458 * // Use the classes 'Indent1', 'Indent2', 'Indent3'
459 * config.indentClasses = ['Indent1', 'Indent2', 'Indent3'];