Cytoscape 2.2 (c) 2004 ISB, MSKCC, UCSD

cytoscape.plugin
Class AbstractPlugin

java.lang.Object
  extended bycytoscape.plugin.AbstractPlugin

Deprecated. This class relies on CyWindow, which has been deprecated. Instead, use CytoscapePlugin
AbstractPlugin is the class that all Cytoscape plugins must subclass. The plugin should provide a one-argument constructor where the argument is an instance of CyWindow.

It is encouraged, but not mandatory, for plugins to override the describe method to state what the plugin does and how it should be used.

public abstract class AbstractPlugin
extends Object


Constructor Summary
AbstractPlugin()
          Deprecated. this method's presence is superfluous; it is only here so that you don't have to call super(cytoscapeWindow) in your ctor.
AbstractPlugin(cytoscape.view.CyWindow cyWindow)
          Deprecated. Standard constructor with a single CyWindow argument.
 
Method Summary
 String describe()
          Deprecated. method returning a String description of the plugin.
static boolean loadPlugin(Class pluginClass, cytoscape.view.CyWindow cyWindow)
          Deprecated. Attempts to instantiate a plugin of the class defined by the first argument.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AbstractPlugin

public AbstractPlugin()
Deprecated. 
this method's presence is superfluous; it is only here so that you don't have to call super(cytoscapeWindow) in your ctor.


AbstractPlugin

public AbstractPlugin(cytoscape.view.CyWindow cyWindow)
Deprecated. 
Standard constructor with a single CyWindow argument.

Method Detail

describe

public String describe()
Deprecated. 
method returning a String description of the plugin.


loadPlugin

public static boolean loadPlugin(Class pluginClass,
                                 cytoscape.view.CyWindow cyWindow)
Deprecated. 
Attempts to instantiate a plugin of the class defined by the first argument. The other arguments to this method are used as possible arguments for the plugin constructor. This method searches for a constructor of a known type in the plugin class and then attempts to use that constructor to create an instance of the plugin. Currently the only plugin constructor recognized has one argument which is a CytoscapeWindow.

Returns:
true if the plugin was successfulyl constructed, false otherwise

www.cytoscape.org