Class BaseJSPProductNavigationControlMenuEntry

java.lang.Object
com.liferay.product.navigation.control.menu.BaseProductNavigationControlMenuEntry
com.liferay.product.navigation.control.menu.BaseJSPProductNavigationControlMenuEntry
All Implemented Interfaces:
ProductNavigationControlMenuEntry

public abstract class BaseJSPProductNavigationControlMenuEntry extends BaseProductNavigationControlMenuEntry implements ProductNavigationControlMenuEntry
  • Constructor Details

    • BaseJSPProductNavigationControlMenuEntry

      public BaseJSPProductNavigationControlMenuEntry()
  • Method Details

    • getBodyJspPath

      public String getBodyJspPath()
    • getIconJspPath

      public abstract String getIconJspPath()
    • getLabel

      public String getLabel(Locale locale)
      Description copied from interface: ProductNavigationControlMenuEntry
      Returns the label that is displayed in the user interface when the Control Menu entry is included in the tag instance.
      Specified by:
      getLabel in interface ProductNavigationControlMenuEntry
      Parameters:
      locale - the label's retrieved locale
      Returns:
      the Control Menu entry's label
    • getURL

      public String getURL(jakarta.servlet.http.HttpServletRequest httpServletRequest)
      Description copied from interface: ProductNavigationControlMenuEntry
      Returns the URL to be injected as the url attribute of the liferay-ui:icon tag instance for the Control Menu entry.
      Specified by:
      getURL in interface ProductNavigationControlMenuEntry
      Parameters:
      httpServletRequest - the request that renders the Control Menu entry
      Returns:
      the url attribute of the liferay-ui:icon tag instance for the Control Menu entry
    • includeBody

      public boolean includeBody(jakarta.servlet.http.HttpServletRequest httpServletRequest, jakarta.servlet.http.HttpServletResponse httpServletResponse) throws IOException
      Description copied from interface: ProductNavigationControlMenuEntry
      Returns true if the Control Menu entry body's HTML should be rendered.
      Specified by:
      includeBody in interface ProductNavigationControlMenuEntry
      Overrides:
      includeBody in class BaseProductNavigationControlMenuEntry
      Parameters:
      httpServletRequest - the request that renders the Control Menu entry
      httpServletResponse - the response that renders the Control Menu entry
      Returns:
      true if the Control Menu entry body's HTML should be rendered; false otherwise
      Throws:
      IOException - if an IO exception occurred
    • includeIcon

      public boolean includeIcon(jakarta.servlet.http.HttpServletRequest httpServletRequest, jakarta.servlet.http.HttpServletResponse httpServletResponse) throws IOException
      Description copied from interface: ProductNavigationControlMenuEntry
      Returns true if the Control Menu entry icon's HTML should be rendered.
      Specified by:
      includeIcon in interface ProductNavigationControlMenuEntry
      Overrides:
      includeIcon in class BaseProductNavigationControlMenuEntry
      Parameters:
      httpServletRequest - the request that renders the Control Menu entry
      httpServletResponse - the response that renders the Control Menu entry
      Returns:
      true if the Control Menu entry icon's HTML should be rendered; false otherwise
      Throws:
      IOException - if an IO exception occurred
    • getServletContext

      protected abstract jakarta.servlet.ServletContext getServletContext()
    • include

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