2 Copyright (c) 2003-2011, CKSource - Frederico Knabben. All rights reserved.
3 For licensing, see LICENSE.html or http://ckeditor.com/license
7 * @fileOverview The "toolbar" plugin. Renders the default toolbar interface in
13 var toolbox = function()
16 this.focusCommandExecuted = false;
19 toolbox.prototype.focus = function()
21 for ( var t = 0, toolbar ; toolbar = this.toolbars[ t++ ] ; )
23 for ( var i = 0, item ; item = toolbar.items[ i++ ] ; )
38 modes : { wysiwyg : 1, source : 1 },
41 exec : function( editor )
45 editor.toolbox.focusCommandExecuted = true;
47 // Make the first button focus accessible for IE. (#3417)
48 // Adobe AIR instead need while of delay.
49 if ( CKEDITOR.env.ie || CKEDITOR.env.air )
50 setTimeout( function(){ editor.toolbox.focus(); }, 100 );
52 editor.toolbox.focus();
58 CKEDITOR.plugins.add( 'toolbar',
60 init : function( editor )
64 var itemKeystroke = function( item, keystroke )
67 var rtl = editor.lang.dir == 'rtl',
68 toolbarGroupCycling = editor.config.toolbarGroupCycling;
70 toolbarGroupCycling = toolbarGroupCycling === undefined || toolbarGroupCycling;
75 case CKEDITOR.SHIFT + 9 : // SHIFT + TAB
76 // Cycle through the toolbars, starting from the one
77 // closest to the current item.
78 while ( !toolbar || !toolbar.items.length )
80 toolbar = keystroke == 9 ?
81 ( ( toolbar ? toolbar.next : item.toolbar.next ) || editor.toolbox.toolbars[ 0 ] ) :
82 ( ( toolbar ? toolbar.previous : item.toolbar.previous ) || editor.toolbox.toolbars[ editor.toolbox.toolbars.length - 1 ] );
84 // Look for the first item that accepts focus.
85 if ( toolbar.items.length )
87 item = toolbar.items[ endFlag ? ( toolbar.items.length - 1 ) : 0 ];
88 while ( item && !item.focus )
90 item = endFlag ? item.previous : item.next;
103 case rtl ? 37 : 39 : // RIGHT-ARROW
104 case 40 : // DOWN-ARROW
108 // Look for the next item in the toolbar.
111 // If it's the last item, cycle to the first one.
112 if ( !next && toolbarGroupCycling )
113 next = item.toolbar.items[ 0 ];
115 while ( next && !next.focus )
117 // If available, just focus it, otherwise focus the
123 itemKeystroke( item, 9 );
127 case rtl ? 39 : 37 : // LEFT-ARROW
128 case 38 : // UP-ARROW
132 // Look for the previous item in the toolbar.
133 next = next.previous;
135 // If it's the first item, cycle to the last one.
136 if ( !next && toolbarGroupCycling )
137 next = item.toolbar.items[ item.toolbar.items.length - 1 ];
139 while ( next && !next.focus )
141 // If available, just focus it, otherwise focus the
148 // Send a SHIFT + TAB.
149 itemKeystroke( item, CKEDITOR.SHIFT + 9 );
167 editor.on( 'themeSpace', function( event )
169 if ( event.data.space == editor.config.toolbarLocation )
171 editor.toolbox = new toolbox();
173 var labelId = CKEDITOR.tools.getNextId();
175 var output = [ '<div class="cke_toolbox" role="group" aria-labelledby="', labelId, '" onmousedown="return false;"' ],
176 expanded = editor.config.toolbarStartupExpanded !== false,
179 output.push( expanded ? '>' : ' style="display:none">' );
181 // Sends the ARIA label.
182 output.push( '<span id="', labelId, '" class="cke_voice_label">', editor.lang.toolbars, '</span>' );
184 var toolbars = editor.toolbox.toolbars,
186 ( editor.config.toolbar instanceof Array ) ?
187 editor.config.toolbar
189 editor.config[ 'toolbar_' + editor.config.toolbar ];
191 for ( var r = 0 ; r < toolbar.length ; r++ )
199 // It's better to check if the row object is really
200 // available because it's a common mistake to leave
201 // an extra comma in the toolbar definition
202 // settings, which leads on the editor not loading
203 // at all in IE. (#3983)
209 output.push( '</div>' );
215 output.push( '<div class="cke_break"></div>' );
219 items = row.items || row;
221 // Create all items defined for this toolbar.
222 for ( var i = 0 ; i < items.length ; i++ )
225 itemName = items[ i ],
228 item = editor.ui.create( itemName );
232 canGroup = item.canGroup !== false;
234 // Initialize the toolbar first, if needed.
237 // Create the basic toolbar object.
238 toolbarId = CKEDITOR.tools.getNextId();
239 toolbarObj = { id : toolbarId, items : [] };
240 toolbarName = row.name && ( editor.lang.toolbarGroups[ row.name ] || row.name );
242 // Output the toolbar opener.
243 output.push( '<span id="', toolbarId, '" class="cke_toolbar"',
244 ( toolbarName ? ' aria-labelledby="'+ toolbarId + '_label"' : '' ),
245 ' role="toolbar">' );
247 // If a toolbar name is available, send the voice label.
248 toolbarName && output.push( '<span id="', toolbarId, '_label" class="cke_voice_label">', toolbarName, '</span>' );
250 output.push( '<span class="cke_toolbar_start"></span>' );
252 // Add the toolbar to the "editor.toolbox.toolbars"
254 var index = toolbars.push( toolbarObj ) - 1;
256 // Create the next/previous reference.
259 toolbarObj.previous = toolbars[ index - 1 ];
260 toolbarObj.previous.next = toolbarObj;
268 output.push( '<span class="cke_toolgroup" role="presentation">' );
272 else if ( groupStarted )
274 output.push( '</span>' );
278 var itemObj = item.render( editor, output );
279 index = toolbarObj.items.push( itemObj ) - 1;
283 itemObj.previous = toolbarObj.items[ index - 1 ];
284 itemObj.previous.next = itemObj;
287 itemObj.toolbar = toolbarObj;
288 itemObj.onkey = itemKeystroke;
292 * Prevent JAWS from focusing the toolbar after document load.
294 itemObj.onfocus = function()
296 if ( !editor.toolbox.focusCommandExecuted )
304 output.push( '</span>' );
309 output.push( '<span class="cke_toolbar_end"></span></span>' );
312 output.push( '</div>' );
314 if ( editor.config.toolbarCanCollapse )
316 var collapserFn = CKEDITOR.tools.addFunction(
319 editor.execCommand( 'toolbarCollapse' );
322 editor.on( 'destroy', function () {
323 CKEDITOR.tools.removeFunction( collapserFn );
326 var collapserId = CKEDITOR.tools.getNextId();
328 editor.addCommand( 'toolbarCollapse',
331 exec : function( editor )
333 var collapser = CKEDITOR.document.getById( collapserId ),
334 toolbox = collapser.getPrevious(),
335 contents = editor.getThemeSpace( 'contents' ),
336 toolboxContainer = toolbox.getParent(),
337 contentHeight = parseInt( contents.$.style.height, 10 ),
338 previousHeight = toolboxContainer.$.offsetHeight,
339 collapsed = !toolbox.isVisible();
344 collapser.addClass( 'cke_toolbox_collapser_min' );
345 collapser.setAttribute( 'title', editor.lang.toolbarExpand );
350 collapser.removeClass( 'cke_toolbox_collapser_min' );
351 collapser.setAttribute( 'title', editor.lang.toolbarCollapse );
354 // Update collapser symbol.
355 collapser.getFirst().setText( collapsed ?
356 '\u25B2' : // BLACK UP-POINTING TRIANGLE
357 '\u25C0' ); // BLACK LEFT-POINTING TRIANGLE
359 var dy = toolboxContainer.$.offsetHeight - previousHeight;
360 contents.setStyle( 'height', ( contentHeight - dy ) + 'px' );
362 editor.fire( 'resize' );
365 modes : { wysiwyg : 1, source : 1 }
368 output.push( '<a title="' + ( expanded ? editor.lang.toolbarCollapse : editor.lang.toolbarExpand )
369 + '" id="' + collapserId + '" tabIndex="-1" class="cke_toolbox_collapser' );
372 output.push( ' cke_toolbox_collapser_min' );
374 output.push( '" onclick="CKEDITOR.tools.callFunction(' + collapserFn + ')">',
375 '<span>▲</span>', // BLACK UP-POINTING TRIANGLE
379 event.data.html += output.join( '' );
383 editor.on( 'destroy', function()
385 var toolbars, index = 0, i,
387 toolbars = this.toolbox.toolbars;
388 for ( ; index < toolbars.length; index++ )
390 items = toolbars[ index ].items;
391 for ( i = 0; i < items.length; i++ )
393 instance = items[ i ];
394 if ( instance.clickFn ) CKEDITOR.tools.removeFunction( instance.clickFn );
395 if ( instance.keyDownFn ) CKEDITOR.tools.removeFunction( instance.keyDownFn );
400 editor.addCommand( 'toolbarFocus', commands.toolbarFocus );
402 editor.ui.add( '-', CKEDITOR.UI_SEPARATOR, {} );
403 editor.ui.addHandler( CKEDITOR.UI_SEPARATOR,
408 render : function( editor, output )
410 output.push( '<span class="cke_separator" role="separator"></span>' );
420 CKEDITOR.UI_SEPARATOR = 'separator';
423 * The "theme space" to which rendering the toolbar. For the default theme,
424 * the recommended options are "top" and "bottom".
427 * @see CKEDITOR.config.theme
429 * config.toolbarLocation = 'bottom';
431 CKEDITOR.config.toolbarLocation = 'top';
434 * The toolbar definition. It is an array of toolbars (strips),
435 * each one being also an array, containing a list of UI items.
436 * Note that this setting is composed by "toolbar_" added by the toolbar name,
437 * which in this case is called "Basic". This second part of the setting name
438 * can be anything. You must use this name in the
439 * {@link CKEDITOR.config.toolbar} setting, so you instruct the editor which
440 * toolbar_(name) setting to you.
443 * // Defines a toolbar with only one strip containing the "Source" button, a
444 * // separator and the "Bold" and "Italic" buttons.
445 * <b>config.toolbar_Basic =
447 * [ 'Source', '-', 'Bold', 'Italic' ]
449 * config.toolbar = 'Basic';
451 CKEDITOR.config.toolbar_Basic =
453 ['Bold', 'Italic', '-', 'NumberedList', 'BulletedList', '-', 'Link', 'Unlink','-','About']
457 * This is the default toolbar definition used by the editor. It contains all
460 * @default (see example)
462 * // This is actually the default value.
463 * config.toolbar_Full =
465 * { name: 'document', items : [ 'Source','-','Save','NewPage','DocProps','Preview','Print','-','Templates' ] },
466 * { name: 'clipboard', items : [ 'Cut','Copy','Paste','PasteText','PasteFromWord','-','Undo','Redo' ] },
467 * { name: 'editing', items : [ 'Find','Replace','-','SelectAll','-','SpellChecker', 'Scayt' ] },
468 * { name: 'forms', items : [ 'Form', 'Checkbox', 'Radio', 'TextField', 'Textarea', 'Select', 'Button', 'ImageButton', 'HiddenField' ] },
470 * { name: 'basicstyles', items : [ 'Bold','Italic','Underline','Strike','Subscript','Superscript','-','RemoveFormat' ] },
471 * { name: 'paragraph', items : [ 'NumberedList','BulletedList','-','Outdent','Indent','-','Blockquote','CreateDiv','-','JustifyLeft','JustifyCenter','JustifyRight','JustifyBlock','-','BidiLtr','BidiRtl' ] },
472 * { name: 'links', items : [ 'Link','Unlink','Anchor' ] },
473 * { name: 'insert', items : [ 'Image','Flash','Table','HorizontalRule','Smiley','SpecialChar','PageBreak' ] },
475 * { name: 'styles', items : [ 'Styles','Format','Font','FontSize' ] },
476 * { name: 'colors', items : [ 'TextColor','BGColor' ] },
477 * { name: 'tools', items : [ 'Maximize', 'ShowBlocks','-','About' ] }
480 CKEDITOR.config.toolbar_Full =
482 { name: 'document', items : [ 'Source','-','Save','NewPage','DocProps','Preview','Print','-','Templates' ] },
483 { name: 'clipboard', items : [ 'Cut','Copy','Paste','PasteText','PasteFromWord','-','Undo','Redo' ] },
484 { name: 'editing', items : [ 'Find','Replace','-','SelectAll','-','SpellChecker', 'Scayt' ] },
485 { name: 'forms', items : [ 'Form', 'Checkbox', 'Radio', 'TextField', 'Textarea', 'Select', 'Button', 'ImageButton', 'HiddenField' ] },
487 { name: 'basicstyles', items : [ 'Bold','Italic','Underline','Strike','Subscript','Superscript','-','RemoveFormat' ] },
488 { name: 'paragraph', items : [ 'NumberedList','BulletedList','-','Outdent','Indent','-','Blockquote','CreateDiv','-','JustifyLeft','JustifyCenter','JustifyRight','JustifyBlock','-','BidiLtr','BidiRtl' ] },
489 { name: 'links', items : [ 'Link','Unlink','Anchor' ] },
490 { name: 'insert', items : [ 'Image','Flash','Table','HorizontalRule','Smiley','SpecialChar','PageBreak','Iframe' ] },
492 { name: 'styles', items : [ 'Styles','Format','Font','FontSize' ] },
493 { name: 'colors', items : [ 'TextColor','BGColor' ] },
494 { name: 'tools', items : [ 'Maximize', 'ShowBlocks','-','About' ] }
498 * The toolbox (alias toolbar) definition. It is a toolbar name or an array of
499 * toolbars (strips), each one being also an array, containing a list of UI items.
503 * // Defines a toolbar with only one strip containing the "Source" button, a
504 * // separator and the "Bold" and "Italic" buttons.
507 * [ 'Source', '-', 'Bold', 'Italic' ]
510 * // Load toolbar_Name where Name = Basic.
511 * config.toolbar = 'Basic';
513 CKEDITOR.config.toolbar = 'Full';
516 * Whether the toolbar can be collapsed by the user. If disabled, the collapser
517 * button will not be displayed.
521 * config.toolbarCanCollapse = false;
523 CKEDITOR.config.toolbarCanCollapse = true;
526 * Whether the toolbar must start expanded when the editor is loaded.
527 * @name CKEDITOR.config.toolbarStartupExpanded
531 * config.toolbarStartupExpanded = false;
535 * When enabled, makes the arrow keys navigation cycle within the current
536 * toolbar group. Otherwise the arrows will move trought all items available in
537 * the toolbar. The TAB key will still be used to quickly jump among the
539 * @name CKEDITOR.config.toolbarGroupCycling
544 * config.toolbarGroupCycling = false;