IPluginClientDashboard

Geändert am Mo, 9 Jan, 2023 um 3:27 NACHMITTAGS

Schnittstelle IPluginClientDashboard

Die Schnittstelle für Client-Dashboard-Plugins. Mit dieser Art von Plugin können Sie dem System eine benutzerdefinierte Dashboard-Seite hinzufügen. Es ist möglich, mehrere Dashboard-Plugins gleichzeitig zu installieren. Für jede Rolle kann ein Administrator entweder das Standard-Dashboard oder eines der installierten Plugin-Dashboards auswählen. Jeder Benutzer mit dieser Rolle sieht dann dieses Dashboard.

Ein Client-Dashboard-Plugin besteht aus einer XHTML-Seite und einer verwalteten Bean für diese XHTML-Seite, siehe {{jpath path="de.xima.fc.plugin.interfaces.backend.IPluginClientDashboardCustomGUIBean"/}} für weitere Informationen. Wenn ein Plugin-Dashboard eingestellt ist, wird die XHTML-Seite anstelle des normalen Dashboards angezeigt. Bitte beachten Sie, dass Sie den Layout-Rahmen (die Menüleiste links und die obere Leiste) nicht ändern können, sondern nur den Hauptinhalt der Dashboard-Seite.

Das Ergebnis des Demo-Client-Dashboard-Plugins. Zeigt ein einfaches benutzerdefiniertes Dashboard mit einem benutzerdefinierten Feldsatz.

Schnittstelle IPluginGenericCustomGUI

Diese Schnittstelle wird automatisch von einem Client-Dashboard-Plugin implementiert und enthält die folgenden zusätzlichen Methoden.

Methodensignaturen

Iterable getUnmanagedBeans()

Dies muss eine Liste der unterstützenden Bean-Klassen zurückgeben, die die Benutzeroberfläche steuern und vom getXhtmlView benötigt werden. Eine neue Instanz der Bean wird automatisch erstellt, wenn die Ansicht geöffnet wird. Stellen Sie sicher, dass jede Bean einen No-Argument-Konstruktor hat, sonst kann sie nicht instanziiert werden.

Bitte beachten Sie, dass die Beans unmanaged sind - die für managed Beans spezifische Funktionalität ist nicht verfügbar. Das bedeutet zum Beispiel, dass Annotationen wie

URL getXhtmlView()

Diese Methode muss den Pfad zu der XHTML-Seite für die benutzerdefinierte Benutzeroberfläche zurückgeben. Normalerweise ist die XHTML-Datei Teil der JAR-Ressourcen des Plugins. In diesem Fall sollten Sie eine URL zu einer JAR-Datei-Ressource (jar:file:/...) zurückgeben, etwa so:

@Override
public URL getXhtmlView() {
return getClass().getResource("/path/to/view.xhtml");
}

Schnittstelle IPluginClientDashboardCustomGUIBean

Die Schnittstelle für die unmanaged Bean, die vom Client-Dashboard verwendet wird. Sie bietet einige allgemeine Funktionen. Eine eigene Bean-Klasse sollte die abstrakte Klasse DemoClientDashboard erweitern, sie implementiert die meisten der benötigten Methoden und reduziert den Overhead beim Erstellen neuer Beans.