JBoss.orgCommunity Documentation
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.
This Portlet allows users to register a new account and choose a preferred language for displaying the Portal interface.
This Portlet is used to manage user information, groups of users and groups memberships.
This Portlet is used to manage different application categories. You can add, edit, set permissions and delete a category and its applications.
This Portlet is used to translate a word or a phrase from the current language to another language.
The Star Toolbar Portlet is used to change language and skin of the portal or to sign out.
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:
This Portlet is considered the welcome gateway of a Portal. It contains the organization's slogan, logo, and icons etc.
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.
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.
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.
This Portlet displays the 'path' the user has taken from the home page to arrive at the currrent page.
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.
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.
This Portlet allows users to view a gadget in canvas mode.
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.
Click on Dashboard in the toolbar to access the Dashboard portlet.
Click on Add Gadgets to open the Dashboard Workspace.
The active Dashboard can be individually named by clicking on the default name ("Click and Type Page Name") where it appears below the current user name (see image below) and entering a new name.
The Dashboard Workspace lists all available gadgets. There are four gadgets built into GateIn 3.0 by default, however you can add many more.
Default Gadgets:
The calendar gadget allows users to switch easily between daily, monthly and yearly view and, again, is customizable to match your portal's theme.
This application helps you organize your day and work group. It is designed to keep track of your tasks in a convenient and transparent way. Tasks can be highlighted with different colors.
This mini-application lets you perform most basic arithmetic operations and can be themed to match the rest of your portal.
An RSS reader, or aggregator, collates content from various, user-specified feed sources and displays them in one location. This content can include, but isn't limited to, news headlines, blog posts or email. The RSS Reader gadget displays this content in a single window on your Portal page.
Further gadgets can be obtained from the Google Gadget site. GateIn 3.0 is compatible with most of the gadgets available here.
To add more gadgets from external sources:
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
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.
Return to your portal and click the Dashboard link in the toolbar.
Click on Add Gadgets in the Dashboard to open the Dashboard Workspace.
The Dashboard Workspace dialog appears:
Paste the URL obtained in step 1 into the text box above the gadget list.
Click on the plus icon to add the new gadget to the page.