ModuleHelper (ArgoUML Javadoc for internal use)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.argouml.application.helpers
Class ModuleHelper

java.lang.Object
  org.argouml.application.helpers.ModuleHelper

All Implemented Interfaces:: ArgoModule

Deprecated. by Linus Tolke (0.21.1 March 2006). I can't find that this class is ever used. If that is the case it is better to remove it then to update it for the new ModuleLoader.

public abstract class ModuleHelper
extends Object
implements ArgoModule

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

Field Summary

Fields inherited from interface org.argouml.application.api.ArgoModule

MODULEFILENAME, MODULEFILENAME_ALTERNATE

Constructor Summary
`ModuleHelper()` Deprecated. The constructor.

Method Summary
`Vector`	`getModulePopUpActions(Vector v, Object o)` Deprecated. Calls all modules to let them add to a popup menu.
`boolean`	`isModuleEnabled()` Deprecated. Allows determination if a module is enabled or disabled.
`void`	`setModuleEnabled(boolean e)` Deprecated. 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

Constructor Detail

ModuleHelper

public ModuleHelper()

Deprecated.

The constructor.

Method Detail

isModuleEnabled

public boolean isModuleEnabled()

Deprecated.

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)

Deprecated.

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)

Deprecated.

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)