edu.bonn.xulu.appl
Class AbstractXuluPlugin

java.lang.Object
  extended by AbstractNamedObject
      extended by edu.bonn.xulu.appl.AbstractXuluPlugin
All Implemented Interfaces:
XuluPlugin
Direct Known Subclasses:
AbstractMenuPlugin, SimpleConsoleMonitor, TestPlugin

public abstract class AbstractXuluPlugin
extends AbstractNamedObject
implements XuluPlugin

Diese Klasse stellt eine Basis-Implementierung von XuluPlugin dar. Unterklassen muessen lediglich noch die XuluPlugin.execute(XuluModellingPlatform)-Methode implementieren und darin das started-Flag pruefen, damit das Plugin beendet werden kann.

Version:
1.0
Author:
Martin Schmitz (University of Bonn/Germany)

Field Summary
protected  XuluModellingPlatform appl
          Speichert, ob die Xulu-Instanz, in der das Plugin ausgefuehrt wird.
protected  boolean hasGUI
          Speichert, ob die Plugin eine GUI besitzt.
protected  boolean started
          Speichert, ob das Plugin gestartet ist oder nicht.
protected  boolean visible
          Speichert, ob die Plugin-GUI angezeigt wird.
 
Constructor Summary
AbstractXuluPlugin(boolean hasGUI)
          Erzeugt eine neue Plugin-Instanz.
 
Method Summary
 void execute(XuluModellingPlatform appl)
          Startet die Ausfuehrung des Plugins.
 boolean isStarted()
          Prueft, ob das Plugin gestartet ist.
 boolean isVisible()
          Prueft, ob die Plugin-GUI angezeigt wird.
 void setVisible(boolean visible)
          Zeigt die Plugin-GUI an oder verbirgt sie.
 void stop()
          Stoppt die Ausfuehrung des Plugins.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

started

protected boolean started
Speichert, ob das Plugin gestartet ist oder nicht.


visible

protected boolean visible
Speichert, ob die Plugin-GUI angezeigt wird.


hasGUI

protected boolean hasGUI
Speichert, ob die Plugin eine GUI besitzt.


appl

protected XuluModellingPlatform appl
Speichert, ob die Xulu-Instanz, in der das Plugin ausgefuehrt wird.

Constructor Detail

AbstractXuluPlugin

public AbstractXuluPlugin(boolean hasGUI)
Erzeugt eine neue Plugin-Instanz.

Parameters:
hasGUI - gibt an, ob das Plugin eine GUI besitzt.
Method Detail

execute

public void execute(XuluModellingPlatform appl)
Startet die Ausfuehrung des Plugins. Diese Basis-Implementierung speichert lediglich die Xulu-Instanz in der globalen Variable appl. Unterklassen muessen diese Methode ueberschreiben und die super.execute(.)-Methode aufrufen.

Specified by:
execute in interface XuluPlugin
Parameters:
appl - Instanz der Xulu-Applikation

stop

public void stop()
Stoppt die Ausfuehrung des Plugins. Diese Basis-Implementierung setzt lediglich das started-Flag auf false.

Specified by:
stop in interface XuluPlugin

isStarted

public boolean isStarted()
Prueft, ob das Plugin gestartet ist.

Specified by:
isStarted in interface XuluPlugin
Returns:
Wert des started-Flag

isVisible

public boolean isVisible()
Prueft, ob die Plugin-GUI angezeigt wird.

Specified by:
isVisible in interface XuluPlugin
Returns:
Wert des visible-Flag

setVisible

public void setVisible(boolean visible)
Zeigt die Plugin-GUI an oder verbirgt sie. Diese Basis-Implementierung setzt lediglich das Flag #visible. Macht nichts, wenn das Plugin keine GUI besitzt.

Specified by:
setVisible in interface XuluPlugin