public interface PersonalMenuEntry
liferay-product-navigation:user-personal-menu tag instance to render a new
user personal menu entry.
Implementations must be registered in the OSGi Registry. The user personal
menu entry order is determined by the product.navigation.personal.menu.entry.order property value. The entry's
section placement in the menu is determined by the product.navigation.personal.menu.group property value.
| Modifier and Type | Method and Description |
|---|---|
default java.lang.String |
getIcon(javax.portlet.PortletRequest portletRequest)
Returns the icon name to display in the entry.
|
default com.liferay.portal.kernel.json.JSONObject |
getJSOnClickConfigJSONObject(javax.servlet.http.HttpServletRequest httpServletRequest) |
java.lang.String |
getLabel(java.util.Locale locale)
Returns the label that is displayed in the user personal menu.
|
default java.lang.String |
getOnClickJSModuleURL() |
java.lang.String |
getPortletURL(javax.servlet.http.HttpServletRequest httpServletRequest)
Returns the URL used to render a portlet based on the servlet request
attributes.
|
default boolean |
isActive(javax.portlet.PortletRequest portletRequest,
java.lang.String portletId)
Returns
true if the entry is the current active entry. |
default boolean |
isShow(javax.portlet.PortletRequest portletRequest,
com.liferay.portal.kernel.security.permission.PermissionChecker permissionChecker)
Returns
true if the entry should be displayed in the user
personal menu. |
default java.lang.String getIcon(javax.portlet.PortletRequest portletRequest)
portletRequest - the portlet requestdefault com.liferay.portal.kernel.json.JSONObject getJSOnClickConfigJSONObject(javax.servlet.http.HttpServletRequest httpServletRequest)
java.lang.String getLabel(java.util.Locale locale)
locale - the label's retrieved localedefault java.lang.String getOnClickJSModuleURL()
java.lang.String getPortletURL(javax.servlet.http.HttpServletRequest httpServletRequest)
throws com.liferay.portal.kernel.exception.PortalException
httpServletRequest - the servlet request used to create a portlet's
URLcom.liferay.portal.kernel.exception.PortalException - if a portal exception occurreddefault boolean isActive(javax.portlet.PortletRequest portletRequest,
java.lang.String portletId)
throws com.liferay.portal.kernel.exception.PortalException
true if the entry is the current active entry.portletRequest - the portlet requestportletId - the portlet's IDtrue if the entry is the current active entry; false otherwisecom.liferay.portal.kernel.exception.PortalExceptiondefault boolean isShow(javax.portlet.PortletRequest portletRequest,
com.liferay.portal.kernel.security.permission.PermissionChecker permissionChecker)
throws com.liferay.portal.kernel.exception.PortalException
true if the entry should be displayed in the user
personal menu.portletRequest - the portlet requestpermissionChecker - the permission checkertrue if the entry should be displayed in the user
personal menu; false otherwisecom.liferay.portal.kernel.exception.PortalException