Interface PanelEntry

All Known Subinterfaces:
PanelApp, PanelCategory
All Known Implementing Classes:
BaseJSPPanelApp, BaseJSPPanelCategory, BasePanelApp, BasePanelCategory, PortletPanelAppAdapter, RootPanelCategory

public interface PanelEntry
Provides a basic interface for panel categories and implementations. To create a new PanelCategory or PanelApp implementation, it is necessary to implement its corresponding interface. Never implement this interface directly.
See Also:
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns the panel entry's key.
    getLabel(Locale locale)
    Returns the label that is displayed in the user interface when the panel entry is included.
    boolean
    isShow(com.liferay.portal.kernel.security.permission.PermissionChecker permissionChecker, com.liferay.portal.kernel.model.Group group)
    Returns true if the panel entry should be displayed in the group's context.
  • Method Details

    • getKey

      String getKey()
      Returns the panel entry's key.
      Returns:
      the panel entry's key
    • getLabel

      String getLabel(Locale locale)
      Returns the label that is displayed in the user interface when the panel entry is included.
      Parameters:
      locale - the label's retrieved locale
      Returns:
      the label of the panel entry
    • isShow

      boolean isShow(com.liferay.portal.kernel.security.permission.PermissionChecker permissionChecker, com.liferay.portal.kernel.model.Group group) throws com.liferay.portal.kernel.exception.PortalException
      Returns true if the panel entry should be displayed in the group's context.
      Parameters:
      permissionChecker - the permission checker
      group - the group for which permissions are checked
      Returns:
      true if the Control Menu entry should be displayed in the request's context; false otherwise
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred