com.liferay.application.list

Class BaseJSPPanelApp

java.lang.Object

com.liferay.application.list.BasePanelApp

com.liferay.application.list.BaseJSPPanelApp

All Implemented Interfaces:

PanelApp, PanelEntry

public abstract class BaseJSPPanelApp
extends BasePanelApp

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

To implement a JSP application, this class should be extended and getJspPath() should be implemented, which returns a path for the main JSP application view in the current servlet context. The servlet context should also be set using setServletContext(ServletContext), which uses the appropriate servlet context for JSP pages. If the servlet context is not set, include(HttpServletRequest, HttpServletResponse) will throw a NullPointerException.

JSP applications are included within JSP application categories defined by BaseJSPPanelCategory implementations.

See Also:

BasePanelApp, PanelApp

Field Summary

Fields inherited from class com.liferay.application.list.BasePanelApp

groupProvider

Constructor Summary

Constructors

Constructor and Description
BaseJSPPanelApp()

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	getJspPath()
boolean	include(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Returns true if the application successfully renders.
void	setServletContext(javax.servlet.ServletContext servletContext)

Methods inherited from class com.liferay.application.list.BasePanelApp

getControlPanelEntry, getGroup, getKey, getLabel, getNotificationsCount, getPortlet, getPortletURL, isShow, setGroupProvider, setPortlet, setUserNotificationEventLocalService

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

Constructor Detail

BaseJSPPanelApp

public BaseJSPPanelApp()

Method Detail

getJspPath

public abstract java.lang.String getJspPath()

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

Overrides:

include in class BasePanelApp

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

setServletContext

public void setServletContext(javax.servlet.ServletContext servletContext)