org.argouml.application.api
Interface ArgoModule

All Known Subinterfaces:

ArgoSingletonModule, Pluggable, PluggableAboutTab, PluggableDiagram, PluggableImport, PluggableMenu, PluggableNotation, PluggablePropertyPanel, PluggableResourceBundle, PluggableSettingsTab

All Known Implementing Classes:

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

MODULEFILENAME

public static final String MODULEFILENAME

Deprecated. 

External modules are supposed to be located at MODULEFILENAME.

See Also:

Constant Field Values

MODULEFILENAME_ALTERNATE

public static final String MODULEFILENAME_ALTERNATE

Deprecated. 

Or, alternatively, external modules may be located at MODULEFILENAME_ALTERNATE.

See Also:

Constant Field Values

initializeModule

public boolean initializeModule()

Deprecated. 

Method called when Argo is loading a module.

Returns:

true if the module initialized properly.

shutdownModule

public boolean shutdownModule()

Deprecated. 

Method called when Argo is unloading a module.

Returns:

true if the module terminated properly.

setModuleEnabled

public void setModuleEnabled(boolean tf)

Deprecated. 

Called to enable or disable a module programmatically.

Parameters:

tf - true to enable module, false to disable

isModuleEnabled

public boolean isModuleEnabled()

Deprecated. 

Allows determination if a module is enabled or disabled.

Returns:

true if the module is enabled, otherwise false

getModuleName

public String getModuleName()

Deprecated. 

Display name of the module.

Returns:

the module name

getModuleDescription

public String getModuleDescription()

Deprecated. 

Textual description of the module.

Returns:

the module description

getModuleVersion

public String getModuleVersion()

Deprecated. 

The module version. There is no specified format.

Returns:

a string containing the module version

getModuleAuthor

public String getModuleAuthor()

Deprecated. 

The module author.

Returns:

a string containing the module author

getModulePopUpActions

public Vector getModulePopUpActions(Vector popUpActions,
                                    Object context)

Deprecated. 

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()

Deprecated. 

The module identifying key.

Returns:

the string key the module uses to identify itself