File Index
adapters/jquery.js
jQuery adapter provides easy use of basic CKEditor functions and access to internal API. It also integrates some aspects of CKEditor with jQuery framework. Every TEXTAREA, DIV and P elements can be converted to working editor. Plugin exposes some of editor's event to jQuery event system. All of those are namespaces inside ".ckeditor" namespace and can be binded/listened on supported textarea, div and p nodes. Available jQuery events: - instanceReady.ckeditor( editor, rootNode ) Triggered when new instance is ready. - destroy.ckeditor( editor ) Triggered when instance is destroyed. - getData.ckeditor( editor, eventData ) Triggered when getData event is fired inside editor. It can change returned data using eventData reference. - setData.ckeditor( editor ) Triggered when getData event is fired inside editor.core/_bootstrap.js
API initialization code.core/ckeditor_basic.js
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.core/commanddefinition.js
Defines the "virtual" CKEDITOR.commandDefinition class, which contains the defintion of a command. This file is for documentation purposes only.core/dataprocessor.js
Defines the "virtual" CKEDITOR.dataProcessor class, which defines the basic structure of data processor objects to be set to CKEDITOR.editor.dataProcessor.core/dom/domobject.js
Defines the CKEDITOR.editor class, which is the base for other classes representing DOM objects.core/dom/event.js
Defines the CKEDITOR.dom.event class, which represents the a native DOM event object.core/dom/node.js
Defines the CKEDITOR.dom.node class which is the base class for classes that represent DOM nodes.core/dtd.js
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.core/event.js
Defines the CKEDITOR.event class, which serves as the base for classes and objects that require event handling features.core/eventInfo.js
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.core/focusmanager.js
Defines the CKEDITOR.focusManager class, which is used to handle the focus on editor instances..core/loader.js
Defines the CKEDITOR.loader objects, which is used to load core scripts and their dependencies from _source.core/plugindefinition.js
Defines the "virtual" CKEDITOR.pluginDefinition class, which contains the defintion of a plugin. This file is for documentation purposes only.core/plugins.js
Defines the CKEDITOR.plugins object, which is used to manage plugins registration and loading.core/resourcemanager.js
Defines the CKEDITOR.resourceManager class, which is the base for resource managers, like plugins and themes.core/themes.js
Defines the CKEDITOR.themes object, which is used to manage themes registration and loading.plugins/a11yhelp/plugin.js
Plugin definition for the a11yhelp, which provides a dialog with accessibility related help.plugins/colorbutton/plugin.js
The "colorbutton" plugin that makes it possible to assign text and background colors to editor contents.plugins/dialog/dialogDefinition.js
Defines the "virtual" dialog, dialog content and dialog button definition classes.plugins/dialog/plugin.js
The floating dialog plugin.plugins/dialogui/plugin.js
The "dialogui" plugin.plugins/div/plugin.js
The "div" plugin. It wraps the selected block level elements with a 'div' element with specified styles and attributes.plugins/editingblock/plugin.js
The default editing block plugin, which holds the editing area and source view.plugins/elementspath/plugin.js
The "elementspath" plugin. It shows all elements in the DOM parent tree relative to the current selection in the editing area.plugins/filebrowser/plugin.js
The "filebrowser" plugin that adds support for file uploads and browsing. When a file is uploaded or selected inside the file browser, its URL is inserted automatically into a field defined in thefilebrowser
attribute. In order to specify a field that should be updated, pass the tab ID and
the 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 for an element other than
the 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 for a fileButton
element, the QuickUpload action will be executed.The filebrowser plugin also supports more advanced configuration performed through a JavaScript object. The following settings are supported:
action–BrowseorQuickUpload.target– the field to update in thetabId:elementIdformat.params– additional arguments to be passed to the server connector (optional).onSelect– a function to execute when the file is selected/uploaded (optional).url– the URL to be called (optional).
{
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 you have a file element with an ID of myFile, a text
field with an ID of elementId and a fileButton.
If the filebowser.url attribute is not specified explicitly,
the form action will be set to filebrowser[DialogWindowName]UploadUrl
or, if not specified, to filebrowserUploadUrl. Additional parameters
from the 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, when the button is pressed, the file browser will be opened in a
popup window. If you do not specify the filebrowser.url attribute,
filebrowser[DialogName]BrowseUrl or
filebrowserBrowseUrl will be used. After selecting a file in the file
browser, an element with an ID of elementId will be updated. Just
like in the third example, a custom onSelect function may be defined.