Interface IPluginMenuEntry
-
public interface IPluginMenuEntry
- Author:
- jdr
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
IPluginMenuEntry.EPluginMenuTargetType
Enumeration of possible target types for aIPluginMenuEntry
.
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description default boolean
customIsRendered()
Deprecated.UsegetPluginView()
to implement a customIAuthorizer
andIAvailabiltyResolver
for configuring the visibility and authorization of the menu entry.default Collection<IPluginMenuEntry>
getChildEntries()
Getter for the child menu entries of this menu entry.String
getIcon()
Getter for the CSS class for the icon of this menu entrydefault EAccessProperty[]
getNeededAccessProperties()
Deprecated.UsegetPluginView()
to implement a customIAuthorizer
andIAvailabiltyResolver
for configuring the visibility and authorization of the menu entry.default IAccessProperty[]
getNeededCustomAccessProperties()
Deprecated.UsegetPluginView()
to implement a customIAuthorizer
andIAvailabiltyResolver
for configuring the visibility and authorization of the menu entry.default IPluginView
getPluginView()
Getter for a custom plugin view which can determine the a custom authorization and availablity of the menu entry.IPluginMenuEntry.EPluginMenuTargetType
getTargetType()
Getter for the target type of the menu entry, seeIPluginMenuEntry.EPluginMenuTargetType
.String
getTargetURL()
Getter for the menu entry target URL or URI.String
getText(Locale locale)
Getter for the text to show in the menu entry.default boolean
isClientScopeOnly()
Deprecated.UsegetPluginView()
to implement a customIAuthorizer
andIAvailabiltyResolver
for configuring the visibility and authorization of the menu entry.boolean
isOpenNewWindow()
Getter for whether the target of the menu entry should be opened in a new window or tabdefault boolean
isPublic()
Deprecated.UsegetPluginView()
to implement a customIAuthorizer
andIAvailabiltyResolver
for configuring the visibility and authorization of the menu entry.default boolean
isShowOnSystemUser()
Deprecated.UsegetPluginView()
to implement a customIAuthorizer
andIAvailabiltyResolver
for configuring the visibility and authorization of the menu entry.
-
-
-
Method Detail
-
getIcon
String getIcon()
Getter for the CSS class for the icon of this menu entry- Returns:
String
the CSS class for the icon
-
getTargetURL
String getTargetURL()
Getter for the menu entry target URL or URI. This depends on thegetTargetType()
:IPluginMenuEntry.EPluginMenuTargetType.PARENT
: the target URL is ignored.IPluginMenuEntry.EPluginMenuTargetType.ABSOLUT
: an absolute URL or URI that can be opened in a browserIPluginMenuEntry.EPluginMenuTargetType.RELATIV
: a path relative to the current context path of the formcycle applicationIPluginMenuEntry.EPluginMenuTargetType.PORTAL
: a path to an XHTML page of the plugin, relative to the top directory in the JAR file of the plugin
- Returns:
String
the menu entry target URL.
-
isOpenNewWindow
boolean isOpenNewWindow()
Getter for whether the target of the menu entry should be opened in a new window or tab- Returns:
Boolean
if the target should be opened in a new window or tab
-
getTargetType
IPluginMenuEntry.EPluginMenuTargetType getTargetType()
Getter for the target type of the menu entry, seeIPluginMenuEntry.EPluginMenuTargetType
.- Returns:
IPluginMenuEntry.EPluginMenuTargetType
the target type
-
getChildEntries
default Collection<IPluginMenuEntry> getChildEntries()
Getter for the child menu entries of this menu entry. Child menu entries are shown as a submenu.- Returns:
Collection
ofIPluginMenuEntry
s. Default: no child entries.
-
getPluginView
default IPluginView getPluginView()
Getter for a custom plugin view which can determine the a custom authorization and availablity of the menu entry.- Returns:
IPluginView
the plugin view of the menu entry. Default: no custom plugin view.- Since:
- 8.0.0
-
isPublic
@Deprecated default boolean isPublic()
Deprecated.UsegetPluginView()
to implement a customIAuthorizer
andIAvailabiltyResolver
for configuring the visibility and authorization of the menu entry.- Returns:
true
when this menu entry is available without logging in, orfalse
otherwise. Defaults tofalse
.
-
isShowOnSystemUser
@Deprecated default boolean isShowOnSystemUser()
Deprecated.UsegetPluginView()
to implement a customIAuthorizer
andIAvailabiltyResolver
for configuring the visibility and authorization of the menu entry.Getter for whether this menu entry should be shown when the system administrator is logged in.- Returns:
Boolean
true
if this menu entry should be shown for the system administrator. Default:false
.
-
isClientScopeOnly
@Deprecated default boolean isClientScopeOnly()
Deprecated.UsegetPluginView()
to implement a customIAuthorizer
andIAvailabiltyResolver
for configuring the visibility and authorization of the menu entry.Getter for whether this menu entry should only be shown if a client is selected in the backend UI.- Returns:
Boolean
true
if the menu entry should only be shown if a client is selected in the backend UI. Default:true
.
-
getNeededCustomAccessProperties
@Deprecated default IAccessProperty[] getNeededCustomAccessProperties()
Deprecated.UsegetPluginView()
to implement a customIAuthorizer
andIAvailabiltyResolver
for configuring the visibility and authorization of the menu entry.Getter for a list of customIAccessProperty
s which all have to be present on the user's role for this menu entry to be shown.- Returns:
IAccessProperty
array. Default: empty array.
-
getNeededAccessProperties
@Deprecated default EAccessProperty[] getNeededAccessProperties()
Deprecated.UsegetPluginView()
to implement a customIAuthorizer
andIAvailabiltyResolver
for configuring the visibility and authorization of the menu entry.Getter for an array of standardEAccessProperty
s which all have to be present on the user's role for this menu entry to be shown.- Returns:
EAccessProperty
array. Default: empty array
-
customIsRendered
@Deprecated default boolean customIsRendered()
Deprecated.UsegetPluginView()
to implement a customIAuthorizer
andIAvailabiltyResolver
for configuring the visibility and authorization of the menu entry.Custom method to extend the check for whether the menu entry should be available. This check is or-connected with the other checks (such asgetNeededAccessProperties()
).- Returns:
Boolean
true
if this menu entry should be rendered. Default:false
.
-
-