IPluginMenuEntry (FORMCYCLE: BOM 6.6.0 API)

```
public interface IPluginMenuEntry
```
Interface for a plugin menu entry in the backend UI. The menu entry is shown in the main menu to the left.

Author:

XIMA MEDIA GmbH

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class IPluginMenuEntry.EPluginMenuTargetType
Enumeration of possible target types for a IPluginMenuEntry.

Nested Classes
Modifier and Type	Interface and Description
`static class`	`IPluginMenuEntry.EPluginMenuTargetType` Enumeration of possible target types for a `IPluginMenuEntry`.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default boolean`	`customIsRendered()` Custom method to extend the check for whether the menu entry should be available.
`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 entry
`default EAccessProperty[]`	`getNeededAccessProperties()` Getter for an array of standard `EAccessProperty`s which all have to be present on the user's role for this menu entry to be shown.
`default IAccessProperty[]`	`getNeededCustomAccessProperties()` Getter for a list of custom `IAccessProperty`s which all have to be present on the user's role for this menu entry to be shown.
`IPluginMenuEntry.EPluginMenuTargetType`	`getTargetType()` Getter for the target type of the menu entry, see `IPluginMenuEntry.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()` Getter for whether this menu entry should only be shown if a client is selected in the backend UI.
`boolean`	`isOpenNewWindow()` Getter for whether the target of the menu entry should be opened in a new window or tab
`default boolean`	`isShowOnSystemUser()` Getter for whether this menu entry should be shown when the system administrator is logged in.

- 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 this menu entry
  - 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 the getTargetType():
    - IPluginMenuEntry.EPluginMenuTargetType.PARENT: the target URL is ignored.
    - IPluginMenuEntry.EPluginMenuTargetType.ABSOLUT: an absolute URL or URI that can be opened in a browser
    - IPluginMenuEntry.EPluginMenuTargetType.RELATIV: a path relative to the current context path of the FORMCYCLE application
    - IPluginMenuEntry.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, see IPluginMenuEntry.EPluginMenuTargetType.
    
    Returns:
    
    IPluginMenuEntry.EPluginMenuTargetType the target type
  - isShowOnSystemUser
```
default boolean isShowOnSystemUser()
```
    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
```
default boolean isClientScopeOnly()
```
    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.
  - 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 of IPluginMenuEntrys. Default: no child entries.
  - getNeededCustomAccessProperties
```
default IAccessProperty[] getNeededCustomAccessProperties()
```
    Getter for a list of custom IAccessPropertys 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
```
default EAccessProperty[] getNeededAccessProperties()
```
    Getter for an array of standard EAccessPropertys 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
```
default boolean customIsRendered()
```
    Custom method to extend the check for whether the menu entry should be available. This check is or-connected with the other checks (such as getNeededAccessProperties()).
    
    Returns:
    
    Boolean true if this menu entry should be rendered. Default: false.

Interface IPluginMenuEntry

Nested Class Summary

Method Summary

Method Detail

getText

getIcon

getTargetURL

isOpenNewWindow

getTargetType

isShowOnSystemUser

isClientScopeOnly

getChildEntries

getNeededCustomAccessProperties

getNeededAccessProperties

customIsRendered