Interface ProductNavigationControlMenuEntry

All Known Implementing Classes:
BaseJSPProductNavigationControlMenuEntry, BaseProductNavigationControlMenuEntry

public interface ProductNavigationControlMenuEntry
Provides an interface that defines entries to be used by a product-navigation:control-menu tag instance to render a new Control Menu entry. Control Menu entries are included within Control Menu categories defined by ProductNavigationControlMenuCategory implementations.

Implementations must be registered in the OSGi Registry. The order of Control Menu entries inside a category is determined by the product.navigation.control.menu.entry.order property value. The Control Menu category used to display that entry is determined by the product.navigation.control.menu.category.key property value.

  • Method Summary

    Modifier and Type
    Method
    Description
    getData(jakarta.servlet.http.HttpServletRequest httpServletRequest)
    Returns the data to be injected as the data attribute of the liferay-ui:icon tag instance for the Control Menu entry.
    getIcon(jakarta.servlet.http.HttpServletRequest httpServletRequest)
    Returns the icon name to be injected as the icon attribute of the liferay-ui:icon tag instance for the Control Menu entry.
    getIconCssClass(jakarta.servlet.http.HttpServletRequest httpServletRequest)
    Returns the icon CSS class to be injected as the iconCssClass attribute of the liferay-ui:icon tag instance for the Control Menu entry.
    Returns the Control Menu entry's key.
    getLabel(Locale locale)
    Returns the label that is displayed in the user interface when the Control Menu entry is included in the tag instance.
    getLinkCssClass(jakarta.servlet.http.HttpServletRequest httpServletRequest)
    Returns the link CSS class to be injected as the linkCssClass attribute of the liferay-ui:icon tag instance for the Control Menu entry.
    getMarkupView(jakarta.servlet.http.HttpServletRequest httpServletRequest)
    Returns the markup view string to be injected as the markupView attribute of the liferay-ui:icon tag instance for the Control Menu entry.
    getURL(jakarta.servlet.http.HttpServletRequest httpServletRequest)
    Returns the URL to be injected as the url attribute of the liferay-ui:icon tag instance for the Control Menu entry.
    boolean
    includeBody(jakarta.servlet.http.HttpServletRequest httpServletRequest, jakarta.servlet.http.HttpServletResponse httpServletResponse)
    Returns true if the Control Menu entry body's HTML should be rendered.
    boolean
    includeIcon(jakarta.servlet.http.HttpServletRequest httpServletRequest, jakarta.servlet.http.HttpServletResponse httpServletResponse)
    Returns true if the Control Menu entry icon's HTML should be rendered.
    boolean
    isPanelStateOpen(jakarta.servlet.http.HttpServletRequest httpServletRequest, String key)
     
    default boolean
    isRelevant(jakarta.servlet.http.HttpServletRequest httpServletRequest)
     
    boolean
    isShow(jakarta.servlet.http.HttpServletRequest httpServletRequest)
    Returns true if the Control Menu entry should be displayed in the request's context.
    boolean
    Returns true if the Control Menu entry should be opened in a dialog window.
    void
    setPanelState(jakarta.servlet.http.HttpServletRequest httpServletRequest, String key, String panelState)
     
  • Method Details

    • getData

      Map<String,Object> getData(jakarta.servlet.http.HttpServletRequest httpServletRequest)
      Returns the data to be injected as the data 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 data attribute of the liferay-ui:icon tag instance for the Control Menu entry
    • getIcon

      String getIcon(jakarta.servlet.http.HttpServletRequest httpServletRequest)
      Returns the icon name to be injected as the icon 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 icon attribute of the liferay-ui:icon tag instance for the Control Menu entry
    • getIconCssClass

      String getIconCssClass(jakarta.servlet.http.HttpServletRequest httpServletRequest)
      Returns the icon CSS class to be injected as the iconCssClass 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 iconCssClass attribute of the liferay-ui:icon tag instance for the Control Menu entry
    • getKey

      String getKey()
      Returns the Control Menu entry's key. This key must be unique in the scope of the Control Menu entry selector.
      Returns:
      the Control Menu entry's key
    • getLabel

      String getLabel(Locale locale)
      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
    • getLinkCssClass

      String getLinkCssClass(jakarta.servlet.http.HttpServletRequest httpServletRequest)
      Returns the link CSS class to be injected as the linkCssClass 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 linkCssClass attribute of the liferay-ui:icon tag instance for the Control Menu entry
    • getMarkupView

      String getMarkupView(jakarta.servlet.http.HttpServletRequest httpServletRequest)
      Returns the markup view string to be injected as the markupView 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 markupView attribute of the liferay-ui:icon tag instance for the Control Menu entry
    • getURL

      String getURL(jakarta.servlet.http.HttpServletRequest httpServletRequest)
      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
    • includeBody

      boolean includeBody(jakarta.servlet.http.HttpServletRequest httpServletRequest, jakarta.servlet.http.HttpServletResponse httpServletResponse) throws IOException
      Returns true if the Control Menu entry body's HTML should be rendered.
      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

      boolean includeIcon(jakarta.servlet.http.HttpServletRequest httpServletRequest, jakarta.servlet.http.HttpServletResponse httpServletResponse) throws IOException
      Returns true if the Control Menu entry icon's HTML should be rendered.
      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
    • isPanelStateOpen

      boolean isPanelStateOpen(jakarta.servlet.http.HttpServletRequest httpServletRequest, String key)
    • isRelevant

      default boolean isRelevant(jakarta.servlet.http.HttpServletRequest httpServletRequest)
    • isShow

      boolean isShow(jakarta.servlet.http.HttpServletRequest httpServletRequest) throws com.liferay.portal.kernel.exception.PortalException
      Returns true if the Control Menu entry should be displayed in the request's context.
      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
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
    • isUseDialog

      boolean isUseDialog()
      Returns true if the Control Menu entry should be opened in a dialog window.
      Returns:
      true if the Control Menu entry should be opened in a dialog window; false if it should open in the current window
    • setPanelState

      void setPanelState(jakarta.servlet.http.HttpServletRequest httpServletRequest, String key, String panelState)