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 Logger cat
          Define a static log4j category variable for ArgoUML configuration.
static java.lang.String MODULEFILENAME
           
static java.lang.String MODULEFILENAME_ALTERNATE
           
 
Method Summary
 java.lang.String getModuleAuthor()
           
 java.lang.String getModuleDescription()
          Textual description of the module.
 java.lang.String getModuleKey()
           
 java.lang.String getModuleName()
          Display name of the module.
 java.util.Vector getModulePopUpActions(java.util.Vector popUpActions, java.lang.Object context)
           
 java.lang.String getModuleVersion()
           
 boolean initializeModule()
           
 boolean isModuleEnabled()
           
 void setModuleEnabled(boolean tf)
           
 boolean shutdownModule()
           
 

Field Detail

cat

public static final Logger cat
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()

shutdownModule

public boolean shutdownModule()

setModuleEnabled

public void setModuleEnabled(boolean tf)

isModuleEnabled

public boolean isModuleEnabled()

getModuleName

public java.lang.String getModuleName()
Display name of the module.


getModuleDescription

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


getModuleVersion

public java.lang.String getModuleVersion()

getModuleAuthor

public java.lang.String getModuleAuthor()

getModulePopUpActions

public java.util.Vector getModulePopUpActions(java.util.Vector popUpActions,
                                              java.lang.Object context)

getModuleKey

public java.lang.String getModuleKey()


ArgoUML © 1996-2003 (20040229)ArgoUML Project HomeArgoUML Cookbook