« Back to Layout

Add runtime portlets to a layout

Intro #

In some cases you may need to have a portlet show up on every single page every time. Instead of adding it manually everytime you create a new page, you can embed portlets in your custom Layout Template

Since Liferay version 4.3.x we have the ability to create runtime portlets and store them in layout files.

Layout example #

Here is an example:

 
  <table id="layout-grid">
   <tr>
    <td class="lfr-column thirty" id="left" valign="top">
     $processor.processPortlet("71")
     $processor.processColumn("left")
    </td>
    <td class="lfr-column seventy" id="column-1" valign="top">
     $processor.processPortlet("73")
     $processor.processColumn("column-1")
    </td>
   </tr>
  </table>
 

This is a typical layout template, with runtime portlets (navigation and breadcrumb) forced to always be above every other portlet.

Managing Instanceable Portlets #

In case you want to embed instanceable portlets, you can do it this way:

$processor.processPortlet("71_INSTANCE_abc1")

where abc1 can be a random four character code to differentiate instances of the same portlet being placed in the same page.

Embeding Custom Portlets #

If we need to add custom portlets to a page, we can do it this way:

$processor.processPortlet("portletId_WAR_webapplicationcontext_INSTANCE_abc2")

Configuring embedded portlets #

Unfortunately the $processor.processPortlet(...) mechanism does not allow configuration (portlet preferences) to be passed to the portlets. However, there's a workaround: You can use the same mechanics as in a theme - taken from LPS-15746:

$velocityPortletPreferences.setValue("portlet-setup-show-borders", "false")
$velocityPortletPreferences.setValue("header-type", "none")
$velocityPortletPreferences.setValue("root-layout-type", "absolute")
$velocityPortletPreferences.setValue("root-layout-level", "2")
$velocityPortletPreferences.setValue("included-layouts", "buderusleft")
$velocityPortletPreferences.setValue("nested-children", "true")
$theme.runtime("71_INSTANCE_abcd", "", $velocityPortletPreferences.toString())
$velocityPortletPreferences.reset() 

Related Articles #

0 Attachments
38273 Views
Average (2 Votes)
The average rating is 3.0 stars out of 5.
Comments
Threaded Replies Author Date
any details about runtime for journal content... delang j November 24, 2008 7:44 AM
I can still minimize, maximmize and configure... Dennis Greiffenberg June 8, 2010 11:37 PM
Is it not possible to do this for 'Poll... Bart Simpson September 22, 2011 4:34 AM
How can I add a different journal portlets to... armando ponce March 28, 2012 8:39 AM
added the information for how to configure a... Olaf Kock June 13, 2012 11:44 AM
From where do you get a portlet instance id?... the denu July 10, 2012 6:37 AM
I'd tried it with Liferay 6.1.1, but It doesn't... Juan Antonio Girón October 1, 2012 7:55 AM

any details about runtime for journal content which is display article
Posted on 11/24/08 7:44 AM.
I can still minimize, maximmize and configure the portlets (owner of the page, since private page pre-populated with default content). How can I prevent users from changing these settings?
Posted on 6/8/10 11:37 PM.
Is it not possible to do this for 'Poll Display' portlet ?
$processor.processPortlet("59")
for Poll display doesn't work.
Posted on 9/22/11 4:34 AM in reply to Dennis Greiffenberg.
How can I add a different journal portlets to the layout and make the unique, so that when an author selects content for the journal, don't affect other journals?
Posted on 3/28/12 8:39 AM.
added the information for how to configure a portlet
Posted on 6/13/12 11:44 AM in reply to armando ponce.
From where do you get a portlet instance id? For example: portletId_WAR_webapplicationcontext_INSTANCE_abc2, and I mean that is custom portlet, not one included with Liferay?
Posted on 7/10/12 6:37 AM in reply to Olaf Kock.
I'd tried it with Liferay 6.1.1, but It doesn't work.
How can I use "$processor.processPortlet" with Liferay 6.1.1?
Posted on 10/1/12 7:55 AM in reply to Maciej Witwicki.