« Back to Development

Creating Tabs in Liferay Portlets

Introduction #

The Liferay "Journal" portlet, has "Articles,Structures,Templates,Recent" tabs inside the portlet. Liferay includes a custom tab tag which allows you to create the same effect in your own portlets. These tabs are essentially just other .jsp pages that are displayed based on the selection of the tab.

In this article, we will modify the Reports Portlet to have tabs. We will create "Sample Tab 1", "Sample Tab 2" and "Sample Tab 3" tabs. In the end, we will have a portlet that will look something like this:

Create Files #

To do this in your own portlet you will need to create the following files:

Create Tab Pages #

Remember to include some plain text in each file

ext/ext-web/docroot/html/portlet/ext/reports/sample_tab_1.jsp:

sample 1
ext/ext-web/docroot/html/portlet/ext/reports/sample_tab_2.jsp:
sample 2
ext/ext-web/docroot/html/portlet/ext/reports/sample_tab_3.jsp:
sample 3

init.jsp #

in init.jsp include the following code:

ext/ext-web/docroot/html/portlet/ext/reports/init.jsp:

<%@ include file="/html/common/init.jsp" %>

<portlet:defineObjects />

view.jsp #

in view.jsp

ext/ext-web/docroot/html/portlet/ext/reports/view.jsp:

<%@ include file="/html/portlet/ext/reports/init.jsp" %>


<%
String tabs1 = ParamUtil.getString(request, "tabs1", "Sample Tab 1");

PortletURL portletURL = renderResponse.createRenderURL();

portletURL.setWindowState(WindowState.NORMAL);

portletURL.setParameter("struts_action", "/ext/reports/view_reports");
portletURL.setParameter("tabs1", tabs1);

String tabNames = "Sample Tab 1,Sample Tab 2,Sample Tab 3";

%>

<liferay-ui:tabs
   names="<%= tabNames %>"
   url="<%= portletURL.toString() %>"
/>

It is recommeded using "<liferay-util:include page>" instead of "<%@ include file= "

<c:if test='<%= tabs1.equals("Sample Tab 1") %>'>
  <liferay-util:include page="/html/portlet/ext/reports/sample_tab_1.jsp" >
</c:if>
<c:if test='<%= tabs1.equals("Sample Tab 2") %>'>
  <liferay-util:include page="/html/portlet/ext/reports/sample_tab_2.jsp" >
</c:if>
<c:if test='<%= tabs1.equals("Sample Tab 3") %>'>
  <liferay-util:include page="/html/portlet/ext/reports/sample_tab_3.jsp" >
</c:if>

explained:

<%
String tabs1 = ParamUtil.getString(request, "tabs1", "Sample Tab 1");

PortletURL portletURL = renderResponse.createRenderURL();

portletURL.setWindowState(WindowState.NORMAL);

portletURL.setParameter("struts_action", "/ext/reports/view_reports");
portletURL.setParameter("tabs1", tabs1);

String tabNames = "Sample Tab 1,Sample Tab 2,Sample Tab 3";

%>

tabs1: holds the value of the tab to be displayed

tabNames: comma delimited list of tab names

(Note: A common mistake is to include spaces before or after the commas. Make sure there are no extra spaces in the variable "tabNames", otherwise the strings wont match with the value in "tabs1". see above)

<liferay-ui:tabs
   names="<%= tabNames %>"
   url="<%= portletURL.toString() %>"
/>

This is a custom Liferay tab tag. This auto-genereates the tabs based on the variables defined above. (defined: "portal\portal-web\docroot\html\taglib\ui\tabs")

<c:if test='<%= tabs1.equals("Sample Tab 1") %>'>
   <liferay-util:include page="/html/portlet/ext/reports/sample_tab_1.jsp" >
</c:if>
<c:if test='<%= tabs1.equals("Sample Tab 2") %>'>
   <liferay-util:include page="/html/portlet/ext/reports/sample_tab_2.jsp" >
</c:if>
<c:if test='<%= tabs1.equals("Sample Tab 3") %>'>
   <liferay-util:include page="/html/portlet/ext/reports/sample_tab_3.jsp" >
</c:if>

Based on the value of tabs1, this will include a different jsp page.

Deploy your code and now take a look at your Reports Portlet. Now your Reports Portlet should look like:

Make page refresh optional #

Use this snippet to do the same thing without requiring page refreshes.

<liferay-ui:tabs
	names="Sample Tab 1, Sample Tab 2, Sample Tab 3"
	refresh="<%= false %>"
>
	<liferay-ui:section>
		sample 1
	</liferay-ui:section>
	<liferay-ui:section>
		sample 2
	</liferay-ui:section>
	<liferay-ui:section>
		sample 3
	</liferay-ui:section>
