loading table of contents...

7.4.5. Customizing RichText Property Fields

A richtext property field consists of the richtext toolbar and a WYSIWYG editing area, the richTextArea, which is a wrapper for an instance of the CKEditor. The CKEditor provides richtext editing features via plugins. It is important to note that Ext JS and CKEditor are independent and offer their own JavaScript API.

The richtext toolbar is a standard ExtJS toolbar and contains buttons and menu items that perform richtext-related actions. There are a pre-defined set of buttons which are activated on this toolbar, which may be configured. This is described in Section 7.4.5.5, “Customizing Richtext Toolbar”. It is possible to add or remove buttons or menus from the toolbar. This may be done for pre-defined and custom actions.

The richtext property field comes with a set of pre-defined actions which can be activated, deactivated or configured. At the end of this section is a list of configuration options for these actions.

Most of these actions are wired closely to the CKEditor in the sense that the actions invoke CKEditor commands, which in turn are defined by CKEditor plugins. Some of these plugins like pastefromword and pastetext use CKEditor dialogs (with a custom CoreMedia skin to better integrate into the Studio UI).

Other actions are plain ExtJS actions (maybe using an ExtJS dialog) that interact with the CKEditor directly via its API.

It is also possible to define custom actions by writing plugins for the richtext property field or by using CKEditor plugins directly. This is described in Section 7.4.5.6, “Customizing CKEditor”.

As with the pre-defined actions, you may write custom actions which invoke CKEditor commands or write custom ExtJS actions which use the CKEditor API. This is described in Section 7.4.5.7, “Interacting with the CKEditor via API”

You can remove entire CKEditor plugins if required. When you do so, you should also remove the corresponding buttons or menu items that are wired to commands defined in that plugin.

The following is a list of configuration options for pre-defined richtext actions: