Code Index | File Index

Namespaces

Classes


Namespace CKEDITOR.config

Holds the default configuration settings. Changes to this object are reflected in all editor instances, if not specificaly specified for those instances.
Defined in: core/config.js.

Namespace Summary
Constructor Attributes Constructor Name and Description
 
Holds the default configuration settings.
Field Summary
Field Attributes Field Name and Description
<static>  
CKEDITOR.config.baseHref
The base href URL used to resolve relative and absolute URLs in the editor content.
<static>  
CKEDITOR.config.contentsCss
The CSS file to be used to apply style to the contents.
<static>  
CKEDITOR.config.contentsLangDirection
The writting direction of the language used to write the editor contents.
<static>  
CKEDITOR.config.corePlugins
A comma separated list of plugins that are not related to editor instances.
<static>  
CKEDITOR.config.customConfig
The URL path for the custom configuration file to be loaded.
<static>  
CKEDITOR.config.disableNativeSpellChecker
Disables the built-in spell checker while typing natively available in the browser (currently Firefox and Safari only).
<static>  
CKEDITOR.config.disableNativeTableHandles
Disables the "table tools" offered natively by the browser (currently Firefox only) to make quick table editing operations, like adding or deleting rows and columns.
<static>  
CKEDITOR.config.disableObjectResizing
Disables the ability of resize objects (image and tables) in the editing area
<static>  
CKEDITOR.config.docType
Sets the doctype to be used when loading the editor content as HTML.
<static>  
CKEDITOR.config.fullPage
Indicates whether the contents to be edited are being inputted as a full HTML page.
<static>  
CKEDITOR.config.height
The editor height, in CSS size format or pixel integer.
<static>  
CKEDITOR.config.plugins
Comma separated list of plugins to load and initialize for an editor instance.
<static>  
CKEDITOR.config.skin
The skin to load.
<static>  
CKEDITOR.config.startupMode
The mode to load at the editor startup.
<static>  
CKEDITOR.config.theme
The theme to be used to build the UI.
<static>  
CKEDITOR.config.toolbarLocation
The "theme space" to which rendering the toolbar.
<static>  
CKEDITOR.config.width
The editor width in CSS size format or pixel integer.
Namespace Detail
CKEDITOR.config
Since: 3.0
Holds the default configuration settings. Changes to this object are reflected in all editor instances, if not specificaly specified for those instances.
// All editor created after the following setting will not load custom
// configuration files.
CKEDITOR.config.customConfig = '';
Field Detail
<static> {String} CKEDITOR.config.baseHref
Since: 3.0
The base href URL used to resolve relative and absolute URLs in the editor content.
config.baseHref = 'http://www.example.com/path/';
Default Value:
'' (empty string)

<static> {String} CKEDITOR.config.contentsCss
Since: 3.0
The CSS file to be used to apply style to the contents. It should reflect the CSS used in the final pages where the contents are to be used.
config.contentsCss = '/css/mysitestyles.css';
Default Value:
'<CKEditor folder>/contents.css'

<static> {String} CKEDITOR.config.contentsLangDirection
Since: 3.0
The writting direction of the language used to write the editor contents. Allowed values are 'ltr' for Left-To-Right language (like English), or 'rtl' for Right-To-Left languages (like Arabic).
config.contentsLangDirection = 'rtl';
Default Value:
'ltr'

<static> {String} CKEDITOR.config.corePlugins
Since: 3.0
A comma separated list of plugins that are not related to editor instances. Reserved to plugins that extend the core code only.

There are no ways to override this setting, except by editing the source code of CKEditor (_source/core/config.js).

<static> {String} CKEDITOR.config.customConfig
Since: 3.0
The URL path for the custom configuration file to be loaded. If not overloaded with inline configurations, it defaults to the "config.js" file present in the root of the CKEditor installation directory.

CKEditor will recursively load custom configuration files defined inside other custom configuration files.
// Load a specific configuration file.
CKEDITOR.replace( 'myfiled', { customConfig : '/myconfig.js' } );
// Do not load any custom configuration file.
CKEDITOR.replace( 'myfiled', { customConfig : '' } );
Default Value:
'<CKEditor folder>/config.js'

<static> {Boolean} CKEDITOR.config.disableNativeSpellChecker
Since: 3.0
Disables the built-in spell checker while typing natively available in the browser (currently Firefox and Safari only).

Even if word suggestions will not appear in the FCKeditor context menu, this feature is useful to help quickly identifying misspelled words.

This setting is currently compatible with Firefox only due to limitations in other browsers.
Defined in: plugins/wysiwygarea/plugin.js.
config.disableNativeSpellChecker = false;
Default Value:
true

<static> {Boolean} CKEDITOR.config.disableNativeTableHandles
Since: 3.0
Disables the "table tools" offered natively by the browser (currently Firefox only) to make quick table editing operations, like adding or deleting rows and columns.
Defined in: plugins/wysiwygarea/plugin.js.
config.disableNativeTableHandles = false;
Default Value:
true

<static> {Boolean} CKEDITOR.config.disableObjectResizing
Since: 3.0
Disables the ability of resize objects (image and tables) in the editing area
Defined in: plugins/wysiwygarea/plugin.js.
config.disableObjectResizing = true;
Default Value:
false

<static> {String} CKEDITOR.config.docType
Since: 3.0
Sets the doctype to be used when loading the editor content as HTML.
// Set the doctype to the HTML 4 (quirks) mode.
config.docType = '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">';
Default Value:
'<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'

<static> {Boolean} CKEDITOR.config.fullPage
Since: 3.0
Indicates whether the contents to be edited are being inputted as a full HTML page. A full page includes the <html>, <head> and <body> tags. The final output will also reflect this setting, including the <body> contents only if this setting is disabled.
config.fullPage = true;
Default Value:
false

<static> {String|Number} CKEDITOR.config.height
Since: 3.0
The editor height, in CSS size format or pixel integer.
Default Value:
'15em'

<static> {String} CKEDITOR.config.plugins
Since: 3.0
Comma separated list of plugins to load and initialize for an editor instance.
config.plugins = 'editingblock,toolbar,wysiwygarea';
Default Value:
'editingblock,elementspath,sourcearea,toolbar,wysiwygarea'

<static> {String} CKEDITOR.config.skin
Since: 3.0
The skin to load.
config.skin = 'v2';
Default Value:
'default'

<static> {String} CKEDITOR.config.startupMode
Since: 3.0
The mode to load at the editor startup. It depends on the plugins loaded. By default, the "wysiwyg" and "source" modes are available.
Defined in: plugins/editingblock/plugin.js.
config.toolbarLocation = 'source';
Default Value:
'wysiwyg'

<static> {String} CKEDITOR.config.theme
Since: 3.0
The theme to be used to build the UI.
config.theme = 'default';
See:
CKEDITOR.config.skin
Default Value:
'default'

<static> {String} CKEDITOR.config.toolbarLocation
Since: 3.0
The "theme space" to which rendering the toolbar. For the default theme, the recommended options are "top" and "bottom".
Defined in: plugins/toolbar/plugin.js.
config.toolbarLocation = 'bottom';
See:
CKEDITOR.config.theme
Default Value:
'top'

<static> {String|Number} CKEDITOR.config.width
Since: 3.0
The editor width in CSS size format or pixel integer.
Default Value:
'100%'

Documentation generated by JsDoc Toolkit