egroupware/phpgwapi/js/ckeditor3/_source/plugins/toolbar/plugin.js
2010-05-21 11:51:40 +00:00

480 lines
14 KiB
JavaScript

/*
Copyright (c) 2003-2010, CKSource - Frederico Knabben. All rights reserved.
For licensing, see LICENSE.html or http://ckeditor.com/license
*/
/**
* @fileOverview The "toolbar" plugin. Renders the default toolbar interface in
* the editor.
*/
(function()
{
var toolbox = function()
{
this.toolbars = [];
this.focusCommandExecuted = false;
};
toolbox.prototype.focus = function()
{
for ( var t = 0, toolbar ; toolbar = this.toolbars[ t++ ] ; )
{
for ( var i = 0, item ; item = toolbar.items[ i++ ] ; )
{
if ( item.focus )
{
item.focus();
return;
}
}
}
};
var commands =
{
toolbarFocus :
{
modes : { wysiwyg : 1, source : 1 },
exec : function( editor )
{
if ( editor.toolbox )
{
editor.toolbox.focusCommandExecuted = true;
// Make the first button focus accessible. (#3417)
if ( CKEDITOR.env.ie )
setTimeout( function(){ editor.toolbox.focus(); }, 100 );
else
editor.toolbox.focus();
}
}
}
};
CKEDITOR.plugins.add( 'toolbar',
{
init : function( editor )
{
var itemKeystroke = function( item, keystroke )
{
var next, nextToolGroup, groupItemsCount;
var rtl = editor.lang.dir == 'rtl';
switch ( keystroke )
{
case rtl ? 37 : 39 : // RIGHT-ARROW
case 9 : // TAB
do
{
// Look for the next item in the toolbar.
next = item.next;
if ( !next )
{
nextToolGroup = item.toolbar.next;
groupItemsCount = nextToolGroup && nextToolGroup.items.length;
// Bypass the empty toolgroups.
while ( groupItemsCount === 0 )
{
nextToolGroup = nextToolGroup.next;
groupItemsCount = nextToolGroup && nextToolGroup.items.length;
}
if ( nextToolGroup )
next = nextToolGroup.items[ 0 ];
}
item = next;
}
while ( item && !item.focus )
// If available, just focus it, otherwise focus the
// first one.
if ( item )
item.focus();
else
editor.toolbox.focus();
return false;
case rtl ? 39 : 37 : // LEFT-ARROW
case CKEDITOR.SHIFT + 9 : // SHIFT + TAB
do
{
// Look for the previous item in the toolbar.
next = item.previous;
if ( !next )
{
nextToolGroup = item.toolbar.previous;
groupItemsCount = nextToolGroup && nextToolGroup.items.length;
// Bypass the empty toolgroups.
while ( groupItemsCount === 0 )
{
nextToolGroup = nextToolGroup.previous;
groupItemsCount = nextToolGroup && nextToolGroup.items.length;
}
if ( nextToolGroup )
next = nextToolGroup.items[ groupItemsCount - 1 ];
}
item = next;
}
while ( item && !item.focus )
// If available, just focus it, otherwise focus the
// last one.
if ( item )
item.focus();
else
{
var lastToolbarItems = editor.toolbox.toolbars[ editor.toolbox.toolbars.length - 1 ].items;
lastToolbarItems[ lastToolbarItems.length - 1 ].focus();
}
return false;
case 27 : // ESC
editor.focus();
return false;
case 13 : // ENTER
case 32 : // SPACE
item.execute();
return false;
}
return true;
};
editor.on( 'themeSpace', function( event )
{
if ( event.data.space == editor.config.toolbarLocation )
{
editor.toolbox = new toolbox();
var labelId = 'cke_' + CKEDITOR.tools.getNextNumber();
var output = [ '<div class="cke_toolbox" role="toolbar" aria-labelledby="', labelId, '"' ],
expanded = editor.config.toolbarStartupExpanded !== false,
groupStarted;
output.push( expanded ? '>' : ' style="display:none">' );
// Sends the ARIA label.
output.push( '<span id="', labelId, '" class="cke_voice_label">', editor.lang.toolbar, '</span>' );
var toolbars = editor.toolbox.toolbars,
toolbar =
( editor.config.toolbar instanceof Array ) ?
editor.config.toolbar
:
editor.config[ 'toolbar_' + editor.config.toolbar ];
for ( var r = 0 ; r < toolbar.length ; r++ )
{
var row = toolbar[ r ];
// It's better to check if the row object is really
// available because it's a common mistake to leave
// an extra comma in the toolbar definition
// settings, which leads on the editor not loading
// at all in IE. (#3983)
if ( !row )
continue;
var toolbarId = 'cke_' + CKEDITOR.tools.getNextNumber(),
toolbarObj = { id : toolbarId, items : [] };
if ( groupStarted )
{
output.push( '</div>' );
groupStarted = 0;
}
if ( row === '/' )
{
output.push( '<div class="cke_break"></div>' );
continue;
}
output.push( '<span id="', toolbarId, '" class="cke_toolbar" role="presentation"><span class="cke_toolbar_start"></span>' );
// Add the toolbar to the "editor.toolbox.toolbars"
// array.
var index = toolbars.push( toolbarObj ) - 1;
// Create the next/previous reference.
if ( index > 0 )
{
toolbarObj.previous = toolbars[ index - 1 ];
toolbarObj.previous.next = toolbarObj;
}
// Create all items defined for this toolbar.
for ( var i = 0 ; i < row.length ; i++ )
{
var item,
itemName = row[ i ];
if ( itemName == '-' )
item = CKEDITOR.ui.separator;
else
item = editor.ui.create( itemName );
if ( item )
{
if ( item.canGroup )
{
if ( !groupStarted )
{
output.push( '<span class="cke_toolgroup" role="presentation">' );
groupStarted = 1;
}
}
else if ( groupStarted )
{
output.push( '</span>' );
groupStarted = 0;
}
var itemObj = item.render( editor, output );
index = toolbarObj.items.push( itemObj ) - 1;
if ( index > 0 )
{
itemObj.previous = toolbarObj.items[ index - 1 ];
itemObj.previous.next = itemObj;
}
itemObj.toolbar = toolbarObj;
itemObj.onkey = itemKeystroke;
/*
* Fix for #3052:
* Prevent JAWS from focusing the toolbar after document load.
*/
itemObj.onfocus = function()
{
if ( !editor.toolbox.focusCommandExecuted )
editor.focus();
};
}
}
if ( groupStarted )
{
output.push( '</span>' );
groupStarted = 0;
}
output.push( '<span class="cke_toolbar_end"></span></span>' );
}
output.push( '</div>' );
if ( editor.config.toolbarCanCollapse )
{
var collapserFn = CKEDITOR.tools.addFunction(
function()
{
editor.execCommand( 'toolbarCollapse' );
} );
editor.on( 'destroy', function () {
CKEDITOR.tools.removeFunction( collapserFn );
} );
var collapserId = 'cke_' + CKEDITOR.tools.getNextNumber();
editor.addCommand( 'toolbarCollapse',
{
exec : function( editor )
{
var collapser = CKEDITOR.document.getById( collapserId );
var toolbox = collapser.getPrevious();
var contents = editor.getThemeSpace( 'contents' );
var toolboxContainer = toolbox.getParent();
var contentHeight = parseInt( contents.$.style.height, 10 );
var previousHeight = toolboxContainer.$.offsetHeight;
var collapsed = !toolbox.isVisible();
if ( !collapsed )
{
toolbox.hide();
collapser.addClass( 'cke_toolbox_collapser_min' );
collapser.setAttribute( 'title', editor.lang.toolbarExpand );
}
else
{
toolbox.show();
collapser.removeClass( 'cke_toolbox_collapser_min' );
collapser.setAttribute( 'title', editor.lang.toolbarCollapse );
}
// Update collapser symbol.
collapser.getFirst().setText( collapsed ?
'\u25B2' : // BLACK UP-POINTING TRIANGLE
'\u25C0' ); // BLACK LEFT-POINTING TRIANGLE
var dy = toolboxContainer.$.offsetHeight - previousHeight;
contents.setStyle( 'height', ( contentHeight - dy ) + 'px' );
editor.fire( 'resize' );
},
modes : { wysiwyg : 1, source : 1 }
} );
output.push( '<a title="' + ( expanded ? editor.lang.toolbarCollapse : editor.lang.toolbarExpand )
+ '" id="' + collapserId + '" tabIndex="-1" class="cke_toolbox_collapser' );
if ( !expanded )
output.push( ' cke_toolbox_collapser_min' );
output.push( '" onclick="CKEDITOR.tools.callFunction(' + collapserFn + ')">',
'<span>&#9650;</span>', // BLACK UP-POINTING TRIANGLE
'</a>' );
}
event.data.html += output.join( '' );
}
});
editor.addCommand( 'toolbarFocus', commands.toolbarFocus );
}
});
})();
/**
* The UI element that renders a toolbar separator.
* @type Object
* @example
*/
CKEDITOR.ui.separator =
{
render : function( editor, output )
{
output.push( '<span class="cke_separator" role="separator"></span>' );
return {};
}
};
/**
* The "theme space" to which rendering the toolbar. For the default theme,
* the recommended options are "top" and "bottom".
* @type String
* @default 'top'
* @see CKEDITOR.config.theme
* @example
* config.toolbarLocation = 'bottom';
*/
CKEDITOR.config.toolbarLocation = 'top';
/**
* The toolbar definition. It is an array of toolbars (strips),
* each one being also an array, containing a list of UI items.
* Note that this setting is composed by "toolbar_" added by the toolbar name,
* which in this case is called "Basic". This second part of the setting name
* can be anything. You must use this name in the
* {@link CKEDITOR.config.toolbar} setting, so you instruct the editor which
* toolbar_(name) setting to you.
* @type Array
* @example
* // Defines a toolbar with only one strip containing the "Source" button, a
* // separator and the "Bold" and "Italic" buttons.
* <b>config.toolbar_Basic =
* [
* [ 'Source', '-', 'Bold', 'Italic' ]
* ]</b>;
* config.toolbar = 'Basic';
*/
CKEDITOR.config.toolbar_Basic =
[
['Bold', 'Italic', '-', 'NumberedList', 'BulletedList', '-', 'Link', 'Unlink','-','About']
];
/**
* This is the default toolbar definition used by the editor. It contains all
* editor features.
* @type Array
* @default (see example)
* @example
* // This is actually the default value.
* config.toolbar_Full =
* [
* ['Source','-','Save','NewPage','Preview','-','Templates'],
* ['Cut','Copy','Paste','PasteText','PasteFromWord','-','Print', 'SpellChecker', 'Scayt'],
* ['Undo','Redo','-','Find','Replace','-','SelectAll','RemoveFormat'],
* ['Form', 'Checkbox', 'Radio', 'TextField', 'Textarea', 'Select', 'Button', 'ImageButton', 'HiddenField'],
* '/',
* ['Bold','Italic','Underline','Strike','-','Subscript','Superscript'],
* ['NumberedList','BulletedList','-','Outdent','Indent','Blockquote','CreateDiv'],
* ['JustifyLeft','JustifyCenter','JustifyRight','JustifyBlock'],
* ['Link','Unlink','Anchor'],
* ['Image','Flash','Table','HorizontalRule','Smiley','SpecialChar','PageBreak'],
* '/',
* ['Styles','Format','Font','FontSize'],
* ['TextColor','BGColor'],
* ['Maximize', 'ShowBlocks','-','About']
* ];
*/
CKEDITOR.config.toolbar_Full =
[
['Source','-','Save','NewPage','Preview','-','Templates'],
['Cut','Copy','Paste','PasteText','PasteFromWord','-','Print', 'SpellChecker', 'Scayt'],
['Undo','Redo','-','Find','Replace','-','SelectAll','RemoveFormat'],
['Form', 'Checkbox', 'Radio', 'TextField', 'Textarea', 'Select', 'Button', 'ImageButton', 'HiddenField'],
'/',
['Bold','Italic','Underline','Strike','-','Subscript','Superscript'],
['NumberedList','BulletedList','-','Outdent','Indent','Blockquote','CreateDiv'],
['JustifyLeft','JustifyCenter','JustifyRight','JustifyBlock'],
['Link','Unlink','Anchor'],
['Image','Flash','Table','HorizontalRule','Smiley','SpecialChar','PageBreak'],
'/',
['Styles','Format','Font','FontSize'],
['TextColor','BGColor'],
['Maximize', 'ShowBlocks','-','About']
];
/**
* The toolbox (alias toolbar) definition. It is a toolbar name or an array of
* toolbars (strips), each one being also an array, containing a list of UI items.
* @type Array|String
* @default 'Full'
* @example
* // Defines a toolbar with only one strip containing the "Source" button, a
* // separator and the "Bold" and "Italic" buttons.
* config.toolbar =
* [
* [ 'Source', '-', 'Bold', 'Italic' ]
* ];
* @example
* // Load toolbar_Name where Name = Basic.
* config.toolbar = 'Basic';
*/
CKEDITOR.config.toolbar = 'Full';
/**
* Whether the toolbar can be collapsed by the user. If disabled, the collapser
* button will not be displayed.
* @type Boolean
* @default true
* @example
* config.toolbarCanCollapse = false;
*/
CKEDITOR.config.toolbarCanCollapse = true;
/**
* Whether the toolbar must start expanded when the editor is loaded.
* @name CKEDITOR.config.toolbarStartupExpanded
* @type Boolean
* @default true
* @example
* config.toolbarStartupExpanded = false;
*/