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. getServletContext() should be implemented, which returns 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:
  • Constructor Details

    • BaseJSPPanelCategory

      public BaseJSPPanelCategory()
  • Method Details

    • getHeaderJspPath

      public String getHeaderJspPath()
    • getJspPath

      public abstract String getJspPath()
    • include

      public boolean include(javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse) throws 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:
      httpServletRequest - the servlet request used in the rendering process
      httpServletResponse - the servlet response used in the rendering process
      Returns:
      true if the category body renders successfully; false otherwise
      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: PanelCategory
      Returns true if the category header renders successfully.
      Specified by:
      includeHeader in interface PanelCategory
      Overrides:
      includeHeader in class BasePanelCategory
      Parameters:
      httpServletRequest - the servlet request used in the rendering process
      httpServletResponse - the servlet response used in the rendering process
      Returns:
      true if the category header renders successfully; false otherwise
      Throws:
      IOException - if an IO exception occurred
    • getServletContext

      protected abstract javax.servlet.ServletContext getServletContext()
    • includeJSP

      protected boolean includeJSP(javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse, String jspPath) throws IOException
      Throws:
      IOException