2 * Copyright (c) 2003-2011, CKSource - Frederico Knabben. All rights reserved.
3 * For licensing, see LICENSE.html or http://ckeditor.com/license
10 * Add to collection with DUP examination.
11 * @param {Object} collection
12 * @param {Object} element
13 * @param {Object} database
15 function addSafely( collection, element, database )
17 // 1. IE doesn't support customData on text nodes;
18 // 2. Text nodes never get chance to appear twice;
19 if ( !element.is || !element.getCustomData( 'block_processed' ) )
21 element.is && CKEDITOR.dom.element.setMarker( database, element, 'block_processed', true );
22 collection.push( element );
26 function getNonEmptyChildren( element )
29 var children = element.getChildren();
30 for ( var i = 0 ; i < children.count() ; i++ )
32 var child = children.getItem( i );
33 if ( ! ( child.type === CKEDITOR.NODE_TEXT
34 && ( /^[ \t\n\r]+$/ ).test( child.getText() ) ) )
42 * Dialog reused by both 'creatediv' and 'editdiv' commands.
43 * @param {Object} editor
44 * @param {String} command The command name which indicate what the current command is.
46 function divDialog( editor, command )
48 // Definition of elements at which div operation should stopped.
49 var divLimitDefinition = ( function(){
51 // Customzie from specialize blockLimit elements
52 var definition = CKEDITOR.tools.extend( {}, CKEDITOR.dtd.$blockLimit );
54 // Exclude 'div' itself.
55 delete definition.div;
57 // Exclude 'td' and 'th' when 'wrapping table'
58 if ( editor.config.div_wrapTable )
66 // DTD of 'div' element
67 var dtd = CKEDITOR.dtd.div;
70 * Get the first div limit element on the element's path.
71 * @param {Object} element
73 function getDivLimitElement( element )
75 var pathElements = new CKEDITOR.dom.elementPath( element ).elements;
77 for ( var i = 0; i < pathElements.length ; i++ )
79 if ( pathElements[ i ].getName() in divLimitDefinition )
81 divLimit = pathElements[ i ];
89 * Init all fields' setup/commit function.
92 function setupFields()
94 this.foreach( function( field )
96 // Exclude layout container elements
97 if ( /^(?!vbox|hbox)/.test( field.type ) )
101 // Read the dialog fields values from the specified
102 // element attributes.
103 field.setup = function( element )
105 field.setValue( element.getAttribute( field.id ) || '' );
110 // Set element attributes assigned by the dialog
112 field.commit = function( element )
114 var fieldValue = this.getValue();
115 // ignore default element attribute values
116 if ( 'dir' == field.id && element.getComputedStyle( 'direction' ) == fieldValue )
120 element.setAttribute( field.id, fieldValue );
122 element.removeAttribute( field.id );
130 * Wrapping 'div' element around appropriate blocks among the selected ranges.
131 * @param {Object} editor
133 function createDiv( editor )
135 // new adding containers OR detected pre-existed containers.
137 // node markers store.
139 // All block level elements which contained by the ranges.
140 var containedBlocks = [], block;
142 // Get all ranges from the selection.
143 var selection = editor.document.getSelection(),
144 ranges = selection.getRanges();
145 var bookmarks = selection.createBookmarks();
148 // Calcualte a default block tag if we need to create blocks.
149 var blockTag = editor.config.enterMode == CKEDITOR.ENTER_DIV ? 'div' : 'p';
151 // collect all included elements from dom-iterator
152 for ( i = 0 ; i < ranges.length ; i++ )
154 iterator = ranges[ i ].createIterator();
155 while ( ( block = iterator.getNextParagraph() ) )
157 // include contents of blockLimit elements.
158 if ( block.getName() in divLimitDefinition )
160 var j, childNodes = block.getChildren();
161 for ( j = 0 ; j < childNodes.count() ; j++ )
162 addSafely( containedBlocks, childNodes.getItem( j ) , database );
166 // Bypass dtd disallowed elements.
167 while ( !dtd[ block.getName() ] && block.getName() != 'body' )
168 block = block.getParent();
169 addSafely( containedBlocks, block, database );
174 CKEDITOR.dom.element.clearAllMarkers( database );
176 var blockGroups = groupByDivLimit( containedBlocks );
177 var ancestor, blockEl, divElement;
179 for ( i = 0 ; i < blockGroups.length ; i++ )
181 var currentNode = blockGroups[ i ][ 0 ];
183 // Calculate the common parent node of all contained elements.
184 ancestor = currentNode.getParent();
185 for ( j = 1 ; j < blockGroups[ i ].length; j++ )
186 ancestor = ancestor.getCommonAncestor( blockGroups[ i ][ j ] );
188 divElement = new CKEDITOR.dom.element( 'div', editor.document );
190 // Normalize the blocks in each group to a common parent.
191 for ( j = 0; j < blockGroups[ i ].length ; j++ )
193 currentNode = blockGroups[ i ][ j ];
195 while ( !currentNode.getParent().equals( ancestor ) )
196 currentNode = currentNode.getParent();
198 // This could introduce some duplicated elements in array.
199 blockGroups[ i ][ j ] = currentNode;
202 // Wrapped blocks counting
203 var fixedBlock = null;
204 for ( j = 0 ; j < blockGroups[ i ].length ; j++ )
206 currentNode = blockGroups[ i ][ j ];
208 // Avoid DUP elements introduced by grouping.
209 if ( !( currentNode.getCustomData && currentNode.getCustomData( 'block_processed' ) ) )
211 currentNode.is && CKEDITOR.dom.element.setMarker( database, currentNode, 'block_processed', true );
213 // Establish new container, wrapping all elements in this group.
215 divElement.insertBefore( currentNode );
217 divElement.append( currentNode );
221 CKEDITOR.dom.element.clearAllMarkers( database );
222 containers.push( divElement );
225 selection.selectBookmarks( bookmarks );
229 function getDiv( editor )
231 var path = new CKEDITOR.dom.elementPath( editor.getSelection().getStartElement() ),
232 blockLimit = path.blockLimit,
233 div = blockLimit && blockLimit.getAscendant( 'div', true );
237 * Divide a set of nodes to different groups by their path's blocklimit element.
238 * Note: the specified nodes should be in source order naturally, which mean they are supposed to producea by following class:
239 * * CKEDITOR.dom.range.Iterator
240 * * CKEDITOR.dom.domWalker
241 * @return {Array []} the grouped nodes
243 function groupByDivLimit( nodes )
248 for ( var i = 0 ; i < nodes.length ; i++ )
251 var limit = getDivLimitElement( block );
252 if ( !limit.equals( lastDivLimit ) )
254 lastDivLimit = limit ;
257 groups[ groups.length - 1 ].push( block ) ;
262 // Synchronous field values to other impacted fields is required, e.g. div styles
263 // change should also alter inline-style text.
264 function commitInternally( targetFields )
266 var dialog = this.getDialog(),
267 element = dialog._element && dialog._element.clone()
268 || new CKEDITOR.dom.element( 'div', editor.document );
270 // Commit this field and broadcast to target fields.
271 this.commit( element, true );
273 targetFields = [].concat( targetFields );
274 var length = targetFields.length, field;
275 for ( var i = 0; i < length; i++ )
277 field = dialog.getContentElement.apply( dialog, targetFields[ i ].split( ':' ) );
278 field && field.setup && field.setup( element, true );
283 // Registered 'CKEDITOR.style' instances.
286 * Hold a collection of created block container elements.
293 title : editor.lang.div.title,
300 label :editor.lang.common.generalTab,
301 title :editor.lang.common.generalTab,
306 widths : [ '50%', '50%' ],
312 style :'width: 100%;',
313 label :editor.lang.div.styleSelectLabel,
315 // Options are loaded dynamically.
318 [ editor.lang.common.notSet , '' ]
320 onChange : function()
322 commitInternally.call( this, [ 'info:class', 'advanced:dir', 'advanced:style' ] );
324 setup : function( element )
326 for ( var name in styles )
327 styles[ name ].checkElementRemovable( element, true ) && this.setValue( name );
329 commit: function( element )
332 if ( ( styleName = this.getValue() ) )
334 var style = styles[ styleName ];
335 var customData = element.getCustomData( 'elementStyle' ) || '';
337 style.applyToObject( element );
338 element.setCustomData( 'elementStyle', customData + style._.definition.attributes.style );
345 label :editor.lang.common.cssClass,
354 label :editor.lang.common.advancedTab,
355 title :editor.lang.common.advancedTab,
365 widths : [ '50%', '50%' ],
371 label :editor.lang.common.id,
377 label :editor.lang.link.langCode,
389 style :'width: 100%;',
390 label :editor.lang.common.cssStyle,
392 commit : function( element )
394 // Merge with 'elementStyle', which is of higher priority.
395 var merged = this.getValue() + ( element.getCustomData( 'elementStyle' ) || '' );
396 element.setAttribute( 'style', merged );
408 style :'width: 100%;',
409 label :editor.lang.common.advisoryTitle,
417 style :'width: 100%;',
418 label :editor.lang.common.langDir,
422 [ editor.lang.common.notSet , '' ],
424 editor.lang.common.langDirLtr,
428 editor.lang.common.langDirRtl,
440 setupFields.call( this );
442 // Preparing for the 'elementStyle' field.
444 stylesField = this.getContentElement( 'info', 'elementStyle' );
446 // Reuse the 'stylescombo' plugin's styles definition.
447 editor.getStylesSet( function( stylesDefinitions )
451 if ( stylesDefinitions )
453 // Digg only those styles that apply to 'div'.
454 for ( var i = 0 ; i < stylesDefinitions.length ; i++ )
456 var styleDefinition = stylesDefinitions[ i ];
457 if ( styleDefinition.element && styleDefinition.element == 'div' )
459 styleName = styleDefinition.name;
460 styles[ styleName ] = new CKEDITOR.style( styleDefinition );
462 // Populate the styles field options with style name.
463 stylesField.items.push( [ styleName, styleName ] );
464 stylesField.add( styleName, styleName );
469 // We should disable the content element
470 // it if no options are available at all.
471 stylesField[ stylesField.items.length > 1 ? 'enable' : 'disable' ]();
473 // Now setup the field value manually.
474 setTimeout( function() { stylesField.setup( dialog._element ); }, 0 );
479 // Whether always create new container regardless of existed
481 if ( command == 'editdiv' )
483 // Try to discover the containers that already existed in
485 var div = getDiv( editor );
486 // update dialog field values
487 div && this.setupContent( this._element = div );
492 if ( command == 'editdiv' )
493 containers = [ this._element ];
495 containers = createDiv( editor, true );
497 // Update elements attributes
498 var size = containers.length;
499 for ( var i = 0; i < size; i++ )
501 this.commitContent( containers[ i ] );
503 // Remove empty 'style' attribute.
504 !containers[ i ].getAttribute( 'style' ) && containers[ i ].removeAttribute( 'style' );
511 // Remove style only when editing existing DIV. (#6315)
512 if ( command == 'editdiv' )
513 this._element.removeCustomData( 'elementStyle' );
514 delete this._element;
519 CKEDITOR.dialog.add( 'creatediv', function( editor )
521 return divDialog( editor, 'creatediv' );
523 CKEDITOR.dialog.add( 'editdiv', function( editor )
525 return divDialog( editor, 'editdiv' );
530 * @name CKEDITOR.config.div_wrapTable
531 * Whether to wrap the whole table instead of indivisual cells when created 'div' in table cell.
534 * @example config.div_wrapTable = true;