com.liferay.product.navigation.control.menu

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 java.lang.Object
implements ProductNavigationControlMenuEntry

Constructor Summary

Constructors

Constructor and Description
BaseProductNavigationControlMenuEntry()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object object)
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	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.
int	hashCode()
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.
protected boolean	isEmbeddedPersonalApplicationLayout(com.liferay.portal.kernel.model.Layout layout)
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.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.liferay.product.navigation.control.menu.ProductNavigationControlMenuEntry

getLabel, getURL

Constructor Detail

BaseProductNavigationControlMenuEntry

public BaseProductNavigationControlMenuEntry()

Method Detail

equals

public boolean equals(java.lang.Object object)

Overrides:

equals in class java.lang.Object

getData

public java.util.Map<java.lang.String,java.lang.Object> getData(javax.servlet.http.HttpServletRequest httpServletRequest)

Description copied from interface: ProductNavigationControlMenuEntry

Returns the data to be injected as the data attribute of the liferay-ui:icon tag instance for the Control Menu entry.

Specified by:

getData in interface ProductNavigationControlMenuEntry

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

public java.lang.String getIcon(javax.servlet.http.HttpServletRequest httpServletRequest)

Description copied from interface: ProductNavigationControlMenuEntry

Returns the icon name to be injected as the icon attribute of the liferay-ui:icon tag instance for the Control Menu entry.

Specified by:

getIcon in interface ProductNavigationControlMenuEntry

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

public java.lang.String getIconCssClass(javax.servlet.http.HttpServletRequest httpServletRequest)

Description copied from interface: ProductNavigationControlMenuEntry

Returns the icon CSS class to be injected as the iconCssClass attribute of the liferay-ui:icon tag instance for the Control Menu entry.

Specified by:

getIconCssClass in interface ProductNavigationControlMenuEntry

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

public java.lang.String getKey()

Description copied from interface: ProductNavigationControlMenuEntry

Returns the Control Menu entry's key. This key must be unique in the scope of the Control Menu entry selector.

Specified by:

getKey in interface ProductNavigationControlMenuEntry

Returns:

the Control Menu entry's key

getLinkCssClass

public java.lang.String getLinkCssClass(javax.servlet.http.HttpServletRequest httpServletRequest)

Description copied from interface: ProductNavigationControlMenuEntry

Returns the link CSS class to be injected as the linkCssClass attribute of the liferay-ui:icon tag instance for the Control Menu entry.

Specified by:

getLinkCssClass in interface ProductNavigationControlMenuEntry

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

public java.lang.String getMarkupView(javax.servlet.http.HttpServletRequest httpServletRequest)

Description copied from interface: ProductNavigationControlMenuEntry

Returns the markup view string to be injected as the markupView attribute of the liferay-ui:icon tag instance for the Control Menu entry.

Specified by:

getMarkupView in interface ProductNavigationControlMenuEntry

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

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

includeBody

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

Description copied from interface: ProductNavigationControlMenuEntry

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

Specified by:

includeBody in interface ProductNavigationControlMenuEntry

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

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

Description copied from interface: ProductNavigationControlMenuEntry

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

Specified by:

includeIcon in interface ProductNavigationControlMenuEntry

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

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

Description copied from interface: ProductNavigationControlMenuEntry

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

Specified by:

isShow in interface ProductNavigationControlMenuEntry

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

public boolean isUseDialog()

Description copied from interface: ProductNavigationControlMenuEntry

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

Specified by:

isUseDialog in interface ProductNavigationControlMenuEntry

Returns:

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

isEmbeddedPersonalApplicationLayout

protected boolean isEmbeddedPersonalApplicationLayout(com.liferay.portal.kernel.model.Layout layout)