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 -
Method Summary
Modifier and TypeMethodDescriptionbooleangetData(javax.servlet.http.HttpServletRequest httpServletRequest) Returns the data to be injected as thedataattribute of theliferay-ui:icontag instance for the Control Menu entry.getIcon(javax.servlet.http.HttpServletRequest httpServletRequest) Returns the icon name to be injected as theiconattribute of theliferay-ui:icontag instance for the Control Menu entry.getIconCssClass(javax.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.getLinkCssClass(javax.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(javax.servlet.http.HttpServletRequest httpServletRequest) Returns the markup view string to be injected as themarkupViewattribute of theliferay-ui:icontag instance for the Control Menu entry.inthashCode()booleanincludeBody(javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse) Returnstrueif the Control Menu entry body's HTML should be rendered.booleanincludeIcon(javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse) Returnstrueif the Control Menu entry icon's HTML should be rendered.booleanisPanelStateOpen(javax.servlet.http.HttpServletRequest httpServletRequest, String key) booleanisShow(javax.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(javax.servlet.http.HttpServletRequest httpServletRequest, String key, String panelState) Methods 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
getLabel, getURL, isRelevant
-
Constructor Details
-
BaseProductNavigationControlMenuEntry
public BaseProductNavigationControlMenuEntry()
-
-
Method Details
-
equals
-
getData
Description copied from interface:ProductNavigationControlMenuEntryReturns the data to be injected as thedataattribute of theliferay-ui:icontag instance for the Control Menu entry.- Specified by:
getDatain interfaceProductNavigationControlMenuEntry- Parameters:
httpServletRequest- the request that renders the Control Menu entry- Returns:
- the
dataattribute of theliferay-ui:icontag instance for the Control Menu entry
-
getIcon
Description copied from interface:ProductNavigationControlMenuEntryReturns the icon name to be injected as theiconattribute of theliferay-ui:icontag instance for the Control Menu entry.- Specified by:
getIconin interfaceProductNavigationControlMenuEntry- Parameters:
httpServletRequest- the request that renders the Control Menu entry- Returns:
- the
iconattribute of theliferay-ui:icontag instance for the Control Menu entry
-
getIconCssClass
Description copied from interface:ProductNavigationControlMenuEntryReturns the icon CSS class to be injected as theiconCssClassattribute of theliferay-ui:icontag instance for the Control Menu entry.- Specified by:
getIconCssClassin interfaceProductNavigationControlMenuEntry- Parameters:
httpServletRequest- the request that renders the Control Menu entry- Returns:
- the
iconCssClassattribute of theliferay-ui:icontag instance for the Control Menu entry
-
getKey
Description copied from interface:ProductNavigationControlMenuEntryReturns the Control Menu entry's key. This key must be unique in the scope of the Control Menu entry selector.- Specified by:
getKeyin interfaceProductNavigationControlMenuEntry- Returns:
- the Control Menu entry's key
-
getLinkCssClass
Description copied from interface:ProductNavigationControlMenuEntryReturns the link CSS class to be injected as thelinkCssClassattribute of theliferay-ui:icontag instance for the Control Menu entry.- Specified by:
getLinkCssClassin interfaceProductNavigationControlMenuEntry- Parameters:
httpServletRequest- the request that renders the Control Menu entry- Returns:
- the
linkCssClassattribute of theliferay-ui:icontag instance for the Control Menu entry
-
getMarkupView
Description copied from interface:ProductNavigationControlMenuEntryReturns the markup view string to be injected as themarkupViewattribute of theliferay-ui:icontag instance for the Control Menu entry.- Specified by:
getMarkupViewin interfaceProductNavigationControlMenuEntry- Parameters:
httpServletRequest- the request that renders the Control Menu entry- Returns:
- the
markupViewattribute of theliferay-ui:icontag instance for the Control Menu entry
-
hashCode
public int hashCode() -
includeBody
public boolean includeBody(javax.servlet.http.HttpServletRequest httpServletRequest, javax.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- 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(javax.servlet.http.HttpServletRequest httpServletRequest, javax.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- 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
public boolean isPanelStateOpen(javax.servlet.http.HttpServletRequest httpServletRequest, String key) - Specified by:
isPanelStateOpenin interfaceProductNavigationControlMenuEntry
-
isShow
public boolean isShow(javax.servlet.http.HttpServletRequest httpServletRequest) throws com.liferay.portal.kernel.exception.PortalException Description copied from interface:ProductNavigationControlMenuEntryReturnstrueif the Control Menu entry should be displayed in the request's context.- Specified by:
isShowin interfaceProductNavigationControlMenuEntry- 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
public boolean isUseDialog()Description copied from interface:ProductNavigationControlMenuEntryReturnstrueif the Control Menu entry should be opened in a dialog window.- Specified by:
isUseDialogin interfaceProductNavigationControlMenuEntry- Returns:
trueif the Control Menu entry should be opened in a dialog window;falseif it should open in the current window
-
setPanelState
public void setPanelState(javax.servlet.http.HttpServletRequest httpServletRequest, String key, String panelState) - Specified by:
setPanelStatein interfaceProductNavigationControlMenuEntry
-