Class BaseInfoMessageProductNavigationControlMenuEntry

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

public abstract class BaseInfoMessageProductNavigationControlMenuEntry extends BaseProductNavigationControlMenuEntry
  • Constructor Details

    • BaseInfoMessageProductNavigationControlMenuEntry

      public BaseInfoMessageProductNavigationControlMenuEntry()
  • Method Details

    • 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.
      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.
      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
    • 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
    • isShow

      public boolean isShow(jakarta.servlet.http.HttpServletRequest httpServletRequest)
      Description copied from interface: ProductNavigationControlMenuEntry
      Returns true if the Control Menu entry should be displayed in the request's context.
      Specified by:
      isShow in interface ProductNavigationControlMenuEntry
      Overrides:
      isShow in class BaseProductNavigationControlMenuEntry
      Parameters:
      httpServletRequest - the request that renders the Control Menu entry
      Returns:
      true if the Control Menu entry should be displayed in the request's context; false otherwise
    • getPortletName

      protected abstract String getPortletName()
    • getType

      protected abstract String getType()
    • isDark

      protected boolean isDark()