MAEPlugin
Class CheckBoxMenuPlugin

java.lang.Object
  |
  +--MAEPlugin.MAEPlugin
        |
        +--MAEPlugin.CheckBoxMenuPlugin

All Implemented Interfaces:

java.util.EventListener, java.awt.event.ItemListener, PluginStub

Direct Known Subclasses:

AnalysisPlugin

public abstract class CheckBoxMenuPlugin

extends MAEPlugin

implements java.awt.event.ItemListener

This class extends the MAEPlugin base class to implement a CheckBoxMenuPlugin base class. Created on September 10, 2001, 7:59 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:31 $ / $Revision: 1.5 $

Author:

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

See Also:

MAExplorer Home

Fields inherited from class MAEPlugin.MAEPlugin

DBUG_MAEP, jarResources, registryMaxSize

Fields inherited from interface MAEPlugin.PluginStub

PLUGIN_VERSION

Constructor Summary

CheckBoxMenuPlugin()
CheckBoxMenuPlugin() - constuctor to use default "CheckBoxPlugin" label name

CheckBoxMenuPlugin(java.lang.String label)
CheckBoxMenuPlugin() - constuctor with user supplied label

CheckBoxMenuPlugin(java.lang.String menuLabel, java.lang.String pluginFileName)
CheckBoxMenuPlugin() - constuctor with user supplied label and plugin filename

Method Summary

boolean	getState() getState() - utility to get the checkbox state
void	itemStateChanged(java.awt.event.ItemEvent e) itemStateChanged() - implements ItemListener for checkbox change
abstract void	pluginMain() pluginMain() - abstract the method end-users implement to use the API
void	setState(boolean b) setState() - utility to set the checkbox state

Methods inherited from class MAEPlugin.MAEPlugin

getFlag, getInstance, getMAEStub, getMenuHook, getMenuInsertionPointName, getMenuItem, getNumberPlugins, getPluginDescription, getPluginFileName, getPluginName, getPlugins, menuActivated, pluginHalt, pluginInit, removePlugin, setFlag, setJarResources, setMAEStub, setMenuHook, setMenuInsertionPointName, setMenuItem, setMenuLabel

Methods inherited from class java.lang.Object

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

Constructor Detail

CheckBoxMenuPlugin

public CheckBoxMenuPlugin(java.lang.String label)

CheckBoxMenuPlugin() - constuctor with user supplied label

CheckBoxMenuPlugin

public CheckBoxMenuPlugin(java.lang.String menuLabel,
                          java.lang.String pluginFileName)

CheckBoxMenuPlugin() - constuctor with user supplied label and plugin filename

Parameters:

menuLabel - is the name of the plugin for the menu entry.

pluginFileName - name of the plugin without the ".jar"

CheckBoxMenuPlugin

public CheckBoxMenuPlugin()

CheckBoxMenuPlugin() - constuctor to use default "CheckBoxPlugin" label name

Method Detail

itemStateChanged

public void itemStateChanged(java.awt.event.ItemEvent e)

itemStateChanged() - implements ItemListener for checkbox change

Specified by:

itemStateChanged in interface java.awt.event.ItemListener

setState

public void setState(boolean b)

setState() - utility to set the checkbox state

getState

public boolean getState()

getState() - utility to get the checkbox state

pluginMain

public abstract void pluginMain()

pluginMain() - abstract the method end-users implement to use the API

Overrides:

pluginMain in class MAEPlugin