public interface ExternalModule
Das Interface ermöglicht das Hinzufügen von Modulen zu einer Applikation
.
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 es gestartet
werden.
Zur Beschriftung eines Buttons für das Modul kann die Methode getButtonText()
verwendet werden. Soll ein Tooltip angegeben werden, der die Anforderungen an die Datenidentifikation des Moduls ausgibt, dann ist getTooltipText()
zu verwenden.
Einige der Methoden dieses Interfaces wurden bereits in einem Adapter
implementiert.
Modifier and Type | Method and 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 ein
Applikationsobjekt an das Modul übergeben, damit das Modul auf die Methoden des ApplicationInterfaces 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.
|
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.
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 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.
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.
settingsData
- enthält die ausgewählte Datenidentifikationvoid 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.
settingsData
- enthält die ausgewählte Datenidentifikationvoid 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.
settingsData
- enthält die ausgewählte Datenidentifikationboolean isPreselectionValid(SettingsData settingsData)
Diese Methode prüft, ob die Auswahl der Datenidentifikation den Anforderungen des Moduls entspricht.
settingsData
- die Einstellungsdaten mit der Datenidentifikationvoid setApplication(ApplicationInterface application)
Es wird einmal ein Applikationsobjekt
an das Modul übergeben, damit das Modul auf die Methoden des ApplicationInterfaces
zugreifen kann. Diese Methode wurde bereits im ExternalModuleAdapter
implementiert.
application
- die Applikation