FileDocCategorySizeDatePackage
Script.javaAPI DocExample2244Tue Dec 08 01:21:00 GMT 1998oisoft.togetherx.scriptapi

Script

public interface Script
The Script interface defines the basic functionality for Together/J 2.0 scripts. Each Together script should be a Java class being declared in the oisoft.togetherx.scripts package and implementing the Script interface. The implementing class must define the method 'doIt()' All the classes of the oisoft.togetherx.scripts package are listed in the "Open script..." dialog. That's why we recommend you to create auxiliary classes, that are not scripts, in subpackages.
Naming convention: Use underscore ('_') symbol as word separator in the class name. It is represented as space in the "Open script" dialog. For example, if you declare a class:
public class Write_RTF_Class_Diagrams_Documentation implements Script...
then in the dialog it will look like:
Write RTF Class Diagrams Documentation
version
2.1.01 12.03.1998
author
Andrei Ivanov
see
APIManager
see
#doIt
see
ScriptResources

Fields Summary
Constructors Summary
Methods Summary
public voiddoIt(APIManager apiManager)
Executing a script is just a call of the method 'doIt' of the object that implements the Script interface.

param
apiManager is a reference to all API interfaces. Contains common utility functions.
see
APIManager