Package com.apelon.apps.dts.editor.modules

Provides the class and interfaces necessary for creating Plug-ins for the Apelon DTS Editor.

See:
          Description

Interface Summary
DTSEditorConfig Provides access to various DTS Editor configuration settings.
DTSEditorModuleMgr Provides access to necessary DTSEditor functions and DTS Services to use in DTS Editor modules.
DTSModuleConfig Defines the methods to access and save module specific properties.
 

Class Summary
DTSEditorModule This class should be extended to create a custom plug-in module for the Apelon DTS Editor.
 

Package com.apelon.apps.dts.editor.modules Description

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 DTSEditorModule and implement its initModule method. When the initModule method is called the DTSEditorModule class obtains an instance of DTSEditorModuleMgr. A module uses its instance of DTSEditorModuleMgr to access various DTS Editor objects.

DTS Editor settings can be accessed using DTSEditorConfig obtained through the DTSEditorModuleMgr.getDTSEditorConfig() method of DTSEditorModuleMgr.

A module may additionally set and get user defined settings through 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 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:



Copyright © 2011. All Rights Reserved.