JasonWoof Got questions, comments, patches, etc.? Contact Jason Woofenden
vanilla ckeditor-3.4.3
[ckeditor.git] / _source / themes / default / theme.js
index 078eb19..669aeb3 100644 (file)
@@ -3,6 +3,11 @@ Copyright (c) 2003-2010, CKSource - Frederico Knabben. All rights reserved.
 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
        function checkSharedSpace( editor, spaceName )\r
@@ -22,7 +27,7 @@ CKEDITOR.themes.add( 'default', (function()
                        // Creates an HTML structure that reproduces the editor class hierarchy.\r
                        var html =\r
                                '<span class="cke_shared">' +\r
-                               '<span class="' + editor.skinClass + ' cke_editor_' + editor.name + '">' +\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
@@ -65,7 +70,7 @@ CKEDITOR.themes.add( 'default', (function()
                return container;\r
        }\r
 \r
-       return {\r
+       return /** @lends CKEDITOR.theme */ {\r
                build : function( editor, themePath )\r
                {\r
                        var name = editor.name,\r
@@ -113,8 +118,7 @@ CKEDITOR.themes.add( 'default', (function()
                        var container = CKEDITOR.dom.element.createFromHtml( [\r
                                '<span' +\r
                                        ' id="cke_', name, '"' +\r
-                                       ' onmousedown="return false;"' +\r
-                                       ' class="', editor.skinClass, ' cke_editor_', name, '"' +\r
+                                       ' class="', editor.skinClass, ' ', editor.id, ' cke_editor_', name, '"' +\r
                                        ' dir="', editor.lang.dir, '"' +\r
                                        ' title="', ( CKEDITOR.env.gecko ? ' ' : '' ), '"' +\r
                                        ' lang="', editor.langCode, '"' +\r
@@ -167,7 +171,7 @@ CKEDITOR.themes.add( 'default', (function()
                        var baseIdNumber = CKEDITOR.tools.getNextNumber();\r
 \r
                        var element = CKEDITOR.dom.element.createFromHtml( [\r
-                                       '<div class="cke_editor_' + editor.name.replace('.', '\\.') + '_dialog 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
@@ -180,10 +184,14 @@ CKEDITOR.themes.add( 'default', (function()
                                                                '<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"><tr>' +\r
+                                                               '<table class="%contents" role="presentation">' +\r
+                                                               '<tr>' +\r
                                                                  '<td id="%contents#" class="%contents" role="presentation"></td>' +\r
-                                                               '</tr></table>' +\r
-                                                               '<div id="%footer#" class="%footer" role="presentation"></div>' +\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
@@ -222,7 +230,7 @@ CKEDITOR.themes.add( 'default', (function()
                                        close           : close,\r
                                        tabs            : body.getChild( 2 ),\r
                                        contents        : body.getChild( [ 3, 0, 0, 0 ] ),\r
-                                       footer          : body.getChild( 4 )\r
+                                       footer          : body.getChild( [ 3, 0, 1, 0 ] )\r
                                }\r
                        };\r
                },\r
@@ -233,28 +241,6 @@ CKEDITOR.themes.add( 'default', (function()
                        container.clearCustomData();\r
                        editor.element.clearCustomData();\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
-\r
                        if ( container )\r
                                container.remove();\r
 \r
@@ -266,6 +252,17 @@ CKEDITOR.themes.add( 'default', (function()
        };\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
@@ -274,12 +271,28 @@ 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 container = this.container,\r
                contents = CKEDITOR.document.getById( 'cke_contents_' + this.name ),\r
                outer = resizeInner ? container.getChild( 1 ) : container;\r
@@ -288,7 +301,8 @@ CKEDITOR.editor.prototype.resize = function( width, height, isContentHeight, res
        // 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
@@ -304,6 +318,13 @@ 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( 1 );\r
@@ -334,3 +355,10 @@ CKEDITOR.editor.prototype.getResizable = function()
  *     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