2 Copyright (c) 2003-2012, CKSource - Frederico Knabben. All rights reserved.
\r
3 For licensing, see LICENSE.html or http://ckeditor.com/license
\r
7 * @fileOverview The "colorbutton" plugin that makes it possible to assign
\r
8 * text and background colors to editor contents.
\r
11 CKEDITOR.plugins.add( 'colorbutton',
\r
13 requires : [ 'panelbutton', 'floatpanel', 'styles' ],
\r
15 init : function( editor )
\r
17 var config = editor.config,
\r
18 lang = editor.lang.colorButton;
\r
22 if ( !CKEDITOR.env.hc )
\r
24 addButton( 'TextColor', 'fore', lang.textColorTitle );
\r
25 addButton( 'BGColor', 'back', lang.bgColorTitle );
\r
28 function addButton( name, type, title )
\r
30 var colorBoxId = CKEDITOR.tools.getNextId() + '_colorBox';
\r
31 editor.ui.add( name, CKEDITOR.UI_PANELBUTTON,
\r
35 className : 'cke_button_' + name.toLowerCase(),
\r
36 modes : { wysiwyg : 1 },
\r
40 css : editor.skin.editor.css,
\r
41 attributes : { role : 'listbox', 'aria-label' : lang.panelTitle }
\r
44 onBlock : function( panel, block )
\r
46 block.autoSize = true;
\r
47 block.element.addClass( 'cke_colorblock' );
\r
48 block.element.setHtml( renderColors( panel, type, colorBoxId ) );
\r
49 // The block should not have scrollbars (#5933, #6056)
\r
50 block.element.getDocument().getBody().setStyle( 'overflow', 'hidden' );
\r
52 CKEDITOR.ui.fire( 'ready', this );
\r
54 var keys = block.keys;
\r
55 var rtl = editor.lang.dir == 'rtl';
\r
56 keys[ rtl ? 37 : 39 ] = 'next'; // ARROW-RIGHT
\r
57 keys[ 40 ] = 'next'; // ARROW-DOWN
\r
58 keys[ 9 ] = 'next'; // TAB
\r
59 keys[ rtl ? 39 : 37 ] = 'prev'; // ARROW-LEFT
\r
60 keys[ 38 ] = 'prev'; // ARROW-UP
\r
61 keys[ CKEDITOR.SHIFT + 9 ] = 'prev'; // SHIFT + TAB
\r
62 keys[ 32 ] = 'click'; // SPACE
\r
65 // The automatic colorbox should represent the real color (#6010)
\r
68 var selection = editor.getSelection(),
\r
69 block = selection && selection.getStartElement(),
\r
70 path = new CKEDITOR.dom.elementPath( block ),
\r
73 // Find the closest block element.
\r
74 block = path.block || path.blockLimit || editor.document.getBody();
\r
76 // The background color might be transparent. In that case, look up the color in the DOM tree.
\r
79 color = block && block.getComputedStyle( type == 'back' ? 'background-color' : 'color' ) || 'transparent';
\r
81 while ( type == 'back' && color == 'transparent' && block && ( block = block.getParent() ) );
\r
83 // The box should never be transparent.
\r
84 if ( !color || color == 'transparent' )
\r
87 this._.panel._.iframe.getFrameDocument().getById( colorBoxId ).setStyle( 'background-color', color );
\r
93 function renderColors( panel, type, colorBoxId )
\r
96 colors = config.colorButton_colors.split( ',' );
\r
98 var clickFn = CKEDITOR.tools.addFunction( function( color, type )
\r
100 if ( color == '?' )
\r
102 var applyColorStyle = arguments.callee;
\r
103 function onColorDialogClose( evt )
\r
105 this.removeListener( 'ok', onColorDialogClose );
\r
106 this.removeListener( 'cancel', onColorDialogClose );
\r
108 evt.name == 'ok' && applyColorStyle( this.getContentElement( 'picker', 'selectedColor' ).getValue(), type );
\r
111 editor.openDialog( 'colordialog', function()
\r
113 this.on( 'ok', onColorDialogClose );
\r
114 this.on( 'cancel', onColorDialogClose );
\r
122 panel.hide( false );
\r
124 editor.fire( 'saveSnapshot' );
\r
126 // Clean up any conflicting style within the range.
\r
127 new CKEDITOR.style( config['colorButton_' + type + 'Style'], { color : 'inherit' } ).remove( editor.document );
\r
131 var colorStyle = config['colorButton_' + type + 'Style'];
\r
133 colorStyle.childRule = type == 'back' ?
\r
134 function( element )
\r
136 // It's better to apply background color as the innermost style. (#3599)
\r
137 // Except for "unstylable elements". (#6103)
\r
138 return isUnstylable( element );
\r
141 function( element )
\r
143 // Fore color style must be applied inside links instead of around it. (#4772,#6908)
\r
144 return !( element.is( 'a' ) || element.getElementsByTag( 'a' ).count() ) || isUnstylable( element );
\r
147 new CKEDITOR.style( colorStyle, { color : color } ).apply( editor.document );
\r
150 editor.fire( 'saveSnapshot' );
\r
153 // Render the "Automatic" button.
\r
155 '<a class="cke_colorauto" _cke_focus=1 hidefocus=true' +
\r
156 ' title="', lang.auto, '"' +
\r
157 ' onclick="CKEDITOR.tools.callFunction(', clickFn, ',null,\'', type, '\');return false;"' +
\r
158 ' href="javascript:void(\'', lang.auto, '\')"' +
\r
159 ' role="option">' +
\r
160 '<table role="presentation" cellspacing=0 cellpadding=0 width="100%">' +
\r
163 '<span class="cke_colorbox" id="', colorBoxId, '"></span>' +
\r
165 '<td colspan=7 align=center>',
\r
171 '<table role="presentation" cellspacing=0 cellpadding=0 width="100%">' );
\r
173 // Render the color boxes.
\r
174 for ( var i = 0 ; i < colors.length ; i++ )
\r
176 if ( ( i % 8 ) === 0 )
\r
177 output.push( '</tr><tr>' );
\r
179 var parts = colors[ i ].split( '/' ),
\r
180 colorName = parts[ 0 ],
\r
181 colorCode = parts[ 1 ] || colorName;
\r
183 // The data can be only a color code (without #) or colorName + color code
\r
184 // If only a color code is provided, then the colorName is the color with the hash
\r
185 // Convert the color from RGB to RRGGBB for better compatibility with IE and <font>. See #5676
\r
187 colorName = '#' + colorName.replace( /^(.)(.)(.)$/, '$1$1$2$2$3$3' );
\r
189 var colorLabel = editor.lang.colors[ colorCode ] || colorCode;
\r
192 '<a class="cke_colorbox" _cke_focus=1 hidefocus=true' +
\r
193 ' title="', colorLabel, '"' +
\r
194 ' onclick="CKEDITOR.tools.callFunction(', clickFn, ',\'', colorName, '\',\'', type, '\'); return false;"' +
\r
195 ' href="javascript:void(\'', colorLabel, '\')"' +
\r
196 ' role="option">' +
\r
197 '<span class="cke_colorbox" style="background-color:#', colorCode, '"></span>' +
\r
202 // Render the "More Colors" button.
\r
203 if ( config.colorButton_enableMore === undefined || config.colorButton_enableMore )
\r
208 '<td colspan=8 align=center>' +
\r
209 '<a class="cke_colormore" _cke_focus=1 hidefocus=true' +
\r
210 ' title="', lang.more, '"' +
\r
211 ' onclick="CKEDITOR.tools.callFunction(', clickFn, ',\'?\',\'', type, '\');return false;"' +
\r
212 ' href="javascript:void(\'', lang.more, '\')"',
\r
216 '</td>' ); // tr is later in the code.
\r
219 output.push( '</tr></table>' );
\r
221 return output.join( '' );
\r
224 function isUnstylable( ele )
\r
226 return ( ele.getAttribute( 'contentEditable' ) == 'false' ) || ele.getAttribute( 'data-nostyle' );
\r
232 * Whether to enable the <strong>More Colors</strong> button in the color selectors.
\r
233 * @name CKEDITOR.config.colorButton_enableMore
\r
234 * @default <code>true</code>
\r
237 * config.colorButton_enableMore = false;
\r
241 * Defines the colors to be displayed in the color selectors. This is a string
\r
242 * containing hexadecimal notation for HTML colors, without the "#" prefix.
\r
244 * Since 3.3: A color name may optionally be defined by prefixing the entries with
\r
245 * a name and the slash character. For example, "FontColor1/FF9900" will be
\r
246 * displayed as the color #FF9900 in the selector, but will be output as "FontColor1".
\r
247 * @name CKEDITOR.config.colorButton_colors
\r
249 * @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>
\r
251 * // Brazil colors only.
\r
252 * config.colorButton_colors = '00923E,F8C100,28166F';
\r
254 * config.colorButton_colors = 'FontColor1/FF9900,FontColor2/0066CC,FontColor3/F00'
\r
256 CKEDITOR.config.colorButton_colors =
\r
257 '000,800000,8B4513,2F4F4F,008080,000080,4B0082,696969,' +
\r
258 'B22222,A52A2A,DAA520,006400,40E0D0,0000CD,800080,808080,' +
\r
259 'F00,FF8C00,FFD700,008000,0FF,00F,EE82EE,A9A9A9,' +
\r
260 'FFA07A,FFA500,FFFF00,00FF00,AFEEEE,ADD8E6,DDA0DD,D3D3D3,' +
\r
261 'FFF0F5,FAEBD7,FFFFE0,F0FFF0,F0FFFF,F0F8FF,E6E6FA,FFF';
\r
264 * Stores the style definition that applies the text foreground color.
\r
265 * @name CKEDITOR.config.colorButton_foreStyle
\r
267 * @default (see example)
\r
269 * // This is actually the default value.
\r
270 * config.colorButton_foreStyle =
\r
272 * element : 'span',
\r
273 * styles : { 'color' : '#(color)' }
\r
276 CKEDITOR.config.colorButton_foreStyle =
\r
279 styles : { 'color' : '#(color)' },
\r
280 overrides : [ { element : 'font', attributes : { 'color' : null } } ]
\r
284 * Stores the style definition that applies the text background color.
\r
285 * @name CKEDITOR.config.colorButton_backStyle
\r
287 * @default (see example)
\r
289 * // This is actually the default value.
\r
290 * config.colorButton_backStyle =
\r
292 * element : 'span',
\r
293 * styles : { 'background-color' : '#(color)' }
\r
296 CKEDITOR.config.colorButton_backStyle =
\r
299 styles : { 'background-color' : '#(color)' }
\r