Interface PanelCategory

All Superinterfaces:
PanelEntry
All Known Implementing Classes:
BaseJSPPanelCategory, BasePanelCategory, RootPanelCategory

public interface PanelCategory extends PanelEntry
Provides an interface that defines application categories to be used by a liferay-application-list:panel-category tag instance to render a new panel application category. Application categories include applications defined by PanelApp implementations.
See Also:
  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getNotificationsCount(PanelCategoryHelper panelCategoryHelper, com.liferay.portal.kernel.security.permission.PermissionChecker permissionChecker, com.liferay.portal.kernel.model.Group group, com.liferay.portal.kernel.model.User user)
    Returns the number of notifications for the user in this application category.
    boolean
    include(javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse)
    Returns true if the category body renders successfully.
    boolean
    includeHeader(javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse)
    Returns true if the category header renders successfully.
    boolean
    isActive(javax.servlet.http.HttpServletRequest httpServletRequest, PanelCategoryHelper panelCategoryHelper, com.liferay.portal.kernel.model.Group group)
    Returns true if the application category is active.
    default boolean
     
    boolean
    Returns true if the state of the category is persisted.

    Methods inherited from interface com.liferay.application.list.PanelEntry

    getKey, getLabel, isShow
  • Method Details

    • getNotificationsCount

      int getNotificationsCount(PanelCategoryHelper panelCategoryHelper, com.liferay.portal.kernel.security.permission.PermissionChecker permissionChecker, com.liferay.portal.kernel.model.Group group, com.liferay.portal.kernel.model.User user)
      Returns the number of notifications for the user in this application category.
      Parameters:
      panelCategoryHelper - the PanelCategoryHelper to facilitate the method's implementation
      permissionChecker - the PermissionChecker (in portal-kernel) used to check the user's permissions
      group - the group for which notifications are checked
      user - the user from which notifications are retrieved
      Returns:
      the number of notifications for the user in the application category
    • include

      boolean include(javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse) throws IOException
      Returns true if the category body renders successfully.
      Parameters:
      httpServletRequest - the servlet request used in the rendering process
      httpServletResponse - the servlet response used in the rendering process
      Returns:
      true if the category body renders successfully; false otherwise
      Throws:
      IOException - if an IO exception occurred
    • includeHeader

      boolean includeHeader(javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse) throws IOException
      Returns true if the category header renders successfully.
      Parameters:
      httpServletRequest - the servlet request used in the rendering process
      httpServletResponse - the servlet response used in the rendering process
      Returns:
      true if the category header renders successfully; false otherwise
      Throws:
      IOException - if an IO exception occurred
    • isActive

      boolean isActive(javax.servlet.http.HttpServletRequest httpServletRequest, PanelCategoryHelper panelCategoryHelper, com.liferay.portal.kernel.model.Group group)
      Returns true if the application category is active.
      Parameters:
      httpServletRequest - the servlet request
      panelCategoryHelper - the PanelCategoryHelper to facilitate the method's implementation
      group - the group for which the state of the application category is checked
      Returns:
      true if the application category is active; false otherwise
    • isAllowScopeLayouts

      default boolean isAllowScopeLayouts()
    • isPersistState

      boolean isPersistState()
      Returns true if the state of the category is persisted.
      Returns:
      true if the state of the category is persisted; false otherwise