org.argouml.application.api
Interface ArgoModule

All Known Subinterfaces:
ArgoSingletonModule, Pluggable, PluggableAboutTab, PluggableDiagram, PluggableImport, PluggableMenu, PluggableNotation, PluggablePropertyPanel, PluggableResourceBundle, PluggableSettingsTab
All Known Implementing Classes:
ActionExportXMI, DiagramHelper, FileImportSupport, Generator2, ModuleHelper, ResourceBundleHelper, SettingsTabHelper

public interface ArgoModule

Interface that defines the characteristics of an external module usable by Argo.

Since:
0.9.4

Field Summary
static String MODULEFILENAME
          External modules are supposed to be located at MODULEFILENAME.
static String MODULEFILENAME_ALTERNATE
          Or, alternatively, external modules may be located at MODULEFILENAME_ALTERNATE.
 
Method Summary
 String getModuleAuthor()
          The module author.
 String getModuleDescription()
          Textual description of the module.
 String getModuleKey()
          The module identifying key.
 String getModuleName()
          Display name of the module.
 Vector getModulePopUpActions(Vector popUpActions, Object context)
          Calls all modules to let them add to a popup menu.
 String getModuleVersion()
          The module version.
 boolean initializeModule()
          Method called when Argo is loading a module.
 boolean isModuleEnabled()
          Allows determination if a module is enabled or disabled.
 void setModuleEnabled(boolean tf)
          Called to enable or disable a module programmatically.
 boolean shutdownModule()
          Method called when Argo is unloading a module.
 

Field Detail

MODULEFILENAME

public static final String MODULEFILENAME
External modules are supposed to be located at MODULEFILENAME.

See Also:
Constant Field Values

MODULEFILENAME_ALTERNATE

public static final String MODULEFILENAME_ALTERNATE
Or, alternatively, external modules may be located at MODULEFILENAME_ALTERNATE.

See Also:
Constant Field Values
Method Detail

initializeModule

public boolean initializeModule()
Method called when Argo is loading a module.

Returns:
true if the module initialized properly.

shutdownModule

public boolean shutdownModule()
Method called when Argo is unloading a module.

Returns:
true if the module terminated properly.

setModuleEnabled

public void setModuleEnabled(boolean tf)
Called to enable or disable a module programmatically.

Parameters:
tf - true to enable module, false to disable

isModuleEnabled

public boolean isModuleEnabled()
Allows determination if a module is enabled or disabled.

Returns:
true if the module is enabled, otherwise false

getModuleName

public String getModuleName()
Display name of the module.

Returns:
the module name

getModuleDescription

public String getModuleDescription()
Textual description of the module.

Returns:
the module description

getModuleVersion

public String getModuleVersion()
The module version. There is no specified format.

Returns:
a string containing the module version

getModuleAuthor

public String getModuleAuthor()
The module author.

Returns:
a string containing the module author

getModulePopUpActions

public Vector getModulePopUpActions(Vector popUpActions,
                                    Object context)
Calls all modules to let them add to a popup menu.

Parameters:
popUpActions - Vector of actions
context - which the actions are valid for
Returns:
Vector containing pop-up actions

getModuleKey

public String getModuleKey()
The module identifying key.

Returns:
the string key the module uses to identify itself


ArgoUML © 1996-2004 (20050222)ArgoUML HomepageArgoUML Developers' pageArgoUML Cookbook