Revision as of 17:22, 9 February 2008

FCKeditor JavaScript API

FCKeditor offers a complete JavaScript API so you can interact with it once the editor is loaded and running.

Once loaded, the editor registers a global object called FCKeditorAPI. This object offers the entry point to interact with any editor instance placed in a page (you can have more than one).

NOTE: The FCKeditorAPI object will not be available during the page load. You need to wait for the editor to be loaded to use it. If you need to interact with the editor right after is has been loaded, use the "FCKeditor_OnComplete" function (see Events).

Retrieving an Editor Instance

• From out of an external script
  When placing the editor in the page, you give it an "instance name". To retrieve it, you must simply call the FCKeditorAPI.GetInstance method.
  Example:

  var oEditor = FCKeditorAPI.GetInstance('InstanceName') ;

• From out of a dialog of the editor
  Call the InnerDialogLoaded to get the FCKObject.
  Example:

  var oEditor = window.parent.InnerDialogLoaded().FCK ;

Both methods return the main FCKeditor object that gives the necessary bridge to interact with it. These are the most useful properties and methods of this object:

Properties:

• Name = ( string ) - the instance name.
• Status = ( integer ) - the editor status (loading status).
• EditorDocument = ( object ) - the DOM Document object for the editing area.
• EditorWindow = ( object ) - the DOM Window object for the editing area.

Methods:

• AttachToOnSelectionChange( functionPointer )
• Focus()
• GetXHTML( formatted )
• InsertElement( element )
• InsertElementAndGetIt( e )
• InsertHtml( html ) - inserts HTML in the current cursor position
• IsDirty() - checks if the content in the editor has been changed
• MakeEditable()
• ResetIsDirty() - resets the dirty state
• SetHTML( html ) - sets the contents of the editor. Note that when using this method, you will loose any listener that you may have previously registered on the editor.EditorDocument.
• GetHTML() - retrieves the edited html from the editor.
• SwitchEditMode()
• UpdateLinkedField()

Events

Once the editor loading phase is complete and it is ready to use (and interact with JavaScript), a standard function is called in the page that contains the editor, if the function is defined. This function must be named "FCKeditor_OnComplete" and receives the related editor instance as the parameter. Using it, you can execute any initial code that may interact with the editor. This is a declaration example:

function FCKeditor_OnComplete( editorInstance )
{
    alert( editorInstance.Name ) ;
}

Other than the above standard function, every FCKeditor instance has an "Event" object that can be used to listen for events to be fired.

Example: the following code listens for the "OnSelectionChange" to execute custom code:

function FCKeditor_OnComplete( editorInstance )
{
    editorInstance.Events.AttachEvent( 'OnSelectionChange', DoSomething ) ;
}

var counter = 0 ;

function DoSomething( editorInstance )
{
    // This is a sample function that shows in the title bar the number of times
    // the "OnSelectionChange" event is called.
    window.document.title = editorInstance.Name + ' : ' + ( ++counter ) ;
}

Note that every event callback function receives the editor instance as a parameter.

The following is the list of events available:

• OnAfterLinkedFieldUpdate - fired right after the hidden linked field attached to the editor has its contents updated. It happens usually when the form is being posted.
• OnAfterSetHTML - fired once the HTML is loaded in the editor (including when changing views).
• OnFocus - fired when the editor acquires the focus.
• OnPaste - fired when something is pasted in the editor. The function you specify must return true for the paste to proceed.
• OnStatusChange - fired when the editor status changes. The following constants are also available globally in the page: FCK_STATUS_NOTLOADED, FCK_STATUS_ACTIVE and FCK_STATUS_COMPLETE.
• OnSelectionChange - fired when the actual selection in the editor area changes (including cursor position and keystrokes). Note: In IE, this event does not fire on every keystroke, but only on some random keystrokes.

Usage Samples

The following are a few samples of things that can be done with the JavaScript API. (In these samples, oEditor = FCKeditorAPI.GetInstance('InstanceName').)

• Insert HTML at cursor position:

  oEditor.InsertHtml(HTML);

• Triggering a toolbar button / command:

  oEditor.Commands.GetCommand(commandName).Execute();

• Disabling toolbar buttons:

  oEditor.EditorWindow.parent.FCKToolbarItems.LoadedItems[commandName].Disable();

• Setting a config value:

  oEditor.Config['<configVariableName>'] = 'newValue';

• Change editor document style at runtime:

  oEditor.EditorDocument.body.style.cssText += 'color: #322805; background-color: #F7C928;' ;

• Set or get anything of the editor:

  FCKeditorAPI.GetInstance('InstanceName').EditorWindow.parent...

• Add a dynamic Save function:

// called on save
function doSave(){
        alert('Saved.');
        document.getElementById('someElement').innerHTML = 'Saved!';
        return false; //this disables default action (submitting the form)
}
// called when FCKeditor is done starting..
function FCKeditor_OnComplete( editorInstance ){
        editorInstance.LinkedField.form.onsubmit = doSave;
}

• Working with the selection in the editor: Use the Selection Object