com.liferay.application.list

Class BaseJSPPanelCategory

java.lang.Object

com.liferay.application.list.BasePanelCategory

com.liferay.application.list.BaseJSPPanelCategory

All Implemented Interfaces:

PanelCategory, PanelEntry

public abstract class BaseJSPPanelCategory
extends BasePanelCategory

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

To implement a JSP application category, this class should be extended and getJspPath() should be implemented, which returns a path for the main JSP application category 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 application categories include JSP applications defined by BaseJSPPanelApp implementations.

See Also:

BasePanelCategory, PanelCategory

Constructor Summary

Constructors

Constructor and Description
BaseJSPPanelCategory()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getHeaderJspPath()
abstract java.lang.String	getJspPath()
boolean	include(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Returns true if the category body renders successfully.
boolean	includeHeader(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Returns true if the category header renders successfully.
protected boolean	includeJSP(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.String jspPath)
void	setServletContext(javax.servlet.ServletContext servletContext)

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

equals, getNotificationsCount, hashCode, isActive, isPersistState, isShow

Methods inherited from class java.lang.Object

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

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

getKey, getLabel

Constructor Detail

BaseJSPPanelCategory

public BaseJSPPanelCategory()

Method Detail

getHeaderJspPath

public java.lang.String getHeaderJspPath()

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

Returns true if the category body renders successfully.

Specified by:

include in interface PanelCategory

Overrides:

include in class BasePanelCategory

Parameters:

request - the servlet request used in the rendering process

response - the servlet response used in the rendering process

Returns:

true if the category body renders successfully; false otherwise

Throws:

java.io.IOException - if an IO exception occurred

includeHeader

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

Description copied from interface: PanelCategory

Returns true if the category header renders successfully.

Specified by:

includeHeader in interface PanelCategory

Overrides:

includeHeader in class BasePanelCategory

Parameters:

request - the servlet request used in the rendering process

response - the servlet response used in the rendering process

Returns:

true if the category header renders successfully; false otherwise

Throws:

java.io.IOException - if an IO exception occurred

setServletContext

public void setServletContext(javax.servlet.ServletContext servletContext)

includeJSP

protected boolean includeJSP(javax.servlet.http.HttpServletRequest request,
                             javax.servlet.http.HttpServletResponse response,
                             java.lang.String jspPath)
                      throws java.io.IOException

Throws:

java.io.IOException