org.argouml.application.api
Interface ArgoSingletonModule

All Superinterfaces:
ArgoModule

public interface ArgoSingletonModule
extends ArgoModule

An interface which identifies an ArgoUML plug-in which behaves as a singleton, but may be swapped with another plugin singleton of the same type. Only one singleton module can be considered active at the same time.

Since:
0.9.4

Field Summary
 
Fields inherited from interface org.argouml.application.api.ArgoModule
cat, MODULEFILENAME, MODULEFILENAME_ALTERNATE
 
Method Summary
 void activateSingleton()
          Callback by which the singleton being activated is notified that it is being activated.
 boolean canActivateSingleton()
          Allows verification that the current singleton can be activated.
 boolean canDeactivateSingleton()
          Allows verification that the current singleton can be deactivated.
 void deactivateSingleton()
          Callback by which the active singleton is notified that it is being deactivated.
 java.lang.Class getSingletonType()
           
 
Methods inherited from interface org.argouml.application.api.ArgoModule
getModuleAuthor, getModuleDescription, getModuleKey, getModuleName, getModulePopUpActions, getModuleVersion, initializeModule, isModuleEnabled, setModuleEnabled, shutdownModule
 

Method Detail

canActivateSingleton

public boolean canActivateSingleton()
Allows verification that the current singleton can be activated. This is useful for determining menu entry availability, among other things.


canDeactivateSingleton

public boolean canDeactivateSingleton()
Allows verification that the current singleton can be deactivated. This is useful for determining menu entry availability, among other things.


deactivateSingleton

public void deactivateSingleton()
Callback by which the active singleton is notified that it is being deactivated. This is called prior to calling activateSingleton() on the new singleton. After the call to deactivateSingleton() and before the call to activateSingleton(), the previously active singleton is considered to be the active singleton even though it is not marked as active.


activateSingleton

public void activateSingleton()
Callback by which the singleton being activated is notified that it is being activated. This is called after calling deactivateSingleton() on the previous singleton.


getSingletonType

public java.lang.Class getSingletonType()


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