com.liferay.product.navigation.control.menu

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 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.
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.

Method Detail

getData

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.

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

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.

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

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.

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

java.lang.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

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.

Parameters:

locale - the label's retrieved locale

Returns:

the Control Menu entry's label

getLinkCssClass

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.

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

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.

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

getURL

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.

Parameters:

httpServletRequest - the request that renders the Control Menu entry

Returns:

the url attribute of the liferay-ui:icon tag instance for the Control Menu entry

includeBody

boolean includeBody(javax.servlet.http.HttpServletRequest httpServletRequest,
                    javax.servlet.http.HttpServletResponse httpServletResponse)
             throws java.io.IOException

Returns true if the Control Menu entry body's HTML should be rendered.

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:

java.io.IOException - if an IO exception occurred

includeIcon

boolean includeIcon(javax.servlet.http.HttpServletRequest httpServletRequest,
                    javax.servlet.http.HttpServletResponse httpServletResponse)
             throws java.io.IOException

Returns true if the Control Menu entry icon's HTML should be rendered.

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:

java.io.IOException - if an IO exception occurred

isShow

boolean isShow(javax.servlet.http.HttpServletRequest httpServletRequest)
        throws com.liferay.portal.kernel.exception.PortalException

Returns true if the Control Menu entry should be displayed in the request's context.

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

boolean isUseDialog()

Returns true if the Control Menu entry should be opened in a dialog window.

Returns:

true if the Control Menu entry should be opened in a dialog window; false if it should open in the current window