|
Cytoscape 2.3.1 (c) 2004 ISB, MSKCC, UCSD | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcytoscape.plugin.CytoscapePlugin
A CytoscapePlugin is the new "Global" plugin. A CytoscapePlugin constructor
does not have any arguments, since it is Network agnostic. Instead all
access to the Cytoscape Data Structures is handled throught the static
methods provided by cytoscape.Cytoscape.
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.
Constructor Summary | |
CytoscapePlugin()
There are no arguments required or allowed in a CytoscapePlugin constructor. |
Method Summary | |
void |
activate()
If implemented, then this plugin will be activated after being initialized |
void |
deactivate()
If implemented then this plugin can remove itself from the Menu system, and anything else, when the user decides to deactivate it. |
String |
describe()
method returning a String description of the plugin. |
String |
getScriptName()
If this plugin is scriptable, then this will return a unique script name, that will come after the colon like: :name |
CyNetwork |
interpretScript(String[] args,
CyNetwork network)
Take a CyNetwork as input along with some arguments, and return a CyNetwork, which can be the same, or different, it doesn't really matter, and is up to the individual plugin. |
boolean |
isScriptable()
If true, this plugin is capable if accepting scripts, and we will find out what its script name is |
static boolean |
loadPlugin(Class pluginClass)
Attempts to instantiate a plugin of the class argument. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public CytoscapePlugin()
Method Detail |
public boolean isScriptable()
public String getScriptName()
public CyNetwork interpretScript(String[] args, CyNetwork network)
public void activate()
public void deactivate()
public String describe()
public static boolean loadPlugin(Class pluginClass)
|
www.cytoscape.org | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |