org.argouml.application.helpers
Class ModuleHelper

java.lang.Object
  extended byorg.argouml.application.helpers.ModuleHelper
All Implemented Interfaces:
ArgoModule

public abstract class ModuleHelper
extends Object
implements ArgoModule

This class serves as a template of modules external to ArgoUML.


Field Summary
private  boolean enabled
           
 
Fields inherited from interface org.argouml.application.api.ArgoModule
MODULEFILENAME, MODULEFILENAME_ALTERNATE
 
Constructor Summary
ModuleHelper()
          The constructor.
 
Method Summary
 Vector getModulePopUpActions(Vector v, Object o)
          Calls all modules to let them add to a popup menu.
 boolean isModuleEnabled()
          Allows determination if a module is enabled or disabled.
 void setModuleEnabled(boolean e)
          Called to enable or disable a module programmatically.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.argouml.application.api.ArgoModule
getModuleAuthor, getModuleDescription, getModuleKey, getModuleName, getModuleVersion, initializeModule, shutdownModule
 

Field Detail

enabled

private boolean enabled
Constructor Detail

ModuleHelper

public ModuleHelper()
The constructor.

Method Detail

isModuleEnabled

public boolean isModuleEnabled()
Description copied from interface: ArgoModule
Allows determination if a module is enabled or disabled.

Specified by:
isModuleEnabled in interface ArgoModule
Returns:
true if the module is enabled, otherwise false
See Also:
ArgoModule.isModuleEnabled()

setModuleEnabled

public void setModuleEnabled(boolean e)
Description copied from interface: ArgoModule
Called to enable or disable a module programmatically.

Specified by:
setModuleEnabled in interface ArgoModule
Parameters:
e - true to enable module, false to disable
See Also:
ArgoModule.setModuleEnabled(boolean)

getModulePopUpActions

public Vector getModulePopUpActions(Vector v,
                                    Object o)
Description copied from interface: ArgoModule
Calls all modules to let them add to a popup menu.

Specified by:
getModulePopUpActions in interface ArgoModule
Parameters:
v - Vector of actions
o - which the actions are valid for
Returns:
Vector containing pop-up actions
See Also:
ArgoModule.getModulePopUpActions( java.util.Vector, java.lang.Object)


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