MAEPlugin
Interface PluginStub

All Known Implementing Classes:

MAEPlugin

public interface PluginStub

Enforces method implementations in suport of MAEPlugin. Provides bean-like interface for the plugins. Created on September 6, 2001, 8:28 AM

This work was produced by Peter Lemkin of the National Cancer Institute, an agency of the United States Government. As a work of the United States Government there is no associated copyright. It is offered as open source software under the Mozilla Public License (version 1.1) subject to the limitations noted in the accompanying LEGAL file. This notice must be included with the code. The MAExplorer Mozilla and Legal files are available on http://maexplorer.sourceforge.net/.

Version:

$Date: 2003/03/03 16:21:29 $ / $Revision: 1.5 $

Author:

Jai Evans (DECA/CIT), C. Santos (DECA/CIT), P. Lemkin (NCI-FCRDC)

See Also:

MAExplorer Home

Field Summary

static float

PLUGIN_VERSION MAEPlugin version # for tracking

Method Summary

java.lang.String	getPluginDescription() getPluginDescription() - returns a human readable description of the Plugin.
java.lang.String	getPluginFileName() getPluginFileName() - returns the plugin file name without the ".jar"
java.lang.String	getPluginName() getPluginName() - returns the human readable name for use in labels.
void	menuActivated() menuActivated() - method called when menu is clicked for menu driven plugins.
void	pluginHalt() pluginHalt() - Plugin halt method.
void	pluginInit() pluginInit() - Plugin init method.
void	pluginMain() pluginMain() - this is the method end-users implement to use the API.

Field Detail

PLUGIN_VERSION

public static final float PLUGIN_VERSION

MAEPlugin version # for tracking

Method Detail

menuActivated

public void menuActivated()

menuActivated() - method called when menu is clicked for menu driven plugins.

pluginInit

public void pluginInit()

pluginInit() - Plugin init method. Code to initialize the plugin data structures etc. at load time goes here.

pluginHalt

public void pluginHalt()

pluginHalt() - Plugin halt method. Code to execute if plugin is disabled.

pluginMain

public void pluginMain()

pluginMain() - this is the method end-users implement to use the API.

getPluginName

public java.lang.String getPluginName()

getPluginName() - returns the human readable name for use in labels.

getPluginFileName

public java.lang.String getPluginFileName()

getPluginFileName() - returns the plugin file name without the ".jar"

getPluginDescription

public java.lang.String getPluginDescription()

getPluginDescription() - returns a human readable description of the Plugin.