vanilla ckeditor-3.4.2

[ckeditor.git] / _source / core / env.js

diff --git a/_source/core/env.js b/_source/core/env.js
index a0ae465..e992d3a 100644 (file)
--- a/_source/core/env.js
+++ b/_source/core/env.js
@@ -11,9 +11,7 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
 if ( !CKEDITOR.env )\r
 {\r
        /**\r
-        * Environment and browser information.\r
-        * @namespace\r
-        * @example\r
+        * @namespace Environment and browser information.\r
         */\r
        CKEDITOR.env = (function()\r
        {\r
@@ -69,10 +67,32 @@ if ( !CKEDITOR.env )
                         */\r
                        mac     : ( agent.indexOf( 'macintosh' ) > -1 ),\r
 \r
+                       /**\r
+                        * Indicates that CKEditor is running on a quirks mode environemnt.\r
+                        * @type Boolean\r
+                        * @example\r
+                        * if ( CKEDITOR.env.quirks )\r
+                        *     alert( "Nooooo!" );\r
+                        */\r
                        quirks : ( document.compatMode == 'BackCompat' ),\r
 \r
+                       /**\r
+                        * Indicates that CKEditor is running on a mobile like environemnt.\r
+                        * @type Boolean\r
+                        * @example\r
+                        * if ( CKEDITOR.env.mobile )\r
+                        *     alert( "I'm running with CKEditor today!" );\r
+                        */\r
                        mobile : ( agent.indexOf( 'mobile' ) > -1 ),\r
 \r
+                       /**\r
+                        * Indicates that the browser has a custom domain enabled. This has\r
+                        * been set with "document.domain".\r
+                        * @returns {Boolean} "true" if a custom domain is enabled.\r
+                        * @example\r
+                        * if ( CKEDITOR.env.isCustomDomain() )\r
+                        *     alert( "I'm in a custom domain!" );\r
+                        */\r
                        isCustomDomain : function()\r
                        {\r
                                if ( !this.ie )\r
@@ -105,19 +125,34 @@ if ( !CKEDITOR.env )
                        version = parseFloat( agent.match( /msie (\d+)/ )[1] );\r
 \r
                        /**\r
-                        *  Indicate IE8 browser.\r
+                        * Indicates that CKEditor is running on Internet Explorer 8.\r
+                        * @name CKEDITOR.env.ie8\r
+                        * @type Boolean\r
+                        * @example\r
+                        * if ( CKEDITOR.env.ie8 )\r
+                        *     alert( "I'm on IE8!" );\r
                         */\r
                        env.ie8 = !!document.documentMode;\r
 \r
                        /**\r
-                        * Indicte IE8 document mode.\r
+                        * Indicates that CKEditor is running on Internet Explorer 8 on\r
+                        * standards mode.\r
+                        * @name CKEDITOR.env.ie8Compat\r
+                        * @type Boolean\r
+                        * @example\r
+                        * if ( CKEDITOR.env.ie8Compat )\r
+                        *     alert( "Now I'm on IE8, for real!" );\r
                         */\r
                        env.ie8Compat = document.documentMode == 8;\r
 \r
                        /**\r
                         * Indicates that CKEditor is running on an IE7-like environment, which\r
                         * includes IE7 itself and IE8's IE7 document mode.\r
+                        * @name CKEDITOR.env.ie7Compat\r
                         * @type Boolean\r
+                        * @example\r
+                        * if ( CKEDITOR.env.ie8Compat )\r
+                        *     alert( "I'm on IE7 or on an IE7 like IE8!" );\r
                         */\r
                        env.ie7Compat = ( ( version == 7 && !document.documentMode )\r
                                        || document.documentMode == 7 );\r
@@ -125,13 +160,13 @@ if ( !CKEDITOR.env )
                        /**\r
                         * Indicates that CKEditor is running on an IE6-like environment, which\r
                         * includes IE6 itself and IE7 and IE8 quirks mode.\r
+                        * @name CKEDITOR.env.ie6Compat\r
                         * @type Boolean\r
                         * @example\r
                         * if ( CKEDITOR.env.ie6Compat )\r
                         *     alert( "I'm on IE6 or quirks mode!" );\r
                         */\r
                        env.ie6Compat = ( version < 7 || env.quirks );\r
-\r
                }\r
 \r
                // Gecko.\r
@@ -160,12 +195,12 @@ if ( !CKEDITOR.env )
                        version = parseFloat( agent.match( / applewebkit\/(\d+)/ )[1] );\r
 \r
                /**\r
-                * Contains the browser version.\r
-                *\r
+                * Contains the browser version.<br />\r
+                * <br />\r
                 * For gecko based browsers (like Firefox) it contains the revision\r
                 * number with first three parts concatenated with a padding zero\r
-                * (e.g. for revision 1.9.0.2 we have 10900).\r
-                *\r
+                * (e.g. for revision 1.9.0.2 we have 10900).<br />\r
+                * <br />\r
                 * For webkit based browser (like Safari and Chrome) it contains the\r
                 * WebKit build version (e.g. 522).\r
                 * @name CKEDITOR.env.version\r
@@ -193,8 +228,14 @@ if ( !CKEDITOR.env )
                        ( env.webkit && version >= 522 ) ||\r
                        false );\r
 \r
-               // The CSS class to be appended on the main UI containers, making it\r
-               // easy to apply browser specific styles to it.\r
+               /**\r
+                * The CSS class to be appended on the main UI containers, making it\r
+                * easy to apply browser specific styles to it.\r
+                * @name CKEDITOR.env.cssClass\r
+                * @type String\r
+                * @example\r
+                * myDiv.className = CKEDITOR.env.cssClass;\r
+                */\r
                env.cssClass =\r
                        'cke_browser_' + (\r
                                env.ie ? 'ie' :\r
@@ -211,7 +252,7 @@ if ( !CKEDITOR.env )
                {\r
                        env.cssClass += ' cke_browser_ie' + (\r
                                env.version < 7 ? '6' :\r
-                               env.version >= 8 ? '8' :\r
+                               env.version >= 8 ? document.documentMode:\r
                                '7' );\r
 \r
                        if ( env.quirks )\r