Menüeinträge (Verwaltungsoberfläche)

Geändert am Mo, 17 Jul, 2023 um 9:08 VORMITTAGS

Um neue Menüeinträge in formcycle-Verwaltungsoberfläche zu integrieren, muss eine Klasse das Interface IPluginMenuEntries implementieren.

Neue Menüeinträge per Plugin.

Collection<IPluginMenuEntry> getMenuEntries(IPluginMenuEntriesParams params)

Methode für die Bereitstellung der Menüeinträge. Übergabewert: IPluginMenuEntriesParams Pluginparameter, die den aktuellen Mandanten und Benutzer bereitstellen. Rückgabewert: IPluginMenuEntry Eine Collection der Menüeinträgen des Plugins.

In den einzelnen zurück gegebenen Menüeinträgen (IPluginMenuEntry) gibt es eine Reihe von Methoden, welche den jeweiligen Menüeintrag definieren:

String getText(Locale locale)

Methode für die Bereitstellung des Namens des Menüeintrags. Hierfür sollte das übergebene Locale verwendet werden.

String getIcon()

Methode für die Bereitstellung des Menüeintragicons, welches als Styleclass zurückgegeben werden muss. Z.B.: fa-users für ein Benutzericon von Font Awesome.

String getTargetURL()

Methode für die Bereitstellung der XHTML-Seite auf, welche der Menüeintrag verweisen soll. Hierfür muss der Pfad zur XHTML-Datei relativ zum Ressourcepfad des Java Archive (src/main/resources) angegeben werden. Z.B.: protected/user.xhtml für eine Datei die sich unter src/main/resources/protected/user.xhtml im Java Archive befindet.

boolean isOpenNewWindow()

Gibt an, ob die Seite in einem neun Tab geöffnet werden soll.

EPluginMenuTargetType getTargetType()

Der Targettyp gibt, wie die Target-URL ausgewertet wird. Es gibt folgende Targettypen:

PORTAL: Der Targetpfad ist relativ zum Portalkontext (siehe Portalplugins).
ABSOLUT: Der Targetpfad ist ein einfacher absoluter Pfad.
RELATIVE: Der Targetpfad ist ein einfacher relativer Pfad.
PARENT: Bei dem Menüeintrag handelt es sich um einen aufklappbaren Eintrag, welcher Kindereinträge haben kann.

boolean isShowOnSystemUser()

Gibt an, ob der Menüeintrag unter den Systemeinstellungen zu finden sein soll.

boolean isClientScopeOnly()

Gibt an, ob der Menüeintrag nur dann angezeigt werden soll, wenn ein Mandant ausgewählt ist.

Collection<IPluginMenuEntry> getChildEntries()

Methode für die Bereitstellung möglicher Kindeinträge.

IAccessProperty[] getNeededCustomAccessProperties()

Alle von dieser Methode zurück gegebenen IAccessPropertys müssen in der Benutzerrolle gesetzt sein, damit der Menüeintrag für den Benutzer sichtbar ist. Über das Interface IAccessProperty können eigene Berechtigungen erstellt werden.

EAccessProperty[] getNeededAccessProperties()

Alle von dieser Methode zurück gegebenen EAccessPropertys müssen in der Benutzerrolle gesetzt sein, damit der Menüeintrag für den Benutzer sichtbar ist.

boolean customIsRendered()

Methode für die Bereitstellung erweiterter Checks, zum Prüfen ob der Menüeintrag sichtbar sein soll oder nicht. Diese Checks werden ODER-verknüpft mit den Checks für getNeededCustomAccessProperties() & getNeededAccessProperties().