JasonWoof Got questions, comments, patches, etc.? Contact Jason Woofenden
vanilla ckeditor-3.4.3
[ckeditor.git] / _source / themes / default / theme.js
index b3057d0..669aeb3 100644 (file)
@@ -1,11 +1,76 @@
 /*\r
-Copyright (c) 2003-2009, CKSource - Frederico Knabben. All rights reserved.\r
+Copyright (c) 2003-2010, CKSource - Frederico Knabben. All rights reserved.\r
 For licensing, see LICENSE.html or http://ckeditor.com/license\r
 */\r
 \r
+/**\r
+ * @name CKEDITOR.theme\r
+ * @class\r
+ */\r
+\r
 CKEDITOR.themes.add( 'default', (function()\r
 {\r
-       return {\r
+       function checkSharedSpace( editor, spaceName )\r
+       {\r
+               var container,\r
+                       element;\r
+\r
+               // Try to retrieve the target element from the sharedSpaces settings.\r
+               element = editor.config.sharedSpaces;\r
+               element = element && element[ spaceName ];\r
+               element = element && CKEDITOR.document.getById( element );\r
+\r
+               // If the element is available, we'll then create the container for\r
+               // the space.\r
+               if ( element )\r
+               {\r
+                       // Creates an HTML structure that reproduces the editor class hierarchy.\r
+                       var html =\r
+                               '<span class="cke_shared">' +\r
+                               '<span class="' + editor.skinClass + ' ' + editor.id + ' cke_editor_' + editor.name + '">' +\r
+                               '<span class="' + CKEDITOR.env.cssClass + '">' +\r
+                               '<span class="cke_wrapper cke_' + editor.lang.dir + '">' +\r
+                               '<span class="cke_editor">' +\r
+                               '<div class="cke_' + spaceName + '">' +\r
+                               '</div></span></span></span></span></span>';\r
+\r
+                       var mainContainer = element.append( CKEDITOR.dom.element.createFromHtml( html, element.getDocument() ) );\r
+\r
+                       // Only the first container starts visible. Others get hidden.\r
+                       if ( element.getCustomData( 'cke_hasshared' ) )\r
+                               mainContainer.hide();\r
+                       else\r
+                               element.setCustomData( 'cke_hasshared', 1 );\r
+\r
+                       // Get the deeper inner <div>.\r
+                       container = mainContainer.getChild( [0,0,0,0] );\r
+\r
+                       // When the editor gets focus, we show the space container, hiding others.\r
+                       editor.on( 'focus', function()\r
+                               {\r
+                                       for ( var i = 0, sibling, children = element.getChildren() ; ( sibling = children.getItem( i ) ) ; i++ )\r
+                                       {\r
+                                               if ( sibling.type == CKEDITOR.NODE_ELEMENT\r
+                                                       && !sibling.equals( mainContainer )\r
+                                                       && sibling.hasClass( 'cke_shared' ) )\r
+                                               {\r
+                                                       sibling.hide();\r
+                                               }\r
+                                       }\r
+\r
+                                       mainContainer.show();\r
+                               });\r
+\r
+                       editor.on( 'destroy', function()\r
+                               {\r
+                                       mainContainer.remove();\r
+                               });\r
+               }\r
+\r
+               return container;\r
+       }\r
+\r
+       return /** @lends CKEDITOR.theme */ {\r
                build : function( editor, themePath )\r
                {\r
                        var name = editor.name,\r
@@ -44,23 +109,31 @@ CKEDITOR.themes.add( 'default', (function()
                                style += "width: " + width + ";";\r
                        }\r
 \r
+                       var sharedTop           = topHtml && checkSharedSpace( editor, 'top' ),\r
+                               sharedBottoms   = checkSharedSpace( editor, 'bottom' );\r
+\r
+                       sharedTop               && ( sharedTop.setHtml( topHtml )               , topHtml = '' );\r
+                       sharedBottoms   && ( sharedBottoms.setHtml( bottomHtml ), bottomHtml = '' );\r
+\r
                        var container = CKEDITOR.dom.element.createFromHtml( [\r
                                '<span' +\r
                                        ' id="cke_', name, '"' +\r
-                                       ' onmousedown="return false;"' +\r
-                                       ' class="', editor.skinClass, '"' +\r
+                                       ' class="', editor.skinClass, ' ', editor.id, ' cke_editor_', name, '"' +\r
                                        ' dir="', editor.lang.dir, '"' +\r
                                        ' title="', ( CKEDITOR.env.gecko ? ' ' : '' ), '"' +\r
                                        ' lang="', editor.langCode, '"' +\r
-                                       ' tabindex="' + tabIndex + '"' +\r
+                                       ( CKEDITOR.env.webkit? ' tabindex="' + tabIndex + '"' : '' ) +\r
+                                       ' role="application"' +\r
+                                       ' aria-labelledby="cke_', name, '_arialbl"' +\r
                                        ( style ? ' style="' + style + '"' : '' ) +\r
                                        '>' +\r
-                                       '<span class="' , CKEDITOR.env.cssClass, '">' +\r
-                                               '<span class="cke_wrapper cke_', editor.lang.dir, '">' +\r
-                                                       '<table class="cke_editor" border="0" cellspacing="0" cellpadding="0"><tbody>' +\r
-                                                               '<tr', topHtml          ? '' : ' style="display:none"', '><td id="cke_top_'             , name, '" class="cke_top">'    , topHtml               , '</td></tr>' +\r
-                                                               '<tr', contentsHtml     ? '' : ' style="display:none"', '><td id="cke_contents_', name, '" class="cke_contents" style="height:', height, '">', contentsHtml, '</td></tr>' +\r
-                                                               '<tr', bottomHtml       ? '' : ' style="display:none"', '><td id="cke_bottom_'  , name, '" class="cke_bottom">' , bottomHtml    , '</td></tr>' +\r
+                                       '<span id="cke_', name, '_arialbl" class="cke_voice_label">' + editor.lang.editor + '</span>' +\r
+                                       '<span class="' , CKEDITOR.env.cssClass, '" role="presentation">' +\r
+                                               '<span class="cke_wrapper cke_', editor.lang.dir, '" role="presentation">' +\r
+                                                       '<table class="cke_editor" border="0" cellspacing="0" cellpadding="0" role="presentation"><tbody>' +\r
+                                                               '<tr', topHtml          ? '' : ' style="display:none"', ' role="presentation"><td id="cke_top_'         , name, '" class="cke_top" role="presentation">'        , topHtml               , '</td></tr>' +\r
+                                                               '<tr', contentsHtml     ? '' : ' style="display:none"', ' role="presentation"><td id="cke_contents_', name, '" class="cke_contents" style="height:', height, '" role="presentation">', contentsHtml, '</td></tr>' +\r
+                                                               '<tr', bottomHtml       ? '' : ' style="display:none"', ' role="presentation"><td id="cke_bottom_'      , name, '" class="cke_bottom" role="presentation">'     , bottomHtml    , '</td></tr>' +\r
                                                        '</tbody></table>' +\r
                                                        //Hide the container when loading skins, later restored by skin css.\r
                                                        '<style>.', editor.skinClass, '{visibility:hidden;}</style>' +\r
@@ -68,8 +141,8 @@ CKEDITOR.themes.add( 'default', (function()
                                        '</span>' +\r
                                '</span>' ].join( '' ) );\r
 \r
-                       container.getChild( [0, 0, 0, 0, 0] ).unselectable();\r
-                       container.getChild( [0, 0, 0, 0, 2] ).unselectable();\r
+                       container.getChild( [1, 0, 0, 0, 0] ).unselectable();\r
+                       container.getChild( [1, 0, 0, 0, 2] ).unselectable();\r
 \r
                        if ( elementMode == CKEDITOR.ELEMENT_MODE_REPLACE )\r
                                container.insertAfter( element );\r
@@ -86,6 +159,9 @@ CKEDITOR.themes.add( 'default', (function()
                         */\r
                        editor.container = container;\r
 \r
+                       // Disable browser context menu for editor's chrome.\r
+                       container.disableContextMenu();\r
+\r
                        editor.fireOnce( 'themeLoaded' );\r
                        editor.fireOnce( 'uiReady' );\r
                },\r
@@ -95,21 +171,27 @@ CKEDITOR.themes.add( 'default', (function()
                        var baseIdNumber = CKEDITOR.tools.getNextNumber();\r
 \r
                        var element = CKEDITOR.dom.element.createFromHtml( [\r
-                                       '<div id="cke_' + editor.name.replace('.', '\\.') + '_dialog" class="cke_skin_', editor.skinName,\r
+                                       '<div class="', editor.id, '_dialog cke_editor_', editor.name.replace('.', '\\.'), '_dialog cke_skin_', editor.skinName,\r
                                                '" dir="', editor.lang.dir, '"' +\r
                                                ' lang="', editor.langCode, '"' +\r
+                                               ' role="dialog"' +\r
+                                               ' aria-labelledby="%title#"' +\r
                                                '>' +\r
-\r
-                                               '<div class="cke_dialog', ' ' + CKEDITOR.env.cssClass,\r
-                                                       ' cke_', editor.lang.dir, '" style="position:absolute">' +\r
-                                                       '<div class="%body">' +\r
-                                                               '<div id="%title#" class="%title"></div>' +\r
-                                                               '<div id="%close_button#" class="%close_button">' +\r
-                                                                       '<span>X</span>' +\r
-                                                               '</div>' +\r
-                                                               '<div id="%tabs#" class="%tabs"></div>' +\r
-                                                               '<div id="%contents#" class="%contents"></div>' +\r
-                                                               '<div id="%footer#" class="%footer"></div>' +\r
+                                               '<table class="cke_dialog', ' ' + CKEDITOR.env.cssClass,\r
+                                                       ' cke_', editor.lang.dir, '" style="position:absolute" role="presentation">' +\r
+                                                       '<tr><td role="presentation">' +\r
+                                                       '<div class="%body" role="presentation">' +\r
+                                                               '<div id="%title#" class="%title" role="presentation"></div>' +\r
+                                                               '<a id="%close_button#" class="%close_button" href="javascript:void(0)" title="' +  editor.lang.common.close+'" role="button"><span class="cke_label">X</span></a>' +\r
+                                                               '<div id="%tabs#" class="%tabs" role="tablist"></div>' +\r
+                                                               '<table class="%contents" role="presentation">' +\r
+                                                               '<tr>' +\r
+                                                                 '<td id="%contents#" class="%contents" role="presentation"></td>' +\r
+                                                               '</tr>' +\r
+                                                               '<tr>' +\r
+                                                                 '<td id="%footer#" class="%footer" role="presentation"></td>' +\r
+                                                               '</tr>' +\r
+                                                               '</table>' +\r
                                                        '</div>' +\r
                                                        '<div id="%tl#" class="%tl"></div>' +\r
                                                        '<div id="%tc#" class="%tc"></div>' +\r
@@ -119,7 +201,8 @@ CKEDITOR.themes.add( 'default', (function()
                                                        '<div id="%bl#" class="%bl"></div>' +\r
                                                        '<div id="%bc#" class="%bc"></div>' +\r
                                                        '<div id="%br#" class="%br"></div>' +\r
-                                               '</div>',\r
+                                                       '</td></tr>' +\r
+                                               '</table>',\r
 \r
                                                //Hide the container when loading skins, later restored by skin css.\r
                                                ( CKEDITOR.env.ie ? '' : '<style>.cke_dialog{visibility:hidden;}</style>' ),\r
@@ -129,11 +212,13 @@ CKEDITOR.themes.add( 'default', (function()
                                        .replace( /#/g, '_' + baseIdNumber )\r
                                        .replace( /%/g, 'cke_dialog_' ) );\r
 \r
-                       var body = element.getChild( [ 0, 0 ] );\r
+                       var body = element.getChild( [ 0, 0, 0, 0, 0 ] ),\r
+                               title = body.getChild( 0 ),\r
+                               close = body.getChild( 1 );\r
 \r
                        // Make the Title and Close Button unselectable.\r
-                       body.getChild( 0 ).unselectable();\r
-                       body.getChild( 1 ).unselectable();\r
+                       title.unselectable();\r
+                       close.unselectable();\r
 \r
 \r
                        return {\r
@@ -141,11 +226,11 @@ CKEDITOR.themes.add( 'default', (function()
                                parts :\r
                                {\r
                                        dialog          : element.getChild( 0 ),\r
-                                       title           : body.getChild( 0 ),\r
-                                       close           : body.getChild( 1 ),\r
+                                       title           : title,\r
+                                       close           : close,\r
                                        tabs            : body.getChild( 2 ),\r
-                                       contents        : body.getChild( 3 ),\r
-                                       footer          : body.getChild( 4 )\r
+                                       contents        : body.getChild( [ 3, 0, 0, 0 ] ),\r
+                                       footer          : body.getChild( [ 3, 0, 1, 0 ] )\r
                                }\r
                        };\r
                },\r
@@ -153,41 +238,31 @@ CKEDITOR.themes.add( 'default', (function()
                destroy : function( editor )\r
                {\r
                        var container = editor.container;\r
-\r
-                       /*\r
-                        * IE BUG: Removing the editor DOM elements while the selection is inside\r
-                        * the editing area would break IE7/8's selection system. So we need to put\r
-                        * the selection back to the parent document without scrolling the window.\r
-                        * (#3812)\r
-                        */\r
-                       if ( CKEDITOR.env.ie )\r
-                       {\r
-                               container.setStyle( 'display', 'none' );\r
-\r
-                               var $range = document.body.createTextRange();\r
-                               $range.moveToElementText( container.$ );\r
-                               try\r
-                               {\r
-                                       // Putting the selection to a display:none element - this will certainly\r
-                                       // fail. But! We've just put the selection document back to the parent\r
-                                       // document without scrolling the window!\r
-                                       $range.select();\r
-                               }\r
-                               catch ( e ) {}\r
-                       }\r
+                       container.clearCustomData();\r
+                       editor.element.clearCustomData();\r
 \r
                        if ( container )\r
                                container.remove();\r
 \r
                        if ( editor.elementMode == CKEDITOR.ELEMENT_MODE_REPLACE )\r
-                       {\r
                                editor.element.show();\r
-                               delete editor.element;\r
-                       }\r
+\r
+                       delete editor.element;\r
                }\r
        };\r
 })() );\r
 \r
+/**\r
+ * Returns the DOM element that represents a theme space. The default theme defines\r
+ * three spaces, namely "top", "contents" and "bottom", representing the main\r
+ * blocks that compose the editor interface.\r
+ * @param {String} spaceName The space name.\r
+ * @returns {CKEDITOR.dom.element} The element that represents the space.\r
+ * @example\r
+ * // Hide the bottom space in the UI.\r
+ * var bottom = editor.getThemeSpace( 'bottom' );\r
+ * bottom.setStyle( 'display', 'none' );\r
+ */\r
 CKEDITOR.editor.prototype.getThemeSpace = function( spaceName )\r
 {\r
        var spacePrefix = 'cke_' + spaceName;\r
@@ -196,21 +271,38 @@ CKEDITOR.editor.prototype.getThemeSpace = function( spaceName )
        return space;\r
 };\r
 \r
+/**\r
+ * Resizes the editor interface.\r
+ * @param {Number|String} width The new width. It can be an pixels integer or a\r
+ *             CSS size value.\r
+ * @param {Number|String} height The new height. It can be an pixels integer or\r
+ *             a CSS size value.\r
+ * @param {Boolean} [isContentHeight] Indicates that the provided height is to\r
+ *             be applied to the editor contents space, not to the entire editor\r
+ *             interface. Defaults to false.\r
+ * @param {Boolean} [resizeInner] Indicates that the first inner interface\r
+ *             element must receive the size, not the outer element. The default theme\r
+ *             defines the interface inside a pair of span elements\r
+ *             (&lt;span&gt;&lt;span&gt;...&lt;/span&gt;&lt;/span&gt;). By default the\r
+ *             first span element receives the sizes. If this parameter is set to\r
+ *             true, the second span is sized instead.\r
+ * @example\r
+ * editor.resize( 900, 300 );\r
+ * @example\r
+ * editor.resize( '100%', 450, true );\r
+ */\r
 CKEDITOR.editor.prototype.resize = function( width, height, isContentHeight, resizeInner )\r
 {\r
-       var numberRegex = /^\d+$/;\r
-       if ( numberRegex.test( width ) )\r
-               width += 'px';\r
-\r
-       var contents = CKEDITOR.document.getById( 'cke_contents_' + this.name );\r
-       var outer = resizeInner ? contents.getAscendant( 'table' ).getParent()\r
-               : contents.getAscendant( 'table' ).getParent().getParent().getParent();\r
+       var container = this.container,\r
+               contents = CKEDITOR.document.getById( 'cke_contents_' + this.name ),\r
+               outer = resizeInner ? container.getChild( 1 ) : container;\r
 \r
        // Resize the width first.\r
        // WEBKIT BUG: Webkit requires that we put the editor off from display when we\r
        // resize it. If we don't, the browser crashes!\r
        CKEDITOR.env.webkit && outer.setStyle( 'display', 'none' );\r
-       outer.setStyle( 'width', width );\r
+       // Set as border box width. (#5353)\r
+       outer.setSize( 'width',  width, true );\r
        if ( CKEDITOR.env.webkit )\r
        {\r
                outer.$.offsetWidth;\r
@@ -226,7 +318,47 @@ CKEDITOR.editor.prototype.resize = function( width, height, isContentHeight, res
        this.fire( 'resize' );\r
 };\r
 \r
+/**\r
+ * Gets the element that can be freely used to check the editor size. This method\r
+ * is mainly used by the resize plugin, which adds a UI handle that can be used\r
+ * to resize the editor.\r
+ * @returns {CKEDITOR.dom.element} The resizable element.\r
+ * @example\r
+ */\r
 CKEDITOR.editor.prototype.getResizable = function()\r
 {\r
-       return this.container.getChild( [ 0, 0 ] );\r
+       return this.container.getChild( 1 );\r
 };\r
+\r
+/**\r
+ * Makes it possible to place some of the editor UI blocks, like the toolbar\r
+ * and the elements path, into any element in the page.\r
+ * The elements used to hold the UI blocks can be shared among several editor\r
+ * instances. In that case, only the blocks of the active editor instance will\r
+ * display.\r
+ * @name CKEDITOR.config.sharedSpaces\r
+ * @type Object\r
+ * @default undefined\r
+ * @example\r
+ * // Place the toolbar inside the element with ID "someElementId" and the\r
+ * // elements path into the element with ID "anotherId".\r
+ * config.sharedSpaces =\r
+ * {\r
+ *     top : 'someElementId',\r
+ *     bottom : 'anotherId'\r
+ * };\r
+ * @example\r
+ * // Place the toolbar inside the element with ID "someElementId". The\r
+ * // elements path will remain attached to the editor UI.\r
+ * config.sharedSpaces =\r
+ * {\r
+ *     top : 'someElementId'\r
+ * };\r
+ */\r
+\r
+/**\r
+ * Fired after the editor instance is resized through\r
+ * the {@link CKEDITOR.editor.prototype.resize} method.\r
+ * @name CKEDITOR#resize\r
+ * @event\r
+ */\r