File Index
Defines the
CKEDITOR.ajax object, which holds ajax methods for
data loading.
Contains the third and last part of the
CKEDITOR object
definition.
Contains the first and essential part of the
CKEDITOR
object definition.
Contains the second part of the
CKEDITOR object
definition, which defines the basic editor features to be available in
the root ckeditor_basic.js file.
Defines the "virtual"
CKEDITOR.commandDefinition class,
which contains the defintion of a command. This file is for
documentation purposes only.
Defines the
CKEDITOR.config object, which holds the
default configuration settings.
Defines the
CKEDITOR.dom object, which contains DOM
manipulation objects and function.
Defines the CKEDITOR.dom.comment class, which represents
a DOM comment node.
Defines the
CKEDITOR.editor class, which is the base
for other classes representing DOM objects.
Defines the
CKEDITOR.dom.node class, which is the base
class for classes that represent DOM nodes.
Defines the
CKEDITOR.dtd object, which holds the DTD
mapping for XHTML 1.0 Transitional. This file was automatically
generated from the file: xhtml1-transitional.dtd.
Defines the
CKEDITOR.env object, which constains
environment and browser information.
Defines the
CKEDITOR.event class, which serves as the
base for classes and objects that require event handling features.
Defines the "virtual"
CKEDITOR.eventInfo class, which
contains the defintions of the event object passed to event listeners.
This file is for documentation purposes only.
Defines the
CKEDITOR.loader objects, which is used to
load core scripts and their dependencies from _source.
Defines the "virtual"
CKEDITOR.pluginDefinition class, which
contains the defintion of a plugin. This file is for documentation
purposes only.
Defines the
CKEDITOR.plugins object, which is used to
manage plugins registration and loading.
Defines the
CKEDITOR.skins object, which is used to
manage skins loading.
Defines the
CKEDITOR.themes object, which is used to
manage themes registration and loading.
Defines the
CKEDITOR.xml class, which represents a
loaded XML document.
Defines the CKEDITOR.lang object, for the English
language. This is the base file for all translations.
Plugin definition for the a11yhelp, which provides a dialog
with accessibility related help.
Defines the "virtual" dialog, dialog content and dialog button
definition classes.
The floating dialog plugin.
The "div" plugin. It wraps the selected block level elements with a 'div' element with specified styles and attributes.
The default editing block plugin, which holds the editing area
and source view.
The "elementspath" plugin. It shows all elements in the DOM
parent tree relative to the current selection in the editing area.
The "filebrowser" plugin, it adds support for file uploads and
browsing.
When file is selected inside of the file browser or uploaded, its url is
inserted automatically to a field, which is described in the 'filebrowser'
attribute. To specify field that should be updated, pass the tab id and
element id, separated with a colon.
Example 1: (Browse)
{
type : 'button',
id : 'browse',
filebrowser : 'tabId:elementId',
label : editor.lang.common.browseServer
}
If you set the 'filebrowser' attribute on any element other than
'fileButton', the 'Browse' action will be triggered.
Example 2: (Quick Upload)
{
type : 'fileButton',
id : 'uploadButton',
filebrowser : 'tabId:elementId',
label : editor.lang.common.uploadSubmit,
'for' : [ 'upload', 'upload' ]
}
If you set the 'filebrowser' attribute on a fileButton element, the
'QuickUpload' action will be executed.
Filebrowser plugin also supports more advanced configuration (through
javascript object).
The following settings are supported:
[action] - Browse or QuickUpload
[target] - field to update, tabId:elementId
[params] - additional arguments to be passed to the server connector (optional)
[onSelect] - function to execute when file is selected/uploaded (optional)
[url] - the URL to be called (optional)
Example 3: (Quick Upload)
{
type : 'fileButton',
label : editor.lang.common.uploadSubmit,
id : 'buttonId',
filebrowser :
{
action : 'QuickUpload', //required
target : 'tab1:elementId', //required
params : //optional
{
type : 'Files',
currentFolder : '/folder/'
},
onSelect : function( fileUrl, errorMessage ) //optional
{
// Do not call the built-in selectFuntion
// return false;
}
},
'for' : [ 'tab1', 'myFile' ]
}
Suppose we have a file element with id 'myFile', text field with id
'elementId' and a fileButton. If filebowser.url is not specified explicitly,
form action will be set to 'filebrowser[DialogName]UploadUrl' or, if not
specified, to 'filebrowserUploadUrl'. Additional parameters from 'params'
object will be added to the query string. It is possible to create your own
uploadHandler and cancel the built-in updateTargetElement command.
Example 4: (Browse)
{
type : 'button',
id : 'buttonId',
label : editor.lang.common.browseServer,
filebrowser :
{
action : 'Browse',
url : '/ckfinder/ckfinder.html&type=Images',
target : 'tab1:elementId'
}
}
In this example, after pressing a button, file browser will be opened in a
popup. If we don't specify filebrowser.url attribute,
'filebrowser[DialogName]BrowseUrl' or 'filebrowserBrowseUrl' will be used.
After selecting a file in a file browser, an element with id 'elementId' will
be updated. Just like in the third example, a custom 'onSelect' function may be
defined.
Plugin for making iframe based dialogs.
Spell Check As You Type (SCAYT).
Button name : Scayt.
The "showblocks" plugin. Enable it will make all block level
elements being decorated with a border and the element name
displayed on the left-right corner.
The "show border" plugin. The command display visible outline
border line around all table elements if table doesn't have a none-zero 'border' attribute specified.
The "sourcearea" plugin. It registers the "source" editing
mode, which displays the raw data being edited in the editor.
The "toolbar" plugin. Renders the default toolbar interface in
the editor.
Undo/Redo system for saving shapshot for document modification
and other recordable changes.
The "wysiwygarea" plugin. It registers the "wysiwyg" editing
mode, which handles the main editing area space.