Changeset 6016


Ignore:
Timestamp:
10/27/2010 09:11:11 PM (5 years ago)
Author:
fredck
Message:

Documentation to the CKEDITOR.env object.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • CKEditor/trunk/_source/core/env.js

    r5991 r6016  
    1212{
    1313        /**
    14          * Environment and browser information.
    15          * @namespace
    16          * @example
     14         * @namespace Environment and browser information.
    1715         */
    1816        CKEDITOR.env = (function()
     
    7068                        mac     : ( agent.indexOf( 'macintosh' ) > -1 ),
    7169
     70                        /**
     71                         * Indicates that CKEditor is running on a quirks mode environemnt.
     72                         * @type Boolean
     73                         * @example
     74                         * if ( CKEDITOR.env.quirks )
     75                         *     alert( "Nooooo!" );
     76                         */
    7277                        quirks : ( document.compatMode == 'BackCompat' ),
    7378
     79                        /**
     80                         * Indicates that CKEditor is running on a mobile like environemnt.
     81                         * @type Boolean
     82                         * @example
     83                         * if ( CKEDITOR.env.mobile )
     84                         *     alert( "I'm running with CKEditor today!" );
     85                         */
    7486                        mobile : ( agent.indexOf( 'mobile' ) > -1 ),
    7587
     88                        /**
     89                         * Indicates that the browser has a custom domain enabled. This has
     90                         * been set with "document.domain".
     91                         * @returns {Boolean} "true" if a custom domain is enabled.
     92                         * @example
     93                         * if ( CKEDITOR.env.isCustomDomain() )
     94                         *     alert( "I'm in a custom domain!" );
     95                         */
    7696                        isCustomDomain : function()
    7797                        {
     
    106126
    107127                        /**
    108                          *  Indicate IE8 browser.
     128                         * Indicates that CKEditor is running on Internet Explorer 8.
     129                         * @name CKEDITOR.env.ie8
     130                         * @type Boolean
     131                         * @example
     132                         * if ( CKEDITOR.env.ie8 )
     133                         *     alert( "I'm on IE8!" );
    109134                         */
    110135                        env.ie8 = !!document.documentMode;
    111136
    112137                        /**
    113                          * Indicte IE8 document mode.
     138                         * Indicates that CKEditor is running on Internet Explorer 8 on
     139                         * standards mode.
     140                         * @name CKEDITOR.env.ie8Compat
     141                         * @type Boolean
     142                         * @example
     143                         * if ( CKEDITOR.env.ie8Compat )
     144                         *     alert( "Now I'm on IE8, for real!" );
    114145                         */
    115146                        env.ie8Compat = document.documentMode == 8;
     
    118149                         * Indicates that CKEditor is running on an IE7-like environment, which
    119150                         * includes IE7 itself and IE8's IE7 document mode.
    120                          * @type Boolean
     151                         * @name CKEDITOR.env.ie7Compat
     152                         * @type Boolean
     153                         * @example
     154                         * if ( CKEDITOR.env.ie8Compat )
     155                         *     alert( "I'm on IE7 or on an IE7 like IE8!" );
    121156                         */
    122157                        env.ie7Compat = ( ( version == 7 && !document.documentMode )
     
    126161                         * Indicates that CKEditor is running on an IE6-like environment, which
    127162                         * includes IE6 itself and IE7 and IE8 quirks mode.
     163                         * @name CKEDITOR.env.ie6Compat
    128164                         * @type Boolean
    129165                         * @example
     
    132168                         */
    133169                        env.ie6Compat = ( version < 7 || env.quirks );
    134 
    135170                }
    136171
     
    161196
    162197                /**
    163                  * Contains the browser version.
    164                  *
     198                 * Contains the browser version.<br />
     199                 * <br />
    165200                 * For gecko based browsers (like Firefox) it contains the revision
    166201                 * number with first three parts concatenated with a padding zero
    167                  * (e.g. for revision 1.9.0.2 we have 10900).
    168                  *
     202                 * (e.g. for revision 1.9.0.2 we have 10900).<br />
     203                 * <br />
    169204                 * For webkit based browser (like Safari and Chrome) it contains the
    170205                 * WebKit build version (e.g. 522).
     
    194229                        false );
    195230
    196                 // The CSS class to be appended on the main UI containers, making it
    197                 // easy to apply browser specific styles to it.
     231                /**
     232                 * The CSS class to be appended on the main UI containers, making it
     233                 * easy to apply browser specific styles to it.
     234                 * @name CKEDITOR.env.cssClass
     235                 * @type String
     236                 * @example
     237                 * myDiv.className = CKEDITOR.env.cssClass;
     238                 */
    198239                env.cssClass =
    199240                        'cke_browser_' + (
Note: See TracChangeset for help on using the changeset viewer.
© 2003 – 2012 CKSource – Frederico Knabben. All rights reserved. | Terms of use | Privacy policy