Package com.liferay.application.list
Class BasePanelCategory
java.lang.Object
com.liferay.application.list.BasePanelCategory
- All Implemented Interfaces:
PanelCategory,PanelEntry
- Direct Known Subclasses:
BaseJSPPanelCategory
Provides a skeletal implementation of the
PanelCategory to minimize
the effort required to implement this interface.
To implement an application category, this class should be extended and
include(HttpServletRequest, HttpServletResponse) and
#includeHeader(HttpServletRequest, HttpServletResponse)} should be
overridden. The include override method should return
true when the application view successfully renders and
false otherwise. The includeHeader override method
should return true when the category header successfully renders
and false otherwise.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanintgetNotificationsCount(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.inthashCode()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, finalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.liferay.application.list.PanelCategory
isAllowScopeLayoutsMethods inherited from interface com.liferay.application.list.PanelEntry
getKey, getLabel
-
Constructor Details
-
BasePanelCategory
public BasePanelCategory()
-
-
Method Details
-
equals
-
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
-
hashCode
public int hashCode() -
include
public boolean include(javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse) throws IOException 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- Throws:
IOException- if an IO exception occurred
-
includeHeader
public boolean includeHeader(javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse) throws IOException 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- Throws:
IOException- if an IO exception occurred
-
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) throws com.liferay.portal.kernel.exception.PortalException 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- Throws:
com.liferay.portal.kernel.exception.PortalException- if a portal exception occurred
-