|
jrworkspace by jTEM |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectde.jtem.jrworkspace.plugin.Plugin
public abstract class Plugin
The base class for all plug-ins of the jRWorkspace plug-in mechanism.
The order of calls in the life cycle of a plug-in is
1. - restoreStates(Controller)
2. - install(Controller)
3. - uninstall(Controller)
4. - storeStates(Controller)
getPluginInfo()
to return a
descriptive PluginInfo
. This method is called in the constructor of this class and must not
return null
.
Constructor Summary | |
---|---|
Plugin()
|
Method Summary | |
---|---|
boolean |
equals(Object obj)
A plug-in is unique throughout the controller so the equals method compares the classes |
PluginInfo |
getPluginInfo()
Returns an instance of PluginInfo |
int |
hashCode()
This method simply returns getClass().hashCode() |
void |
install(Controller c)
Is called when the plug-in is installed |
void |
restoreStates(Controller c)
Is called before the installation of this plug-in. |
void |
storeStates(Controller c)
Is called after this plug-in has been uninstalled. |
String |
toString()
Returns this plug-ins name or "No Name" if name is null |
void |
uninstall(Controller c)
Id called when this plug-in is about to be uninstalled |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public Plugin()
Method Detail |
---|
public boolean equals(Object obj)
equals
in class Object
public PluginInfo getPluginInfo()
PluginInfo
PluginInfo}
public int hashCode()
hashCode
in class Object
equals
public void install(Controller c) throws Exception
c
- the applications Controller
Exception
Controller}
public void restoreStates(Controller c) throws Exception
Controller.getProperty(Class, String, Object)
on the controller provided
as argument.
c
- this applications Controller
Exception
Controller}
public void storeStates(Controller c) throws Exception
Controller.storeProperty(Class, String, Object)
on the controller provided
as argument.
cthis
- applications Controller
Exception
Controller}
public String toString()
toString
in class Object
public void uninstall(Controller c) throws Exception
c
- this applications Controller
Exception
Controller}
|
jrworkspace by jTEM |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |