EditLive! 9 Documentation : Creating and Using Plugins in the Applet

Created by Jessica Hardy, last modified by Gavin Douglas on Jul 25, 2012

EditLive!'s Advanced API and plugin functionality is only supported with an EditLive! Enterprise Edition license.

EditLive! allows developers to easily create and integrate plugins into the editor. Plugins can deliver additional functionality to EditLive! either through Advanced API extensions to the editor or through Javascript implementations of the run-time properties.

Creating Plugins

Plugins are defined using the Plugin XML specifications. Plugin XML tells the editor meta information such as: 

  • The type of code the plugin will run (i.e. Advanced API Java code or Javascript).
  • The location of the plugin code.
  • Changes to the menus in the editor to allow the user to utilize new functionality provided in the plugin.
  • Definitions on when the plugin should be loaded.

To create an EditLive! plugin, you need to perform the following steps:

  1. Create the desired functionality as either an Advanced API implementation or a Javascript .js file.
  2. Create Plugin XML to reference the functionality you created in step 1.
  3. If required, create menu items in the Plugin XML to allow users to enable and utilize the functionality in your plugin.

This SDK provides two detailed tutorials on how to create plugins for use with EditLive!:

Loading Plugins

EditLive! loads plugins by registering Plugin XML with the editor. Plugin XML can be registered with the editor via the following methods: