« Zurück zu Development

Creating Tabs in Liferay Portlets

Asset-Tag: customization

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 Anhänge
110299 Angesehen
Durchschnitt (4 Stimmen)
Die durchschnittliche Bewertung ist 2.5 von max. 5 Sternen.
Kommentare
Antworten im Thread Autor Datum
<liferay-ui:tabs names="Sample Tab 1,Sample... Rohit Rai 23. Januar 2009 23:49
hye, I did the same steps to have some tabs in... mipih faical 15. Juni 2009 07:02
How can I do this in navigation.vm???? Secret Developer 30. Juli 2009 13:21
Has anyone resolved the issue with spaces in... Jeff Goodwin 14. August 2009 18:39
Hi ppl, Try using language keys... JP O 23. August 2009 21:55
0 JP O 23. August 2009 22:04
liferay-ui:util does not work with jsp in... Muhammed Shakir 19. Juli 2010 08:47
I got an error in code <liferay-util:include... Linh Nguyen 8. Mai 2011 04:39
for more Liferay Tabs ... Rohit Salecha 24. Mai 2011 01:38
can we use liferay ui tab inside another... Hajri Mohamed 9. Juni 2011 05:51
how to hide/show the tabs using conditions?? ie... ankit yakkundi 14. Juli 2011 03:58
Displaying text on clicking on the tabs works... Ram Manusani 27. Dezember 2011 23:16
Hi by looking at the code that creates the tabs... Manuel Calvo 8. Juni 2012 06:53
Helpful post Mazhar Alam 17. Juli 2012 03:54
I got this error: liferay-ui:section tag... Imre Telek 1. Juni 2015 07:32
hi i am getting pages when i click on tabs with... Sohi Mankotia 5. September 2012 03:13
hi can some one tell me taglib for <c:if ? nitish tyagi 21. November 2012 23:25
<%@ taglib... Jorik Wartanow 26. Mai 2014 04:01
How to localize tab names? It doesn't... Imre Telek 1. Juni 2015 07:38

<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?
Gepostet am 23.01.09 23:49.
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
Gepostet am 15.06.09 07:02 als Antwort auf Rohit Rai.
How can I do this in navigation.vm????
Gepostet am 30.07.09 13:21.
Has anyone resolved the issue with spaces in tab names?
Gepostet am 14.08.09 18:39.
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!
Gepostet am 23.08.09 21:55.
liferay-ui:util does not work with jsp in custom portlet with expected behavior.
Gepostet am 19.07.10 08:47.
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.
Gepostet am 08.05.11 04:39 als Antwort auf Muhammed Shakir AK Misarwala.
for more Liferay Tabs

http://liferaydemystified.blogspot.com/2011/05/liferay-ui-tabs.html
Gepostet am 24.05.11 01:38 als Antwort auf 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
Gepostet am 09.06.11 05:51 als Antwort auf 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??
Gepostet am 14.07.11 03:58.
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
Gepostet am 27.12.11 23:16 als Antwort auf 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>
Gepostet am 08.06.12 06:53 als Antwort auf Ram Manusani.
Gepostet am 17.07.12 03:54 als Antwort auf 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");
Gepostet am 05.09.12 03:13.
hi can some one tell me taglib for <c:if ?
Gepostet am 21.11.12 23:25.
<%@ taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c" %>
Gepostet am 26.05.14 04:01 als Antwort auf nitish tyagi.
I got this error: liferay-ui:section tag doesn't have param and name attributes.
Gepostet am 01.06.15 07:32 als Antwort auf Manuel Calvo.
How to localize tab names? It doesn't translates it If I use comma seperated resource keys in names attribute. It also doesn't work if I use one resource key and try to put each tab name into that string because it creates only one tab with a comma in it's name.
Gepostet am 01.06.15 07:38.