Documentation Center

Creating a Custom Module

You create a custom module to modify the behavior of an adapter by overriding callbacks defined in the base custom adapter.

The goal of writing the custom module is to modify the behavior of the adapter by overriding callbacks defined in the base custom adapter; either CustomGetDocDefault.pm or CustomPutDocDefault.pm. There are some custom modules delivered that modify the behavior. There is at least one pair of custom modules for each of the editor tools, EpicEdit, XmetalEdit, and FrameEdit. Often it is best to create a custom module that inherits from one of these custom modules however be aware that these custom modules only override a subset of the subroutines defined in the base modules.

You can override any of these and or any of the other subroutines defined in the base module. In some cases if you want to override a subroutine and call the super class' version somewhere in your new version of the subroutine so that you do not lose the behavior of the original, just augment it.

Note that it is the package defined within the module that forms the class. The filename of the module ends with the extension .pm but, otherwise the case and spelling are identical to the package name defined within the file. Strictly speaking, the package you write in your custom module inherits from an existing package in a delivered custom module.