Interface IMenuEntry

All Known Subinterfaces:
IGroupMenuEntry, IViewMenuEntry
public interface IMenuEntry
Common interface for menu entries.

IMPORTANT: This interface is intended to be used by the formcycle core. Plugin developers should not implement this interface. This interface may be subject to change pretty soon.

Since:
8.5.0
Author:
XIMA MEDIA GmbH

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotBlank String
    getIconStyleClass()
    Returns the style class for the icon of this menu entry.
    @NotBlank String
    getLabel(Locale locale)
    Returns the label of this menu entry in the given locale.
    boolean
    isAvailable(@NotNull IUser user, Mandant client)
    Returns if this menu entry is available in the given user and client.
    boolean
    isEnabled(@NotNull IUser user, Mandant client)
    Returns if this menu entry is enabled in the given user and client.

  • Method Details

    • getIconStyleClass

      @NotBlank @NotBlank String getIconStyleClass()
      Returns the style class for the icon of this menu entry.
      Returns:
      the style class for the icon of this menu entry

    • getLabel

      @NotBlank @NotBlank String getLabel(Locale locale)
      Returns the label of this menu entry in the given locale.
      Parameters:
      locale - the locale for which to get the label
      Returns:
      the label of this menu entry in the given locale

    • isAvailable

      boolean isAvailable(@NotNull @NotNull IUser user, Mandant client)
      Returns if this menu entry is available in the given user and client.
      Parameters:
      user - the user to check
      client - the client to check. May be null if the menu context is not client-specific.
      Returns:
      true if this menu entry is available in the given user and client, false otherwise

    • isEnabled

      boolean isEnabled(@NotNull @NotNull IUser user, Mandant client)
      Returns if this menu entry is enabled in the given user and client.
      Parameters:
      user - the user to check
      client - the client to check. May be null if the menu context is not client-specific.
      Returns:
      true if this menu entry is enabled in the given user and client, false otherwise