Provides the class and interfaces necessary for creating Plug-ins for the Apelon DTS Editor. A plug-in is defined as a module or set of modules that provide custom features within the DTS Editor.

Any module must extend {@link com.apelon.apps.dts.editor.modules.DTSEditorModule} and implement its initModule method. When the initModule method is called the DTSEditorModule class obtains an instance of {@link com.apelon.apps.dts.editor.modules.DTSEditorModuleMgr}. A module uses its instance of DTSEditorModuleMgr to access various DTS Editor objects.

DTS Editor settings can be accessed using {@link com.apelon.apps.dts.editor.modules.DTSEditorConfig} obtained through the {@link com.apelon.apps.dts.editor.modules.DTSEditorModuleMgr#getDTSEditorConfig} method of DTSEditorModuleMgr.

A module may additionally set and get user defined settings through {@link com.apelon.apps.dts.editor.modules.DTSModuleConfig}. DTSEditorModule provides a method to designate an xml file used to maintain custom module settings. This file is used by DTSModuleConfig which provides the necessary accessor and mutator methods for maintaining these settings. DTSModuleConfig may be accessed using the {@link com.apelon.apps.dts.editor.modules.DTSEditorModule#getDTSModuleConfig} method defined in DTSEditorModule.

Package Specification

The DTS Editor will search packages for all classes that implement the DTSEditorModule class in the following order.

  1. modulePackageName1...n (as specified in dtseditor.xml file)
  2. com.apelon.modules.dts.editor
  3. com.apelon.modules.dts.editor.*

Related Documentation

For overviews, tutorials, examples, guides, and additional documentation, please see: