JasonWoof Got questions, comments, patches, etc.? Contact Jason Woofenden
vanilla ckeditor-3.6.1
[ckeditor.git] / _source / plugins / colorbutton / plugin.js
index 747716e..b3e5d9c 100644 (file)
@@ -1,5 +1,5 @@
 /*\r
-Copyright (c) 2003-2009, CKSource - Frederico Knabben. All rights reserved.\r
+Copyright (c) 2003-2011, CKSource - Frederico Knabben. All rights reserved.\r
 For licensing, see LICENSE.html or http://ckeditor.com/license\r
 */\r
 \r
@@ -22,6 +22,7 @@ CKEDITOR.plugins.add( 'colorbutton',
 \r
                function addButton( name, type, title )\r
                {\r
+                       var colorBoxId = CKEDITOR.tools.getNextId() + '_colorBox';\r
                        editor.ui.add( name, CKEDITOR.UI_PANELBUTTON,\r
                                {\r
                                        label : title,\r
@@ -31,52 +32,117 @@ CKEDITOR.plugins.add( 'colorbutton',
 \r
                                        panel :\r
                                        {\r
-                                               css : [ CKEDITOR.getUrl( editor.skinPath + 'editor.css' ) ]\r
+                                               css : editor.skin.editor.css,\r
+                                               attributes : { role : 'listbox', 'aria-label' : lang.panelTitle }\r
                                        },\r
 \r
-                                       onBlock : function( panel, blockName )\r
+                                       onBlock : function( panel, block )\r
                                        {\r
-                                               var block = panel.addBlock( blockName );\r
                                                block.autoSize = true;\r
                                                block.element.addClass( 'cke_colorblock' );\r
-                                               block.element.setHtml( renderColors( panel, type ) );\r
+                                               block.element.setHtml( renderColors( panel, type, colorBoxId ) );\r
+                                               // The block should not have scrollbars (#5933, #6056)\r
+                                               block.element.getDocument().getBody().setStyle( 'overflow', 'hidden' );\r
+\r
+                                               CKEDITOR.ui.fire( 'ready', this );\r
 \r
                                                var keys = block.keys;\r
-                                               keys[ 39 ]      = 'next';                                       // ARROW-RIGHT\r
+                                               var rtl = editor.lang.dir == 'rtl';\r
+                                               keys[ rtl ? 37 : 39 ]   = 'next';                                       // ARROW-RIGHT\r
+                                               keys[ 40 ]      = 'next';                                       // ARROW-DOWN\r
                                                keys[ 9 ]       = 'next';                                       // TAB\r
-                                               keys[ 37 ]      = 'prev';                                       // ARROW-LEFT\r
+                                               keys[ rtl ? 39 : 37 ]   = 'prev';                                       // ARROW-LEFT\r
+                                               keys[ 38 ]      = 'prev';                                       // ARROW-UP\r
                                                keys[ CKEDITOR.SHIFT + 9 ]      = 'prev';       // SHIFT + TAB\r
                                                keys[ 32 ]      = 'click';                                      // SPACE\r
+                                       },\r
+\r
+                                       // The automatic colorbox should represent the real color (#6010)\r
+                                       onOpen : function()\r
+                                       {\r
+                                               var selection = editor.getSelection(),\r
+                                                       block = selection && selection.getStartElement(),\r
+                                                       path = new CKEDITOR.dom.elementPath( block ),\r
+                                                       color;\r
+\r
+                                               // Find the closest block element.\r
+                                               block = path.block || path.blockLimit || editor.document.getBody();\r
+\r
+                                               // The background color might be transparent. In that case, look up the color in the DOM tree.\r
+                                               do\r
+                                               {\r
+                                                       color = block && block.getComputedStyle( type == 'back' ? 'background-color' : 'color' ) || 'transparent';\r
+                                               }\r
+                                               while ( type == 'back' && color == 'transparent' && block && ( block = block.getParent() ) );\r
+\r
+                                               // The box should never be transparent.\r
+                                               if ( !color || color == 'transparent' )\r
+                                                       color = '#ffffff';\r
+\r
+                                               this._.panel._.iframe.getFrameDocument().getById( colorBoxId ).setStyle( 'background-color', color );\r
                                        }\r
                                });\r
                }\r
 \r
 \r
-               function renderColors( panel, type )\r
+               function renderColors( panel, type, colorBoxId )\r
                {\r
                        var output = [],\r
-                               colors = config.colorButton_colors.split( ',' );\r
+                               colors = config.colorButton_colors.split( ',' ),\r
+                               total = colors.length + ( config.colorButton_enableMore ? 2 : 1 );\r
 \r
                        var clickFn = CKEDITOR.tools.addFunction( function( color, type )\r
                                {\r
                                        if ( color == '?' )\r
                                        {\r
-                                               // TODO : Implement the colors dialog.\r
-                                               // editor.openDialog( '' );\r
+                                               var applyColorStyle = arguments.callee;\r
+                                               function onColorDialogClose( evt )\r
+                                               {\r
+                                                       this.removeListener( 'ok', onColorDialogClose );\r
+                                                       this.removeListener( 'cancel', onColorDialogClose );\r
+\r
+                                                       evt.name == 'ok' && applyColorStyle( this.getContentElement( 'picker', 'selectedColor' ).getValue(), type );\r
+                                               }\r
+\r
+                                               editor.openDialog( 'colordialog', function()\r
+                                               {\r
+                                                       this.on( 'ok', onColorDialogClose );\r
+                                                       this.on( 'cancel', onColorDialogClose );\r
+                                               } );\r
+\r
                                                return;\r
                                        }\r
 \r
                                        editor.focus();\r
 \r
-                                       panel.hide();\r
-\r
-                                       var style = new CKEDITOR.style( config['colorButton_' + type + 'Style'], color && { color : color } );\r
+                                       panel.hide( false );\r
 \r
                                        editor.fire( 'saveSnapshot' );\r
+\r
+                                       // Clean up any conflicting style within the range.\r
+                                       new CKEDITOR.style( config['colorButton_' + type + 'Style'], { color : 'inherit' } ).remove( editor.document );\r
+\r
                                        if ( color )\r
-                                               style.apply( editor.document );\r
-                                       else\r
-                                               style.remove( editor.document );\r
+                                       {\r
+                                               var colorStyle = config['colorButton_' + type + 'Style'];\r
+\r
+                                               colorStyle.childRule = type == 'back' ?\r
+                                                       function( element )\r
+                                                       {\r
+                                                               // It's better to apply background color as the innermost style. (#3599)\r
+                                                               // Except for "unstylable elements". (#6103)\r
+                                                               return isUnstylable( element );\r
+                                                       }\r
+                                                       :\r
+                                                       function( element )\r
+                                                       {\r
+                                                               // Fore color style must be applied inside links instead of around it.\r
+                                                               return element.getName() != 'a' || isUnstylable( element );\r
+                                                       };\r
+\r
+                                               new CKEDITOR.style( colorStyle, { color : color } ).apply( editor.document );\r
+                                       }\r
+\r
                                        editor.fire( 'saveSnapshot' );\r
                                });\r
 \r
@@ -85,11 +151,12 @@ CKEDITOR.plugins.add( 'colorbutton',
                                '<a class="cke_colorauto" _cke_focus=1 hidefocus=true' +\r
                                        ' title="', lang.auto, '"' +\r
                                        ' onclick="CKEDITOR.tools.callFunction(', clickFn, ',null,\'', type, '\');return false;"' +\r
-                                       ' href="javascript:void(\'', lang.auto, '\')">' +\r
-                                       '<table cellspacing=0 cellpadding=0 width="100%">' +\r
+                                       ' href="javascript:void(\'', lang.auto, '\')"' +\r
+                                       ' role="option" aria-posinset="1" aria-setsize="', total, '">' +\r
+                                       '<table role="presentation" cellspacing=0 cellpadding=0 width="100%">' +\r
                                                '<tr>' +\r
                                                        '<td>' +\r
-                                                               '<span class="cke_colorbox" style="background-color:#000"></span>' +\r
+                                                               '<span class="cke_colorbox" id="', colorBoxId, '"></span>' +\r
                                                        '</td>' +\r
                                                        '<td colspan=7 align=center>',\r
                                                                lang.auto,\r
@@ -97,7 +164,7 @@ CKEDITOR.plugins.add( 'colorbutton',
                                                '</tr>' +\r
                                        '</table>' +\r
                                '</a>' +\r
-                               '<table cellspacing=0 cellpadding=0 width="100%">' );\r
+                               '<table role="presentation" cellspacing=0 cellpadding=0 width="100%">' );\r
 \r
                        // Render the color boxes.\r
                        for ( var i = 0 ; i < colors.length ; i++ )\r
@@ -105,21 +172,31 @@ CKEDITOR.plugins.add( 'colorbutton',
                                if ( ( i % 8 ) === 0 )\r
                                        output.push( '</tr><tr>' );\r
 \r
-                               var colorCode = colors[ i ];\r
+                               var parts = colors[ i ].split( '/' ),\r
+                                       colorName = parts[ 0 ],\r
+                                       colorCode = parts[ 1 ] || colorName;\r
+\r
+                               // The data can be only a color code (without #) or colorName + color code\r
+                               // If only a color code is provided, then the colorName is the color with the hash\r
+                               // Convert the color from RGB to RRGGBB for better compatibility with IE and <font>. See #5676\r
+                               if (!parts[1])\r
+                                       colorName = '#' + colorName.replace( /^(.)(.)(.)$/, '$1$1$2$2$3$3' );\r
+\r
                                var colorLabel = editor.lang.colors[ colorCode ] || colorCode;\r
                                output.push(\r
                                        '<td>' +\r
                                                '<a class="cke_colorbox" _cke_focus=1 hidefocus=true' +\r
                                                        ' title="', colorLabel, '"' +\r
-                                                       ' onclick="CKEDITOR.tools.callFunction(', clickFn, ',\'#', colorCode, '\',\'', type, '\'); return false;"' +\r
-                                                       ' href="javascript:void(\'', colorLabel, '\')">' +\r
+                                                       ' onclick="CKEDITOR.tools.callFunction(', clickFn, ',\'', colorName, '\',\'', type, '\'); return false;"' +\r
+                                                       ' href="javascript:void(\'', colorLabel, '\')"' +\r
+                                                       ' role="option" aria-posinset="', ( i + 2 ), '" aria-setsize="', total, '">' +\r
                                                        '<span class="cke_colorbox" style="background-color:#', colorCode, '"></span>' +\r
                                                '</a>' +\r
                                        '</td>' );\r
                        }\r
 \r
                        // Render the "More Colors" button.\r
-                       if ( config.colorButton_enableMore )\r
+                       if ( config.colorButton_enableMore === undefined || config.colorButton_enableMore )\r
                        {\r
                                output.push(\r
                                        '</tr>' +\r
@@ -128,36 +205,49 @@ CKEDITOR.plugins.add( 'colorbutton',
                                                        '<a class="cke_colormore" _cke_focus=1 hidefocus=true' +\r
                                                                ' title="', lang.more, '"' +\r
                                                                ' onclick="CKEDITOR.tools.callFunction(', clickFn, ',\'?\',\'', type, '\');return false;"' +\r
-                                                               ' href="javascript:void(\'', lang.more, '\')">',\r
+                                                               ' href="javascript:void(\'', lang.more, '\')"',\r
+                                                               ' role="option" aria-posinset="', total, '" aria-setsize="', total, '">',\r
                                                                lang.more,\r
                                                        '</a>' +\r
-                                               '</td>' );      // It is later in the code.\r
+                                               '</td>' );      // tr is later in the code.\r
                        }\r
 \r
                        output.push( '</tr></table>' );\r
 \r
                        return output.join( '' );\r
                }\r
+\r
+               function isUnstylable( ele )\r
+               {\r
+                       return ( ele.getAttribute( 'contentEditable' ) == 'false' ) || ele.getAttribute( 'data-nostyle' );\r
+               }\r
        }\r
 });\r
 \r
 /**\r
  * Whether to enable the "More Colors..." button in the color selectors.\r
- * @default false\r
+ * @name CKEDITOR.config.colorButton_enableMore\r
+ * @default true\r
  * @type Boolean\r
  * @example\r
  * config.colorButton_enableMore = false;\r
  */\r
-CKEDITOR.config.colorButton_enableMore = false;\r
 \r
 /**\r
  * Defines the colors to be displayed in the color selectors. It's a string\r
  * containing the hexadecimal notation for HTML colors, without the "#" prefix.\r
+ *\r
+ * Since 3.3: A name may be optionally defined by prefixing the entries with the\r
+ * name and the slash character. For example, "FontColor1/FF9900" will be\r
+ * displayed as the color #FF9900 in the selector, but will be outputted as "FontColor1".\r
+ * @name CKEDITOR.config.colorButton_colors\r
  * @type String\r
  * @default '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'\r
  * @example\r
  * // Brazil colors only.\r
  * config.colorButton_colors = '00923E,F8C100,28166F';\r
+ * @example\r
+ * config.colorButton_colors = 'FontColor1/FF9900,FontColor2/0066CC,FontColor3/F00'\r
  */\r
 CKEDITOR.config.colorButton_colors =\r
        '000,800000,8B4513,2F4F4F,008080,000080,4B0082,696969,' +\r
@@ -168,6 +258,7 @@ CKEDITOR.config.colorButton_colors =
 \r
 /**\r
  * Holds the style definition to be used to apply the text foreground color.\r
+ * @name CKEDITOR.config.colorButton_foreStyle\r
  * @type Object\r
  * @example\r
  * // This is basically the default setting value.\r
@@ -186,6 +277,7 @@ CKEDITOR.config.colorButton_foreStyle =
 \r
 /**\r
  * Holds the style definition to be used to apply the text background color.\r
+ * @name CKEDITOR.config.colorButton_backStyle\r
  * @type Object\r
  * @example\r
  * // This is basically the default setting value.\r