Class BaseProductNavigationControlMenuEntry

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

public abstract class BaseProductNavigationControlMenuEntry extends Object implements ProductNavigationControlMenuEntry
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object 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.
    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.
    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.
    int
     
    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)
     
    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)
     

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface com.liferay.product.navigation.control.menu.ProductNavigationControlMenuEntry

    getLabel, getURL, isRelevant
  • Constructor Details

    • BaseProductNavigationControlMenuEntry

      public BaseProductNavigationControlMenuEntry()
  • Method Details

    • equals

      public boolean equals(Object object)
      Overrides:
      equals in class Object
    • getData

      public Map<String,Object> getData(jakarta.servlet.http.HttpServletRequest httpServletRequest)
      Description copied from interface: ProductNavigationControlMenuEntry
      Returns the data to be injected as the data attribute of the liferay-ui:icon tag instance for the Control Menu entry.
      Specified by:
      getData in interface ProductNavigationControlMenuEntry
      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

      public String getIcon(jakarta.servlet.http.HttpServletRequest httpServletRequest)
      Description copied from interface: ProductNavigationControlMenuEntry
      Returns the icon name to be injected as the icon attribute of the liferay-ui:icon tag instance for the Control Menu entry.
      Specified by:
      getIcon in interface ProductNavigationControlMenuEntry
      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

      public String getIconCssClass(jakarta.servlet.http.HttpServletRequest httpServletRequest)
      Description copied from interface: ProductNavigationControlMenuEntry
      Returns the icon CSS class to be injected as the iconCssClass attribute of the liferay-ui:icon tag instance for the Control Menu entry.
      Specified by:
      getIconCssClass in interface ProductNavigationControlMenuEntry
      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

      public String getKey()
      Description copied from interface: ProductNavigationControlMenuEntry
      Returns the Control Menu entry's key. This key must be unique in the scope of the Control Menu entry selector.
      Specified by:
      getKey in interface ProductNavigationControlMenuEntry
      Returns:
      the Control Menu entry's key
    • getLinkCssClass

      public String getLinkCssClass(jakarta.servlet.http.HttpServletRequest httpServletRequest)
      Description copied from interface: ProductNavigationControlMenuEntry
      Returns the link CSS class to be injected as the linkCssClass attribute of the liferay-ui:icon tag instance for the Control Menu entry.
      Specified by:
      getLinkCssClass in interface ProductNavigationControlMenuEntry
      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

      public String getMarkupView(jakarta.servlet.http.HttpServletRequest httpServletRequest)
      Description copied from interface: ProductNavigationControlMenuEntry
      Returns the markup view string to be injected as the markupView attribute of the liferay-ui:icon tag instance for the Control Menu entry.
      Specified by:
      getMarkupView in interface ProductNavigationControlMenuEntry
      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
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • 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
      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
      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

      public boolean isPanelStateOpen(jakarta.servlet.http.HttpServletRequest httpServletRequest, String key)
      Specified by:
      isPanelStateOpen in interface ProductNavigationControlMenuEntry
    • isShow

      public boolean isShow(jakarta.servlet.http.HttpServletRequest httpServletRequest) throws com.liferay.portal.kernel.exception.PortalException
      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
      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

      public boolean isUseDialog()
      Description copied from interface: ProductNavigationControlMenuEntry
      Returns true if the Control Menu entry should be opened in a dialog window.
      Specified by:
      isUseDialog in interface ProductNavigationControlMenuEntry
      Returns:
      true if the Control Menu entry should be opened in a dialog window; false if it should open in the current window
    • setPanelState

      public void setPanelState(jakarta.servlet.http.HttpServletRequest httpServletRequest, String key, String panelState)
      Specified by:
      setPanelState in interface ProductNavigationControlMenuEntry