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 TypeMethodDescriptiongetData(jakarta.servlet.http.HttpServletRequest httpServletRequest) Returns the data to be injected as thedataattribute of theliferay-ui:icontag instance for the Control Menu entry.getIcon(jakarta.servlet.http.HttpServletRequest httpServletRequest) Returns the icon name to be injected as theiconattribute of theliferay-ui:icontag instance for the Control Menu entry.getIconCssClass(jakarta.servlet.http.HttpServletRequest httpServletRequest) Returns the icon CSS class to be injected as theiconCssClassattribute of theliferay-ui:icontag instance for the Control Menu entry.getKey()Returns the Control Menu entry's key.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 thelinkCssClassattribute of theliferay-ui:icontag instance for the Control Menu entry.getMarkupView(jakarta.servlet.http.HttpServletRequest httpServletRequest) Returns the markup view string to be injected as themarkupViewattribute of theliferay-ui:icontag instance for the Control Menu entry.getURL(jakarta.servlet.http.HttpServletRequest httpServletRequest) Returns the URL to be injected as theurlattribute of theliferay-ui:icontag instance for the Control Menu entry.booleanincludeBody(jakarta.servlet.http.HttpServletRequest httpServletRequest, jakarta.servlet.http.HttpServletResponse httpServletResponse) Returnstrueif the Control Menu entry body's HTML should be rendered.booleanincludeIcon(jakarta.servlet.http.HttpServletRequest httpServletRequest, jakarta.servlet.http.HttpServletResponse httpServletResponse) Returnstrueif the Control Menu entry icon's HTML should be rendered.booleanisPanelStateOpen(jakarta.servlet.http.HttpServletRequest httpServletRequest, String key) default booleanisRelevant(jakarta.servlet.http.HttpServletRequest httpServletRequest) booleanisShow(jakarta.servlet.http.HttpServletRequest httpServletRequest) Returnstrueif the Control Menu entry should be displayed in the request's context.booleanReturnstrueif the Control Menu entry should be opened in a dialog window.voidsetPanelState(jakarta.servlet.http.HttpServletRequest httpServletRequest, String key, String panelState)
-
Method Details
-
getData
Returns the data to be injected as thedataattribute of theliferay-ui:icontag instance for the Control Menu entry.- Parameters:
httpServletRequest- the request that renders the Control Menu entry- Returns:
- the
dataattribute of theliferay-ui:icontag instance for the Control Menu entry
-
getIcon
Returns the icon name to be injected as theiconattribute of theliferay-ui:icontag instance for the Control Menu entry.- Parameters:
httpServletRequest- the request that renders the Control Menu entry- Returns:
- the
iconattribute of theliferay-ui:icontag instance for the Control Menu entry
-
getIconCssClass
Returns the icon CSS class to be injected as theiconCssClassattribute of theliferay-ui:icontag instance for the Control Menu entry.- Parameters:
httpServletRequest- the request that renders the Control Menu entry- Returns:
- the
iconCssClassattribute of theliferay-ui:icontag 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
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
Returns the link CSS class to be injected as thelinkCssClassattribute of theliferay-ui:icontag instance for the Control Menu entry.- Parameters:
httpServletRequest- the request that renders the Control Menu entry- Returns:
- the
linkCssClassattribute of theliferay-ui:icontag instance for the Control Menu entry
-
getMarkupView
Returns the markup view string to be injected as themarkupViewattribute of theliferay-ui:icontag instance for the Control Menu entry.- Parameters:
httpServletRequest- the request that renders the Control Menu entry- Returns:
- the
markupViewattribute of theliferay-ui:icontag instance for the Control Menu entry
-
getURL
Returns the URL to be injected as theurlattribute of theliferay-ui:icontag instance for the Control Menu entry.- Parameters:
httpServletRequest- the request that renders the Control Menu entry- Returns:
- the
urlattribute of theliferay-ui:icontag instance for the Control Menu entry
-
includeBody
boolean includeBody(jakarta.servlet.http.HttpServletRequest httpServletRequest, jakarta.servlet.http.HttpServletResponse httpServletResponse) throws IOException Returnstrueif the Control Menu entry body's HTML should be rendered.- Parameters:
httpServletRequest- the request that renders the Control Menu entryhttpServletResponse- the response that renders the Control Menu entry- Returns:
trueif the Control Menu entry body's HTML should be rendered;falseotherwise- Throws:
IOException- if an IO exception occurred
-
includeIcon
boolean includeIcon(jakarta.servlet.http.HttpServletRequest httpServletRequest, jakarta.servlet.http.HttpServletResponse httpServletResponse) throws IOException Returnstrueif the Control Menu entry icon's HTML should be rendered.- Parameters:
httpServletRequest- the request that renders the Control Menu entryhttpServletResponse- the response that renders the Control Menu entry- Returns:
trueif the Control Menu entry icon's HTML should be rendered;falseotherwise- Throws:
IOException- if an IO exception occurred
-
isPanelStateOpen
-
isRelevant
default boolean isRelevant(jakarta.servlet.http.HttpServletRequest httpServletRequest) -
isShow
boolean isShow(jakarta.servlet.http.HttpServletRequest httpServletRequest) throws com.liferay.portal.kernel.exception.PortalException Returnstrueif the Control Menu entry should be displayed in the request's context.- Parameters:
httpServletRequest- the request that renders the Control Menu entry- Returns:
trueif the Control Menu entry should be displayed in the request's context;falseotherwise- Throws:
com.liferay.portal.kernel.exception.PortalException- if a portal exception occurred
-
isUseDialog
boolean isUseDialog()Returnstrueif the Control Menu entry should be opened in a dialog window.- Returns:
trueif the Control Menu entry should be opened in a dialog window;falseif it should open in the current window
-
setPanelState
-