Customizing the Personal Menu

The Personal Menu is a portlet in Liferay DXP, and is the only item occupying the User Personal Bar out of the box. You can add entries to the Personal Menu by implementing the PersonalMenuEntry interface. If you’re adding a portlet entry to the Personal Menu, the process is slightly different. Both approaches are covered below.

Adding an Entry to the Personal Menu

Follow these steps. SignOutPersonalMenuEntry.java is used as an example throughout these steps:

1. Create an OSGi module and place a new Java class into a package in its src folder.

2. In the @Component annotation, specify the two properties shown below to place your new entry in the Personal Menu:

   • product.navigation.personal.menu.group: determines the section where the entry will be placed.

   • product.navigation.personal.menu.entry.order: determines the order of entries within each section. Note that sections are not labelled. To create a new section, assign the group property a value other than those for the four default sections (100, 200, 300, and 400).

   

   Figure 1: The Personal Menu is organized into four sections.

   Here’s an example:

   @Component(
   	immediate = true,
   	property = {
       "product.navigation.personal.menu.group:Integer=400",
   		"product.navigation.personal.menu.entry.order:Integer=100"
   	},
   	service = PersonalMenuEntry.class
   )
   public class SignOutPersonalMenuEntry implements PersonalMenuEntry {
   

3. Include the interface’s methods. SignoutPersonalMenuEntry uses getLabel and getPortletURL, which are the only two that are mandatory. getLabel retrieves a language key to label the entry in the UI:

   	@Override
   	public String getLabel(Locale locale) {
   		return LanguageUtil.get(locale, "sign-out");
   	}
   

   getPortletURL returns the URL for the portlet or page you want to access with the entry:

   	public String getPortletURL(HttpServletRequest httpServletRequest)
   		throws PortalException {
   
   		ThemeDisplay themeDisplay =
   			(ThemeDisplay)httpServletRequest.getAttribute(
   				WebKeys.THEME_DISPLAY);
   
   		return themeDisplay.getURLSignOut();
   	}
   
   }
   

That’s all you need to implement the interface. However, the PersonalMenuEntry interface includes a number of other methods that you can use if you need them:

getIcon: identify an icon to display in the entry.

isActive: indicate whether the entry is currently active.

isShow: write logic to determine under what circumstances the entry is displayed.

Learn how to add a portlet entry to the Personal Menu next.

Adding a Portlet Entry to the Personal Menu

If you’re adding a portlet to the Personal Menu, you can extend the BasePersonalMenuEntry class to save time. Follow these steps:

1. Create an OSGi module and place a new Java class into a package in its src folder.

2. In the @Component annotation, specify the two properties shown below to place your new entry in the Personal Menu:

   • product.navigation.personal.menu.group: determines the section where the entry will be placed.

   • product.navigation.personal.menu.entry.order: determines the order of entries within each section. Note that sections are not labelled. To create a new section, assign the group property a value other than those for the four default sections (100, 200, 300, and 400).

   An example is shown below:

   @Component(
   	immediate = true,
   	property = {
   		"product.navigation.personal.menu.entry.order:Integer=100",
   		"product.navigation.personal.menu.group:Integer=300"
   	},
   	service = PersonalMenuEntry.class
   )
   public class MyAccountPersonalMenuEntry extends BasePersonalMenuEntry {
   

3. Override the getPortletId() method to provide the portlet’s ID, as shown in the example below:

   public class MyAccountPersonalMenuEntry extends BasePersonalMenuEntry {
   
   	@Override
   	public String getPortletId() {
   		return UsersAdminPortletKeys.MY_ACCOUNT;
   	}
   
   }
   

   The BasePersonalMenuEntry class automatically determines the label, portlet URL, state, and visibility based on the portlet ID.

Once you’ve completed your implementation and deployed your module, your new entry is displayed in the personal menu.

Related Topics

• Customizing the Product Menu
• Customizing the Control Menu