</liferay-ui:tabs>
0 Attachments
63608 Views
Average (3 Votes)
The average rating is 3.0 stars out of 5.
Comments
Threaded Replies Author Date
<liferay-ui:tabs names="Sample Tab 1,Sample... Rohit Rai January 23, 2009 11:49 PM
hye, I did the same steps to have some tabs in... mipih faical June 15, 2009 7:02 AM
How can I do this in navigation.vm???? Secret Developer July 30, 2009 1:21 PM
Has anyone resolved the issue with spaces in... Jeff Goodwin August 14, 2009 6:39 PM
Hi ppl, Try using language keys... JP O August 23, 2009 9:55 PM
0 JP O August 23, 2009 10:04 PM
liferay-ui:util does not work with jsp in... Muhammed Shakir July 19, 2010 8:47 AM
I got an error in code <liferay-util:include... Linh Nguyen May 8, 2011 4:39 AM
for more Liferay Tabs ... Rohit Salecha May 24, 2011 1:38 AM
can we use liferay ui tab inside another... Hajri Mohamed June 9, 2011 5:51 AM
how to hide/show the tabs using conditions?? ie... ankit yakkundi July 14, 2011 3:58 AM
Displaying text on clicking on the tabs works... Ram Manusani December 27, 2011 11:16 PM
Hi by looking at the code that creates the tabs... Manuel Calvo June 8, 2012 6:53 AM
Helpful post Mazhar Alam July 17, 2012 3:54 AM
hi i am getting pages when i click on tabs with... Sohi Mankotia September 5, 2012 3:13 AM
hi can some one tell me taglib for <c:if ? nitish tyagi November 21, 2012 11:25 PM
<%@ taglib... Jorik Wartanow May 26, 2014 4:01 AM

<liferay-ui:tabs
names="Sample Tab 1,Sample Tab 2,Sample Tab 3"
refresh="<%= false %>"
>
<liferay-ui:section>
sample 1
</liferay-ui:section>
<liferay-ui:section>
sample 2
</liferay-ui:section>
<liferay-ui:section>
sample 3
</liferay-ui:section>
</liferay-ui:tabs>

This code doesn't work for me. The UI is created, but clicking on the tabs deosn't work.
It works if I remove the spaces IN the tab names. Can't we have tabs with two word names?
Posted on 1/23/09 11:49 PM.
hye,
I did the same steps to have some tabs in my portlet but it don't work.
I have the same think in all my tabs.
Can you help me please
Posted on 6/15/09 7:02 AM in reply to Rohit Rai.
How can I do this in navigation.vm????
Posted on 7/30/09 1:21 PM.
Has anyone resolved the issue with spaces in tab names?
Posted on 8/14/09 6:39 PM.
Hi ppl,

Try using language keys as the tab names and then add to language-ext.properties.
now if you try to add "sign-in" as a tab, you'll see it actually displayed as "Sign In".
Enjoy!
Posted on 8/23/09 9:55 PM.
Posted on 8/23/09 10:04 PM.
liferay-ui:util does not work with jsp in custom portlet with expected behavior.
Posted on 7/19/10 8:47 AM.
I got an error in code
<liferay-util:include page="/sample_tab_1.jsp" >
It should be like this
<liferay-util:include page="/sample_tab_1.jsp" servletContext="<%=this.getServletContext() %>"/>

Im using Lifery 6.0.5 and tomcat 6.0.26

Furthermore, you probably need to add taglib in sourcecode to make it work.
like
<%@ taglib uri="/WEB-INF/tld/liferay-ui.tld" prefix="liferay-ui" %>
<%@ taglib uri="/WEB-INF/tld/liferay-util.tld" prefix="liferay-util" %>

which works in my case.
Posted on 5/8/11 4:39 AM in reply to Muhammed Shakir AK Misarwala.
for more Liferay Tabs

http://liferaydemystified.blogspot.com/2011/05/liferay-ui-tabs.html
Posted on 5/24/11 1:38 AM in reply to Linh Nguyen.
can we use liferay ui tab inside another liferay ui tab (nested liferay tabs), i m trying but i m having a null pointer exeption
Posted on 6/9/11 5:51 AM in reply to Rohit Salecha.
how to hide/show the tabs using conditions??
ie if some condition gets satisfies then i want to hide some tabs and show some tabs.
how to implement that??
Posted on 7/14/11 3:58 AM.
Displaying text on clicking on the tabs works fine with me... Is there a way to show portlets on clicking the tabs??

Any solution will be greatly appreciated
Posted on 12/27/11 11:16 PM in reply to ankit yakkundi.
Hi by looking at the code that creates the tabs HTML elements here:
http://www.jarvana.com/jarvana/view/com/liferay/portal/portal-web/6.0.4/por­tal-web-6.0.4.war!/html/taglib/ui/tabs/start.jsp?format=ok

and the JS that displays the tabs here:
http://www.jarvana.com/jarvana/view/com/liferay/portal/portal-web/6.0.4/por­tal-web-6.0.4.war!/html/js/liferay/portal.js

if you want to use refresh="false" you need to add a name attribute to the liferay-ui:section, so the correct code should be:

<liferay-ui:tabs
names="view,search"
values="view,search"
refresh="false"
param=­"tab"
>

<liferay-ui:section
param="tab"
name="view"
>
sample 1
</liferay-ui:section>
<liferay-ui:section
param="tab"
name="search"
>
sa­mple 2
</liferay-ui:section>
</liferay-ui:tabs>
Posted on 6/8/12 6:53 AM in reply to Ram Manusani.
Helpful post
Posted on 7/17/12 3:54 AM in reply to Manuel Calvo.
hi i am getting pages when i click on tabs with <liferay-util:include page="/html/portlet/ext/reports/sample_tab_3.jsp" >

and what is

portletURL.setParameter("struts_action", "/ext/reports/view_reports");
Posted on 9/5/12 3:13 AM.
hi can some one tell me taglib for <c:if ?
Posted on 11/21/12 11:25 PM.
<%@ taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c" %>
Posted on 5/26/14 4:01 AM in reply to nitish tyagi.