de.xima.fc.interfaces.plugin.retval.backend

Interface IPluginMenuEntry

public interface IPluginMenuEntry

Interface for plugin-menu-entries in the backend-ui

Author:

XIMA MEDIA GmbH, Dresden - Michael Kohlsche - 24.04.2019

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IPluginMenuEntry.EPluginMenuTargetType Enum of menu-entry target typs

Method Summary

Modifier and Type	Method and Description
default boolean	customIsRendered() Custom method to extend the check if the menu-entry should be rendered.
default Collection<IPluginMenuEntry>	getChildEntries() Getter for an collection of chield menu-entries to be shown as sub-menu-entries
String	getIcon() Getter for the CSS-Class for the icon of the menu-entry
default EAccessProperty[]	getNeededAccessProperties() Getter for an Array of default EAccessPropertys whitch all have to be presend on the users role to show the menu-entry
default IAccessProperty[]	getNeededCustomAccessProperties() Getter for an Array of custom IAccessPropertys whitch all have to be presend on the users role to show the menu-entry
IPluginMenuEntry.EPluginMenuTargetType	getTargetType() Getter for the menu-entry target-type.
String	getTargetURL() Getter for the menu-entry target-URL/URI
String	getText(Locale locale) Getter for the text to show in the menu-entry
default boolean	isClientScopeOnly() Getter if the menu-entry should only be shown if a client is presend in the backend-ui
boolean	isOpenNewWindow() Getter if the target of the menu-entry should be opened in a new window/tab
default boolean	isShowOnSystemUser() Getter if the menu-entry should be shown in the system-user-ui

Method Detail

getText

String getText(Locale locale)

Getter for the text to show in the menu-entry

Parameters:

locale - the current Locale of the ui

Returns:

String the text of the menu-entry

getIcon

String getIcon()

Getter for the CSS-Class for the icon of the menu-entry

Returns:

String the CSS-Class for the icon

getTargetURL

String getTargetURL()

Getter for the menu-entry target-URL/URI

Returns:

String the menu-entrys target

isOpenNewWindow

boolean isOpenNewWindow()

Getter if the target of the menu-entry should be opened in a new window/tab

Returns:

Boolean if the target should be opened in a new window/tab

getTargetType

IPluginMenuEntry.EPluginMenuTargetType getTargetType()

Getter for the menu-entry target-type. @See IPluginMenuEntry.EPluginMenuTargetType

Returns:

IPluginMenuEntry.EPluginMenuTargetType the target-type

isShowOnSystemUser

default boolean isShowOnSystemUser()

Getter if the menu-entry should be shown in the system-user-ui

Returns:

Boolean true if the menu-entry should be shown in the system-user-ui. Default: false

isClientScopeOnly

default boolean isClientScopeOnly()

Getter if the menu-entry should only be shown if a client is presend in the backend-ui

Returns:

Boolean true if the menu-entry should only be shown if a client is presend in the backend-ui. Default: true

getChildEntries

default Collection<IPluginMenuEntry> getChildEntries()

Getter for an collection of chield menu-entries to be shown as sub-menu-entries

Returns:

Collection of IPluginMenuEntrys. Default: null

getNeededCustomAccessProperties

default IAccessProperty[] getNeededCustomAccessProperties()

Getter for an Array of custom IAccessPropertys whitch all have to be presend on the users role to show the menu-entry

Returns:

IAccessProperty-Array. Default: empty array

getNeededAccessProperties

default EAccessProperty[] getNeededAccessProperties()

Getter for an Array of default EAccessPropertys whitch all have to be presend on the users role to show the menu-entry

Returns:

EAccessProperty-Array. Default: empty array

customIsRendered

default boolean customIsRendered()

Custom method to extend the check if the menu-entry should be rendered. This check is or-connected with the other checks (i.e. getNeededAccessProperties())

Returns:

Boolean if the menu-entry should be rendered. Default: false