Developing Portlets

compared with
Version 5 by Deryk Sinotte
on Nov 02, 2012 20:58.


Key
These lines were removed. This word was removed.
These lines were added. This word was added.

View page history


There are 1 changes. View first change.

 h3. Developing Your Own Portlets
  
 {anchor:portletXML}
  
 h4. portlet.xml
  
 ICEfaces makes use of the PortletFaces Bridge to handle the mapping of the portlet lifecycle onto the JSF lifecycle. This has many advantages like enabling proper resource handling and cleaner integration with the portal container. To define your portlet, take a look at the portlet definition of the chat portlet example:
 {code:xml} <portlet>
  <portlet-name>chat-ice2-portlet</portlet-name>
  <display-name>Chat</display-name>
  <portlet-class>org.portletfaces.bridge.GenericFacesPortlet</portlet-class>
  <init-param>
  <name>javax.portlet.faces.defaultViewId.view</name>
  <value>/chat.xhtml</value>
  </init-param>
  <supports>
  <mime-type>text/html</mime-type>
  <portlet-mode>view</portlet-mode>
  </supports>
  <portlet-info>
  <title>ICEfaces 2 Chat</title>
  <short-title>ICEfaces 2 Chat</short-title>
  <keywords>icefaces portlet chat icepush</keywords>
  </portlet-info>
  </portlet>
 {code}
 The important parts are:
 * The *portlet-class*, which needs to be defined as *org.portletfaces.bridge.GenericFacesPortlet*.
 * The *javax.portlet.faces.defaultViewId.view* which should identify the page that is the initial view of the portlet.
  
 h4. web.xml
  
 To prevent the processing of portlet resource URLs to avoid caching of things like bridge.js, the following parameter should be set to false.
 {code:xml}<context-param>
  <param-name>org.icefaces.uniqueResourceURLs</param-name>
  <param-value>false</param-value>
 </context-param>{code}
 {anchor:portletLibDep}
  
 h4. Library Dependencies
  
  The ICEfaces distribution includes a tested release version of the PortletFaces Bridge and is located in:
 {code}
 [icefaces.install.dir]/icefaces/lib/portlets{code}
 * portletfaces-bridge-*.jar
  You must use a portlet bridge to run JSF and ICEfaces portlets in a portal container. See the section on [Portlet Bridges] for more information.

© Copyright 2017 ICEsoft Technologies Canada Corp.