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 Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionabstract StringReturns the label that is displayed in the user interface when the Control Menu entry is included in the tag instance.protected abstract jakarta.servlet.ServletContextgetURL(jakarta.servlet.http.HttpServletRequest httpServletRequest) Returns the URL to be injected as theurlattribute of theliferay-ui:icontag instance for the Control Menu entry.protected booleaninclude(jakarta.servlet.http.HttpServletRequest httpServletRequest, jakarta.servlet.http.HttpServletResponse httpServletResponse, String jspPath) 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.Methods inherited from class com.liferay.product.navigation.control.menu.BaseProductNavigationControlMenuEntry
equals, getData, getIcon, getIconCssClass, getKey, getLinkCssClass, getMarkupView, hashCode, isPanelStateOpen, isShow, isUseDialog, setPanelStateMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.liferay.product.navigation.control.menu.ProductNavigationControlMenuEntry
getData, getIcon, getIconCssClass, getKey, getLinkCssClass, getMarkupView, isPanelStateOpen, isRelevant, isShow, isUseDialog, setPanelState
-
Constructor Details
-
BaseJSPProductNavigationControlMenuEntry
public BaseJSPProductNavigationControlMenuEntry()
-
-
Method Details
-
getBodyJspPath
-
getIconJspPath
-
getLabel
Description copied from interface:ProductNavigationControlMenuEntryReturns the label that is displayed in the user interface when the Control Menu entry is included in the tag instance.- Specified by:
getLabelin interfaceProductNavigationControlMenuEntry- Parameters:
locale- the label's retrieved locale- Returns:
- the Control Menu entry's label
-
getURL
Description copied from interface:ProductNavigationControlMenuEntryReturns the URL to be injected as theurlattribute of theliferay-ui:icontag instance for the Control Menu entry.- Specified by:
getURLin interfaceProductNavigationControlMenuEntry- Parameters:
httpServletRequest- the request that renders the Control Menu entry- Returns:
- the
urlattribute of theliferay-ui:icontag 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:ProductNavigationControlMenuEntryReturnstrueif the Control Menu entry body's HTML should be rendered.- Specified by:
includeBodyin interfaceProductNavigationControlMenuEntry- Overrides:
includeBodyin classBaseProductNavigationControlMenuEntry- 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
public boolean includeIcon(jakarta.servlet.http.HttpServletRequest httpServletRequest, jakarta.servlet.http.HttpServletResponse httpServletResponse) throws IOException Description copied from interface:ProductNavigationControlMenuEntryReturnstrueif the Control Menu entry icon's HTML should be rendered.- Specified by:
includeIconin interfaceProductNavigationControlMenuEntry- Overrides:
includeIconin classBaseProductNavigationControlMenuEntry- 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
-
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
-