public interface ProductNavigationControlMenuEntry
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.
| Modifier and Type | Method and Description |
|---|---|
java.util.Map<java.lang.String,java.lang.Object> |
getData(javax.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. |
java.lang.String |
getIcon(javax.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. |
java.lang.String |
getIconCssClass(javax.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. |
java.lang.String |
getKey()
Returns the Control Menu entry's key.
|
java.lang.String |
getLabel(java.util.Locale locale)
Returns the label that is displayed in the user interface when the
Control Menu entry is included in the tag instance.
|
java.lang.String |
getLinkCssClass(javax.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. |
java.lang.String |
getMarkupView(javax.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. |
java.lang.String |
getURL(javax.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(javax.servlet.http.HttpServletRequest httpServletRequest,
javax.servlet.http.HttpServletResponse httpServletResponse)
Returns
true if the Control Menu entry body's HTML should be
rendered. |
boolean |
includeIcon(javax.servlet.http.HttpServletRequest httpServletRequest,
javax.servlet.http.HttpServletResponse httpServletResponse)
Returns
true if the Control Menu entry icon's HTML should be
rendered. |
default boolean |
isRelevant(javax.servlet.http.HttpServletRequest httpServletRequest) |
boolean |
isShow(javax.servlet.http.HttpServletRequest httpServletRequest)
Returns
true if the Control Menu entry should be displayed
in the request's context. |
boolean |
isUseDialog()
Returns
true if the Control Menu entry should be opened in a
dialog window. |
java.util.Map<java.lang.String,java.lang.Object> getData(javax.servlet.http.HttpServletRequest httpServletRequest)
data attribute of the
liferay-ui:icon tag instance for the Control Menu entry.httpServletRequest - the request that renders the Control Menu
entrydata attribute of the
liferay-ui:icon tag instance for the Control Menu
entryjava.lang.String getIcon(javax.servlet.http.HttpServletRequest httpServletRequest)
icon attribute
of the liferay-ui:icon tag instance for the Control Menu
entry.httpServletRequest - the request that renders the Control Menu
entryicon attribute of the
liferay-ui:icon tag instance for the Control Menu
entryjava.lang.String getIconCssClass(javax.servlet.http.HttpServletRequest httpServletRequest)
iconCssClass attribute of the liferay-ui:icon
tag instance for the Control Menu entry.httpServletRequest - the request that renders the Control Menu
entryiconCssClass attribute of the
liferay-ui:icon tag instance for the Control Menu
entryjava.lang.String getKey()
java.lang.String getLabel(java.util.Locale locale)
locale - the label's retrieved localejava.lang.String getLinkCssClass(javax.servlet.http.HttpServletRequest httpServletRequest)
linkCssClass attribute of the liferay-ui:icon
tag instance for the Control Menu entry.httpServletRequest - the request that renders the Control Menu
entrylinkCssClass attribute of the
liferay-ui:icon tag instance for the Control Menu
entryjava.lang.String getMarkupView(javax.servlet.http.HttpServletRequest httpServletRequest)
markupView attribute of the liferay-ui:icon tag
instance for the Control Menu entry.httpServletRequest - the request that renders the Control Menu
entrymarkupView attribute of the
liferay-ui:icon tag instance for the Control Menu
entryjava.lang.String getURL(javax.servlet.http.HttpServletRequest httpServletRequest)
url attribute of the
liferay-ui:icon tag instance for the Control Menu entry.httpServletRequest - the request that renders the Control Menu
entryurl attribute of the
liferay-ui:icon tag instance for the Control Menu
entryboolean includeBody(javax.servlet.http.HttpServletRequest httpServletRequest,
javax.servlet.http.HttpServletResponse httpServletResponse)
throws java.io.IOException
true if the Control Menu entry body's HTML should be
rendered.httpServletRequest - the request that renders the Control Menu
entryhttpServletResponse - the response that renders the Control Menu
entrytrue if the Control Menu entry body's HTML should be
rendered; false otherwisejava.io.IOException - if an IO exception occurredboolean includeIcon(javax.servlet.http.HttpServletRequest httpServletRequest,
javax.servlet.http.HttpServletResponse httpServletResponse)
throws java.io.IOException
true if the Control Menu entry icon's HTML should be
rendered.httpServletRequest - the request that renders the Control Menu
entryhttpServletResponse - the response that renders the Control Menu
entrytrue if the Control Menu entry icon's HTML should be
rendered; false otherwisejava.io.IOException - if an IO exception occurreddefault boolean isRelevant(javax.servlet.http.HttpServletRequest httpServletRequest)
boolean isShow(javax.servlet.http.HttpServletRequest httpServletRequest)
throws com.liferay.portal.kernel.exception.PortalException
true if the Control Menu entry should be displayed
in the request's context.httpServletRequest - the request that renders the Control Menu
entrytrue if the Control Menu entry should be displayed
in the request's context; false otherwisecom.liferay.portal.kernel.exception.PortalException - if a portal exception occurredboolean isUseDialog()
true if the Control Menu entry should be opened in a
dialog window.true if the Control Menu entry should be opened in a
dialog window; false if it should open in the
current window