JBoss.orgCommunity Documentation

Chapter 3. Portlets

3.1. Functional Portlets
3.2. Interface Portlets
3.3. Dashboard Portlet
3.3.1. Using the Dashboard Workspace
3.3.2. Add Gadgets

Portlets are pluggable user interface components that are managed and displayed within a portal. Functional Portlets support all functions of a Portal. They are built into the portal and are accessed via toolbar links as required when actioning portal tasks.

GateIn 3.0 provides the following portlets by default.

The Interface Portlets are the face of the Portal. They provide the means for users to interact with the portal. GateIn 3.0 consists of the following Interface Portlets:

Banner Portlet

This Portlet is considered the welcome gateway of a Portal. It contains the organization's slogan, logo, and icons etc.

HomePage Portlet

This Portlet is used to provide the home page for a portal. The home page is the first page displayed when you visit the site.

Navigation Portlet

This Portlet provides a navigation bar. A is a menu that helps users to visualize the structure of a site and provide links to quickly move from page to page.

Sitemap Portlet

This Portlet is used to provide a site map page of a web site. It lists pages on a website, typically organized in hierarchical fashion.

Breadcumbs Portlet

This Portlet displays the 'path' the user has taken from the home page to arrive at the currrent page.

Dashboard Portlet

This portlet is used for hosting mini-applications known as gadgets. The dashboard uses a variety of graphical effects for displaying, opening, and using gadgets.

Refer to Section 3.3, “Dashboard Portlet” or Chapter 7, Portlets and Gadgets Administration for more information.

Iframe Portlet

This Portlet is used to create inline frames (IFrame) elements for a site. An Iframe is a HTML element which can embed another document into a parent HTML document. By using IFrames, embedded data is displayed inside a sub-window of browser.

Gadget Wrapper Portlet

This Portlet allows users to view a gadget in canvas mode.

Footer Portlet

This Portlet provides the footer for a site. This footer provides information or links about the site's author/institutional sponsor, the date of the last revision made to the site, copyright information, comments form and navigational links.

The Dashboard portlet is used for hosting mini applications known as gadgets. The Dashboard uses a variety of graphical effects for displaying, opening and using gadgets. Gadgets can be moved, rearranged, created and deleted. More than one instance of the same gadget can be opened at the same time and each instance of the same gadget can have different settings. The gadgets instances are as independent as different portlets instances.

To add more gadgets from external sources:

  1. Obtain the URL (.xml or .rss) of the gadget you wish to add from the gadget source.

    For example; the gadgets available at Google Gadget provide a link to View source. Clicking on this will open a page showing the gadget's XML source. Use the URL of this page in the Dashboard Workspace. The URL should end in .xml

    URL Types

    Remote gadgets can be only created using an .xml link or RSS URL. However, if you use a link that generates an RSS feed (for example: http://feeds.feedburner.com/gatein), a new RSS reader gadget will be created automatically.

  2. Return to your portal and click the Dashboard link in the toolbar.

  3. Click on Add Gadgets in the Dashboard to open the Dashboard Workspace.

  4. The Dashboard Workspace dialog appears:

  5. Paste the URL obtained in step 1 into the text box above the gadget list.

  6. Click on the plus icon to add the new gadget to the page.