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 "colorbutton" plugin that makes it possible to assign
8 * text and background colors to editor contents.
11 CKEDITOR.plugins.add( 'colorbutton',
13 requires : [ 'panelbutton', 'floatpanel', 'styles' ],
15 init : function( editor )
17 var config = editor.config,
18 lang = editor.lang.colorButton;
22 if ( !CKEDITOR.env.hc )
24 addButton( 'TextColor', 'fore', lang.textColorTitle );
25 addButton( 'BGColor', 'back', lang.bgColorTitle );
28 function addButton( name, type, title )
30 var colorBoxId = CKEDITOR.tools.getNextId() + '_colorBox';
31 editor.ui.add( name, CKEDITOR.UI_PANELBUTTON,
35 className : 'cke_button_' + name.toLowerCase(),
36 modes : { wysiwyg : 1 },
40 css : editor.skin.editor.css,
41 attributes : { role : 'listbox', 'aria-label' : lang.panelTitle }
44 onBlock : function( panel, block )
46 block.autoSize = true;
47 block.element.addClass( 'cke_colorblock' );
48 block.element.setHtml( renderColors( panel, type, colorBoxId ) );
49 // The block should not have scrollbars (#5933, #6056)
50 block.element.getDocument().getBody().setStyle( 'overflow', 'hidden' );
52 CKEDITOR.ui.fire( 'ready', this );
54 var keys = block.keys;
55 var rtl = editor.lang.dir == 'rtl';
56 keys[ rtl ? 37 : 39 ] = 'next'; // ARROW-RIGHT
57 keys[ 40 ] = 'next'; // ARROW-DOWN
58 keys[ 9 ] = 'next'; // TAB
59 keys[ rtl ? 39 : 37 ] = 'prev'; // ARROW-LEFT
60 keys[ 38 ] = 'prev'; // ARROW-UP
61 keys[ CKEDITOR.SHIFT + 9 ] = 'prev'; // SHIFT + TAB
62 keys[ 32 ] = 'click'; // SPACE
65 // The automatic colorbox should represent the real color (#6010)
68 var selection = editor.getSelection(),
69 block = selection && selection.getStartElement(),
70 path = new CKEDITOR.dom.elementPath( block ),
73 // Find the closest block element.
74 block = path.block || path.blockLimit || editor.document.getBody();
76 // The background color might be transparent. In that case, look up the color in the DOM tree.
79 color = block && block.getComputedStyle( type == 'back' ? 'background-color' : 'color' ) || 'transparent';
81 while ( type == 'back' && color == 'transparent' && block && ( block = block.getParent() ) );
83 // The box should never be transparent.
84 if ( !color || color == 'transparent' )
87 this._.panel._.iframe.getFrameDocument().getById( colorBoxId ).setStyle( 'background-color', color );
93 function renderColors( panel, type, colorBoxId )
96 colors = config.colorButton_colors.split( ',' ),
97 total = colors.length + ( config.colorButton_enableMore ? 2 : 1 );
99 var clickFn = CKEDITOR.tools.addFunction( function( color, type )
103 var applyColorStyle = arguments.callee;
104 function onColorDialogClose( evt )
106 this.removeListener( 'ok', onColorDialogClose );
107 this.removeListener( 'cancel', onColorDialogClose );
109 evt.name == 'ok' && applyColorStyle( this.getContentElement( 'picker', 'selectedColor' ).getValue(), type );
112 editor.openDialog( 'colordialog', function()
114 this.on( 'ok', onColorDialogClose );
115 this.on( 'cancel', onColorDialogClose );
125 editor.fire( 'saveSnapshot' );
127 // Clean up any conflicting style within the range.
128 new CKEDITOR.style( config['colorButton_' + type + 'Style'], { color : 'inherit' } ).remove( editor.document );
132 var colorStyle = config['colorButton_' + type + 'Style'];
134 colorStyle.childRule = type == 'back' ?
137 // It's better to apply background color as the innermost style. (#3599)
138 // Except for "unstylable elements". (#6103)
139 return isUnstylable( element );
144 // Fore color style must be applied inside links instead of around it. (#4772,#6908)
145 return !( element.is( 'a' ) || element.getElementsByTag( 'a' ).count() ) || isUnstylable( element );
148 new CKEDITOR.style( colorStyle, { color : color } ).apply( editor.document );
151 editor.fire( 'saveSnapshot' );
154 // Render the "Automatic" button.
156 '<a class="cke_colorauto" _cke_focus=1 hidefocus=true' +
157 ' title="', lang.auto, '"' +
158 ' onclick="CKEDITOR.tools.callFunction(', clickFn, ',null,\'', type, '\');return false;"' +
159 ' href="javascript:void(\'', lang.auto, '\')"' +
160 ' role="option" aria-posinset="1" aria-setsize="', total, '">' +
161 '<table role="presentation" cellspacing=0 cellpadding=0 width="100%">' +
164 '<span class="cke_colorbox" id="', colorBoxId, '"></span>' +
166 '<td colspan=7 align=center>',
172 '<table role="presentation" cellspacing=0 cellpadding=0 width="100%">' );
174 // Render the color boxes.
175 for ( var i = 0 ; i < colors.length ; i++ )
177 if ( ( i % 8 ) === 0 )
178 output.push( '</tr><tr>' );
180 var parts = colors[ i ].split( '/' ),
181 colorName = parts[ 0 ],
182 colorCode = parts[ 1 ] || colorName;
184 // The data can be only a color code (without #) or colorName + color code
185 // If only a color code is provided, then the colorName is the color with the hash
186 // Convert the color from RGB to RRGGBB for better compatibility with IE and <font>. See #5676
188 colorName = '#' + colorName.replace( /^(.)(.)(.)$/, '$1$1$2$2$3$3' );
190 var colorLabel = editor.lang.colors[ colorCode ] || colorCode;
193 '<a class="cke_colorbox" _cke_focus=1 hidefocus=true' +
194 ' title="', colorLabel, '"' +
195 ' onclick="CKEDITOR.tools.callFunction(', clickFn, ',\'', colorName, '\',\'', type, '\'); return false;"' +
196 ' href="javascript:void(\'', colorLabel, '\')"' +
197 ' role="option" aria-posinset="', ( i + 2 ), '" aria-setsize="', total, '">' +
198 '<span class="cke_colorbox" style="background-color:#', colorCode, '"></span>' +
203 // Render the "More Colors" button.
204 if ( config.colorButton_enableMore === undefined || config.colorButton_enableMore )
209 '<td colspan=8 align=center>' +
210 '<a class="cke_colormore" _cke_focus=1 hidefocus=true' +
211 ' title="', lang.more, '"' +
212 ' onclick="CKEDITOR.tools.callFunction(', clickFn, ',\'?\',\'', type, '\');return false;"' +
213 ' href="javascript:void(\'', lang.more, '\')"',
214 ' role="option" aria-posinset="', total, '" aria-setsize="', total, '">',
217 '</td>' ); // tr is later in the code.
220 output.push( '</tr></table>' );
222 return output.join( '' );
225 function isUnstylable( ele )
227 return ( ele.getAttribute( 'contentEditable' ) == 'false' ) || ele.getAttribute( 'data-nostyle' );
233 * Whether to enable the <strong>More Colors</strong> button in the color selectors.
234 * @name CKEDITOR.config.colorButton_enableMore
235 * @default <code>true</code>
238 * config.colorButton_enableMore = false;
242 * Defines the colors to be displayed in the color selectors. This is a string
243 * containing hexadecimal notation for HTML colors, without the "#" prefix.
245 * Since 3.3: A color name may optionally be defined by prefixing the entries with
246 * a name and the slash character. For example, "FontColor1/FF9900" will be
247 * displayed as the color #FF9900 in the selector, but will be output as "FontColor1".
248 * @name CKEDITOR.config.colorButton_colors
250 * @default <code>'000,800000,8B4513,2F4F4F,008080,000080,4B0082,696969,B22222,A52A2A,DAA520,006400,40E0D0,0000CD,800080,808080,F00,FF8C00,FFD700,008000,0FF,00F,EE82EE,A9A9A9,FFA07A,FFA500,FFFF00,00FF00,AFEEEE,ADD8E6,DDA0DD,D3D3D3,FFF0F5,FAEBD7,FFFFE0,F0FFF0,F0FFFF,F0F8FF,E6E6FA,FFF'</code>
252 * // Brazil colors only.
253 * config.colorButton_colors = '00923E,F8C100,28166F';
255 * config.colorButton_colors = 'FontColor1/FF9900,FontColor2/0066CC,FontColor3/F00'
257 CKEDITOR.config.colorButton_colors =
258 '000,800000,8B4513,2F4F4F,008080,000080,4B0082,696969,' +
259 'B22222,A52A2A,DAA520,006400,40E0D0,0000CD,800080,808080,' +
260 'F00,FF8C00,FFD700,008000,0FF,00F,EE82EE,A9A9A9,' +
261 'FFA07A,FFA500,FFFF00,00FF00,AFEEEE,ADD8E6,DDA0DD,D3D3D3,' +
262 'FFF0F5,FAEBD7,FFFFE0,F0FFF0,F0FFFF,F0F8FF,E6E6FA,FFF';
265 * Stores the style definition that applies the text foreground color.
266 * @name CKEDITOR.config.colorButton_foreStyle
268 * @default (see example)
270 * // This is actually the default value.
271 * config.colorButton_foreStyle =
274 * styles : { 'color' : '#(color)' }
277 CKEDITOR.config.colorButton_foreStyle =
280 styles : { 'color' : '#(color)' },
281 overrides : [ { element : 'font', attributes : { 'color' : null } } ]
285 * Stores the style definition that applies the text background color.
286 * @name CKEDITOR.config.colorButton_backStyle
288 * @default (see example)
290 * // This is actually the default value.
291 * config.colorButton_backStyle =
294 * styles : { 'background-color' : '#(color)' }
297 CKEDITOR.config.colorButton_backStyle =
300 styles : { 'background-color' : '#(color)' }