Package com.liferay.application.list
Class RootPanelCategory
java.lang.Object
com.liferay.application.list.RootPanelCategory
- All Implemented Interfaces:
PanelCategory,PanelEntry
Represents the root panel category for all implemented categories in the
PanelCategoryRegistryUtil.- See Also:
-
PanelCategoryPanelCategoryRegistryUtil
-
Method Summary
Modifier and TypeMethodDescriptionstatic PanelCategorygetKey()Returns the panel entry's key.Returns the label that is displayed in the user interface when the panel entry is included.intgetNotificationsCount(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.booleaninclude(javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse) Returnstrueif the category body renders successfully.booleanincludeHeader(javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse) Returnstrueif the category header renders successfully.booleanisActive(javax.servlet.http.HttpServletRequest httpServletRequest, PanelCategoryHelper panelCategoryHelper, com.liferay.portal.kernel.model.Group group) Returnstrueif the application category is active.booleanReturnstrueif the state of the category is persisted.booleanisShow(com.liferay.portal.kernel.security.permission.PermissionChecker permissionChecker, com.liferay.portal.kernel.model.Group group) Returnstrueif the panel entry should be displayed in the group's context.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.liferay.application.list.PanelCategory
isAllowScopeLayouts
-
Method Details
-
getInstance
-
getKey
Description copied from interface:PanelEntryReturns the panel entry's key.- Specified by:
getKeyin interfacePanelEntry- Returns:
- the panel entry's key
-
getLabel
Description copied from interface:PanelEntryReturns the label that is displayed in the user interface when the panel entry is included.- Specified by:
getLabelin interfacePanelEntry- Parameters:
locale- the label's retrieved locale- Returns:
- the label of the panel entry
-
getNotificationsCount
public 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) Description copied from interface:PanelCategoryReturns the number of notifications for the user in this application category.- Specified by:
getNotificationsCountin interfacePanelCategory- Parameters:
panelCategoryHelper- thePanelCategoryHelperto facilitate the method's implementationpermissionChecker- thePermissionChecker(inportal-kernel) used to check the user's permissionsgroup- the group for which notifications are checkeduser- the user from which notifications are retrieved- Returns:
- the number of notifications for the user in the application category
-
include
public boolean include(javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse) Description copied from interface:PanelCategoryReturnstrueif the category body renders successfully.- Specified by:
includein interfacePanelCategory- Parameters:
httpServletRequest- the servlet request used in the rendering processhttpServletResponse- the servlet response used in the rendering process- Returns:
trueif the category body renders successfully;falseotherwise
-
includeHeader
public boolean includeHeader(javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse) Description copied from interface:PanelCategoryReturnstrueif the category header renders successfully.- Specified by:
includeHeaderin interfacePanelCategory- Parameters:
httpServletRequest- the servlet request used in the rendering processhttpServletResponse- the servlet response used in the rendering process- Returns:
trueif the category header renders successfully;falseotherwise
-
isActive
public boolean isActive(javax.servlet.http.HttpServletRequest httpServletRequest, PanelCategoryHelper panelCategoryHelper, com.liferay.portal.kernel.model.Group group) Description copied from interface:PanelCategoryReturnstrueif the application category is active.- Specified by:
isActivein interfacePanelCategory- Parameters:
httpServletRequest- the servlet requestpanelCategoryHelper- thePanelCategoryHelperto facilitate the method's implementationgroup- the group for which the state of the application category is checked- Returns:
trueif the application category is active;falseotherwise
-
isPersistState
public boolean isPersistState()Description copied from interface:PanelCategoryReturnstrueif the state of the category is persisted.- Specified by:
isPersistStatein interfacePanelCategory- Returns:
trueif the state of the category is persisted;falseotherwise
-
isShow
public boolean isShow(com.liferay.portal.kernel.security.permission.PermissionChecker permissionChecker, com.liferay.portal.kernel.model.Group group) Description copied from interface:PanelEntryReturnstrueif the panel entry should be displayed in the group's context.- Specified by:
isShowin interfacePanelEntry- Parameters:
permissionChecker- the permission checkergroup- the group for which permissions are checked- Returns:
trueif the Control Menu entry should be displayed in the request's context;falseotherwise
-