Package de.bsvrz.pat.sysbed.plugins.api
Interface ExternalModule
-
- All Known Implementing Classes:
ArchiveInfoModule
,ConfigurationDataModule
,DataAvailibilityModule
,DatGenModule
,ExternalModuleAdapter
,ExternalProcessModule
,OnlineProtocolModule
,OnlineTableModule
,ParameterEditorModule
,SendCurrentDataModule
,ShowCurrentDataModule
,ShowSubscriptionInfo
,StreamBasedArchiveRequestModule
,SystemProtocolModule
public interface ExternalModule
Das Interface ermöglicht das Hinzufügen von Modulen zu einerApplikation
.Ein Modul erhält durch eine Vorauswahl eine Datenidentifikation (bestehend aus Objekttypen, Attributgruppen, Aspekte und Objekte). Ist die Datenidentifikation für das Modul
gültig
, dann kann esgestartet
werden.
Zur Beschriftung eines Buttons für das Modul kann die MethodegetButtonText()
verwendet werden. Soll ein Tooltip angegeben werden, der die Anforderungen an die Datenidentifikation des Moduls ausgibt, dann istgetTooltipText()
zu verwenden.Einige der Methoden dieses Interfaces wurden bereits in einem
Adapter
implementiert.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
change(SettingsData settingsData)
Diese Methode dient dazu bereits gespeicherte Einstellungen zu ändern, indem der Dialog des Moduls aufgerufen wird.java.lang.String
getButtonText()
Damit der Button (oder eine andere Komponente), mit der das Modul gestartet wird, einen zum Modul passenden Text erhält, wird dieser übergeben.java.lang.String
getModuleName()
Mit dieser Methode wird der Name des Moduls abgefragt.java.lang.String
getTooltipText()
Ein Tooltip, welcher beschreibt, was für eine Datenidentifikation dieses Modul benötigt, kann hier übergeben werden.boolean
isPreselectionValid(SettingsData settingsData)
Diese Methode prüft, ob die Auswahl der Datenidentifikation den Anforderungen des Moduls entspricht.void
setApplication(ApplicationInterface application)
Es wird einmal einApplikationsobjekt
an das Modul übergeben, damit das Modul auf die Methoden desApplicationInterfaces
zugreifen kann.void
startModule(SettingsData settingsData)
Diese Methode wird von der Applikation aufgerufen, wenn der Button (oder eine andere Komponente), die dieses Modul repräsentiert, betätigt wird.void
startSettings(SettingsData settingsData)
Sind die Einstellungen des Dialogs eines Moduls bekannt, kann das Modul direkt gestartet werden.
-
-
-
Method Detail
-
getModuleName
java.lang.String getModuleName()
Mit dieser Methode wird der Name des Moduls abgefragt. Er wird u.a. dafür benötigt, bei der Auflistung gespeicherter Einstellungen dem Anwender mitzuteilen, welches Modul sich hinter den Einstellungen verbirgt.- Returns:
- der Name des Moduls
-
getButtonText
java.lang.String getButtonText()
Damit der Button (oder eine andere Komponente), mit der das Modul gestartet wird, einen zum Modul passenden Text erhält, wird dieser übergeben.- Returns:
- der Text des Buttons
-
getTooltipText
java.lang.String getTooltipText()
Ein Tooltip, welcher beschreibt, was für eine Datenidentifikation dieses Modul benötigt, kann hier übergeben werden. Dieser Tooltip wird bei dem Button (oder einer anderen Komponente), die dieses Modul startet, angezeigt.- Returns:
- Text des Tooltips
-
startModule
void startModule(SettingsData settingsData)
Diese Methode wird von der Applikation aufgerufen, wenn der Button (oder eine andere Komponente), die dieses Modul repräsentiert, betätigt wird. Ggf. wird ein dem Modul zugehörender Dialog aufgerufen, damit weitere Einstellungen, neben der übergebenen Datenidentifikation vorgenommen werden können.- Parameters:
settingsData
- enthält die ausgewählte Datenidentifikation
-
startSettings
void startSettings(SettingsData settingsData)
Sind die Einstellungen des Dialogs eines Moduls bekannt, kann das Modul direkt gestartet werden. Die Methode wird durch den "Starten"-Button aufgerufen, der sich auf dem Panel befindet, wo die gespeicherten Einstellungen dargestellt werden.- Parameters:
settingsData
- enthält die ausgewählte Datenidentifikation
-
change
void change(SettingsData settingsData)
Diese Methode dient dazu bereits gespeicherte Einstellungen zu ändern, indem der Dialog des Moduls aufgerufen wird. Wird auf dem Panel, wo die gespeicherten Einstellungen dargestellt werden eine Einstellung ausgewählt und der "Ändern"-Button betätigt, dann wird diese Methode aufgerufen.- Parameters:
settingsData
- enthält die ausgewählte Datenidentifikation
-
isPreselectionValid
boolean isPreselectionValid(SettingsData settingsData)
Diese Methode prüft, ob die Auswahl der Datenidentifikation den Anforderungen des Moduls entspricht.- Parameters:
settingsData
- die Einstellungsdaten mit der Datenidentifikation- Returns:
- gibt zurück, ob die Auswahl der Datenidentifikation den Anforderungen des Moduls entspricht.
-
setApplication
void setApplication(ApplicationInterface application)
Es wird einmal einApplikationsobjekt
an das Modul übergeben, damit das Modul auf die Methoden desApplicationInterfaces
zugreifen kann. Diese Methode wurde bereits imExternalModuleAdapter
implementiert.- Parameters:
application
- die Applikation
-
-