com.liferay.application.list

Class BasePanelApp

java.lang.Object

com.liferay.application.list.BasePanelApp

All Implemented Interfaces:

PanelApp, PanelEntry

Direct Known Subclasses:

BaseJSPPanelApp, PortletPanelAppAdapter

public abstract class BasePanelApp
extends java.lang.Object
implements PanelApp

Provides a skeletal implementation of the PanelApp to minimize the effort required to implement this interface.

To implement an application, this class should be extended and include(HttpServletRequest, HttpServletResponse) should be overridden. The include override method should return true when the application view successfully renders and false otherwise.

See Also:

PanelApp

Field Summary

Fields

Modifier and Type	Field and Description
protected GroupProvider	groupProvider

Constructor Summary

Constructors

Constructor and Description
BasePanelApp()

Method Summary

Modifier and Type	Method and Description
protected com.liferay.portal.kernel.portlet.ControlPanelEntry	getControlPanelEntry()
protected com.liferay.portal.kernel.model.Group	getGroup(javax.servlet.http.HttpServletRequest request)
java.lang.String	getKey() Returns the panel entry's key.
java.lang.String	getLabel(java.util.Locale locale) Returns the label that is displayed in the user interface when the panel entry is included.
int	getNotificationsCount(com.liferay.portal.kernel.model.User user) Returns the number of notifications for the user.
com.liferay.portal.kernel.model.Portlet	getPortlet() Returns the portlet associated with the application.
javax.portlet.PortletURL	getPortletURL(javax.servlet.http.HttpServletRequest request) Returns the URL used to render a portlet based on the servlet request attributes.
boolean	include(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Returns true if the application successfully renders.
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.
void	setGroupProvider(GroupProvider groupProvider) Sets the GroupProvider associated with the application.
void	setPortlet(com.liferay.portal.kernel.model.Portlet portlet) Sets the portlet associated with the application.
protected void	setUserNotificationEventLocalService(com.liferay.portal.kernel.service.UserNotificationEventLocalService userNotificationEventLocalService)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getPortletId

Field Detail

groupProvider

protected GroupProvider groupProvider

Constructor Detail

BasePanelApp

public BasePanelApp()

Method Detail

getKey

public java.lang.String getKey()

Description copied from interface: PanelEntry

Returns the panel entry's key.

Specified by:

getKey in interface PanelEntry

Returns:

the panel entry's key

getLabel

public java.lang.String getLabel(java.util.Locale locale)

Description copied from interface: PanelEntry

Returns the label that is displayed in the user interface when the panel entry is included.

Specified by:

getLabel in interface PanelEntry

Parameters:

locale - the label's retrieved locale

Returns:

the label of the panel entry

getNotificationsCount

public int getNotificationsCount(com.liferay.portal.kernel.model.User user)

Description copied from interface: PanelApp

Returns the number of notifications for the user.

Specified by:

getNotificationsCount in interface PanelApp

Parameters:

user - the user from which notifications are retrieved

Returns:

the number of notifications for the user

getPortlet

public com.liferay.portal.kernel.model.Portlet getPortlet()

Description copied from interface: PanelApp

Returns the portlet associated with the application.

Specified by:

getPortlet in interface PanelApp

Returns:

the portlet associated with the application

getPortletURL

public javax.portlet.PortletURL getPortletURL(javax.servlet.http.HttpServletRequest request)
                                       throws com.liferay.portal.kernel.exception.PortalException

Description copied from interface: PanelApp

Returns the URL used to render a portlet based on the servlet request attributes.

Specified by:

getPortletURL in interface PanelApp

Parameters:

request - the servlet request used to create a portlet's URL

Returns:

the portlet's URL used to render a target portlet

Throws:

com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred

include

public boolean include(javax.servlet.http.HttpServletRequest request,
                       javax.servlet.http.HttpServletResponse response)
                throws java.io.IOException

Description copied from interface: PanelApp

Returns true if the application successfully renders.

Specified by:

include in interface PanelApp

Parameters:

request - the servlet request used in the rendering process

response - the servlet response used in the rendering process

Returns:

true if the application successfully renders; false otherwise

Throws:

java.io.IOException - if an IO exception occurred

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: PanelEntry

Returns true if the panel entry should be displayed in the group's context.

Specified by:

isShow in interface PanelEntry

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

setGroupProvider

public void setGroupProvider(GroupProvider groupProvider)

Description copied from interface: PanelApp

Sets the GroupProvider associated with the application.

Specified by:

setGroupProvider in interface PanelApp

Parameters:

groupProvider - the group provider associated with the application

setPortlet

public void setPortlet(com.liferay.portal.kernel.model.Portlet portlet)

Description copied from interface: PanelApp

Sets the portlet associated with the application.

Specified by:

setPortlet in interface PanelApp

Parameters:

portlet - the portlet associated with the application

getControlPanelEntry

protected com.liferay.portal.kernel.portlet.ControlPanelEntry getControlPanelEntry()

getGroup

protected com.liferay.portal.kernel.model.Group getGroup(javax.servlet.http.HttpServletRequest request)

setUserNotificationEventLocalService

protected void setUserNotificationEventLocalService(com.liferay.portal.kernel.service.UserNotificationEventLocalService userNotificationEventLocalService)