org.argouml.application.api
Interface ArgoModule

All Known Subinterfaces:
ArgoSingletonModule, Pluggable, PluggableAboutTab, PluggableCritic, PluggableDiagram, PluggableImport, PluggableMenu, PluggableModule, PluggableNotation, PluggableProjectReader, PluggableProjectWriter, PluggablePropertyPanel, PluggableResourceBundle, PluggableSettingsTab
All Known Implementing Classes:
ActionExportXMI, DiagramHelper, FileImportSupport, Generator, ModuleHelper, PropPanelModel, PropPanelSubsystem, ResourceBundleHelper, SettingsTabHelper

public interface ArgoModule

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

Since:
0.9.4

Field Summary
static org.apache.log4j.Logger cat
          Deprecated. by Linus Tolke as of 0.15.4. Use your own logger in your class. This will be removed.
static java.lang.String MODULEFILENAME
           
static java.lang.String MODULEFILENAME_ALTERNATE
           
 
Method Summary
 java.lang.String getModuleAuthor()
          The module author.
 java.lang.String getModuleDescription()
          Textual description of the module.
 java.lang.String getModuleKey()
          The module identifying key
 java.lang.String getModuleName()
          Display name of the module.
 java.util.Vector getModulePopUpActions(java.util.Vector popUpActions, java.lang.Object context)
          Calls all modules to let them add to a popup menu.
 java.lang.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

cat

public static final org.apache.log4j.Logger cat
Deprecated. by Linus Tolke as of 0.15.4. Use your own logger in your class. This will be removed.

Define a static log4j category variable for ArgoUML configuration.


MODULEFILENAME

public static final java.lang.String MODULEFILENAME
See Also:
Constant Field Values

MODULEFILENAME_ALTERNATE

public static final java.lang.String 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 java.lang.String getModuleName()
Display name of the module.

Returns:
the module name

getModuleDescription

public java.lang.String getModuleDescription()
Textual description of the module.

Returns:
the module description

getModuleVersion

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

Returns:
a string containing the module version

getModuleAuthor

public java.lang.String getModuleAuthor()
The module author.

Returns:
a string containing the module author

getModulePopUpActions

public java.util.Vector getModulePopUpActions(java.util.Vector popUpActions,
                                              java.lang.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

getModuleKey

public java.lang.String getModuleKey()
The module identifying key

Returns:
the string key the module uses to identify itself


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