Menu entries (backend)

Modified on Mon, 17 Jul, 2023 at 9:08 AM

In order to add new menu entries to the backend of formcycle, a class has to be created, which implements the interface IPluginMenuEntries.

New menu entries via plugin.

Collection<IPluginMenuEntry> getMenuEntries(IPluginMenuEntriesParams params)

Method for providing men entries. Parameter: IPluginMenuEntriesParams Plugin parameterscontaining the current client and user. Return value: IPluginMenuEntry A collection of menu entires of the plugin.

Every returned menu entry (IPluginMenuEntry) has the following set of methods, which can be used to define the entry:

String getText(Locale locale)

Method for providing the name of the menu entry. The given Locale should be used to return the name in the right language.

String getIcon()

Method for providing the icon of the menu entry. The icon has to be returned as a style class, e.g.: fa-users for a user icon from Font Awesome.

String getTargetURL()

Method providing the XHTML page the menu entry should redirect to. The path to the XHTML file has to be relative to the Java Archive (src/main/resources), e.g.: protected/user.xhtml for a file which resides under src/main/resources/protected/user.xhtml in the Java Archive.

boolean isOpenNewWindow()

Determines whether the page should be opened in a new tab.

EPluginMenuTargetType getTargetType()

The target type determines how the target url should be resolved. The following target types exist:

PORTAL: The target path is relative to the portal context (see portal plugins).
ABSOLUT: The target path is a simple absolute path.
RELATIVE: The target path is a simple relative path.
PARENT: The menu entry can be expanded revealing sub menu entries.

boolean isShowOnSystemUser()

Determines whether the menu entry should be found under system settings or not.

boolean isClientScopeOnly()

Determines whether or not the menu entry should only be shown if a client is present.

Collection<IPluginMenuEntry> getChildEntries()

Method providing possible sub menu entries.

IAccessProperty[] getNeededCustomAccessProperties()

All of the returned IAccessPropertys have to be set in the user role in order for the menu entry to be visible. The Interface IAccessProperty allows the creation of custom access properties.

EAccessProperty[] getNeededAccessProperties()

All of the returned EAccessPropertys have to be set in the user role in order for the menu entry to be visible

boolean customIsRendered()

Method providing further checks, for validating whether or not the menu entry should be visible. These checks are OR connected with the other check for getNeededCustomAccessProperties() & getNeededAccessProperties().