chargerplugin

Class CraftModulePlugin

Object

chargerplugin.ModulePlugin

chargerplugin.CraftModulePlugin

public class CraftModulePlugin
extends ModulePlugin

The plugin hooks for the CRAFT module.

Author:

Harry S. Delugach (delugach@uah.edu)

Field Summary

Fields inherited from class chargerplugin.ModulePlugin

moduleProperties

Constructor Summary

Constructors

Constructor and Description
CraftModulePlugin()

Method Summary

Modifier and Type	Method and Description
void	activate() Called whenever the module is selected but is already running
String	getDisplayName() Return the simple name of this module.
String	getInfo() Return any other information about the module, such as copyright, purpose, etc.
KeyStroke	getKeyStroke() Get the accelerator key combination needed for the menu.
JPanel	getPropertiesPanel() Access the properties panel for this module, suitable for adding as a tab in the main Preferences window.
void	saveProperties() Saves the module's built-in properties as returned by getProperties().
void	setProperties(Properties props) Set the module's properties directly.
void	shutdown() Perform whatever cleanup and finalizing necessary.
void	startup(ModulePlugin module) Launch this module, attaching it to Charger.

Methods inherited from class chargerplugin.ModulePlugin

getModulePropertiesFile, getProperties

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CraftModulePlugin

public CraftModulePlugin()

Method Detail

getDisplayName

public String getDisplayName()

Description copied from class: ModulePlugin

Return the simple name of this module. Will appear on standard out and serves as the label in the Tools menu.

Specified by:

getDisplayName in class ModulePlugin

getKeyStroke

public KeyStroke getKeyStroke()

Description copied from class: ModulePlugin

Get the accelerator key combination needed for the menu. May be null if no keystroke is desired.

Specified by:

getKeyStroke in class ModulePlugin

getInfo

public String getInfo()

Description copied from class: ModulePlugin

Return any other information about the module, such as copyright, purpose, etc.

Specified by:

getInfo in class ModulePlugin

startup

public void startup(ModulePlugin module)

Description copied from class: ModulePlugin

Launch this module, attaching it to Charger. If module is already running, then a call to startup will be replaced by a call to activate.

Specified by:

startup in class ModulePlugin

activate

public void activate()

Description copied from class: ModulePlugin

Called whenever the module is selected but is already running

Specified by:

activate in class ModulePlugin

shutdown

public void shutdown()

Description copied from class: ModulePlugin

Perform whatever cleanup and finalizing necessary. Called automatically when Charger exits.

Specified by:

shutdown in class ModulePlugin

getPropertiesPanel

public JPanel getPropertiesPanel()

Description copied from class: ModulePlugin

Access the properties panel for this module, suitable for adding as a tab in the main Preferences window. If no properties panel is desired, then return null;

Specified by:

getPropertiesPanel in class ModulePlugin

Returns:

setProperties

public void setProperties(Properties props)

Description copied from class: ModulePlugin

Set the module's properties directly.

Overrides:

setProperties in class ModulePlugin

saveProperties

public void saveProperties()

Description copied from class: ModulePlugin

Saves the module's built-in properties as returned by getProperties(). The built-in properties are a general facility for keeping configuration information on a module. This is for the module writer's convenience -- it is always allowed for the module to create/modify its own files whenever desired. It is recommended that any sub-class overriding this method should also call this super-class method. Called automatically when Charger exits, if the module is still activated.

Overrides:

saveProperties in class ModulePlugin