Sun Java System Portal Server 6 2005Q1 Technical Reference Guide |
Chapter 28
Display Profile Properties: Container Provider PropertiesThis chapter contains the following sections:
IntroductionThis chapter contains information on the display profile definitions and the properties of the building-block and internally used container providers that ship with Sun Java System Portal Server software.
Container providers enable you to aggregate channels inside the Desktop. The container building-block providers are building blocks in a sense since you can also customize them or use them differently by changing the container properties. They include:
- JSPTableContainerProvider - JSPTableContainerProvider is an extension of JSPProvider. This JSP table provider displays the content channels in a table.
- JSPTabContainerProvider - JSPTabContainerProvider is an extension of JSPProvider. This tab container provider displays a channel that is made up of a number of tabs with titles on them. By default, the JSPTabContainerProvider uses JSPTableContainer to lay out content for each tab. However, it can use JSPTableContainer, JSPSingleContainer, or JSPTabContainer to layout content for each tab.
- JSPSingleContainerProvider - JSPSingleContainerProvider is an extension of the JSP container provider. The single container provider displays one channel in it.
- TemplateTableContainerProvider - TemplateTableContainerProvider is the template-based table container. This provider displays the content channels in a table.
- TemplateTabContainerProvider - TemplateTabContainerProvider is the template-based tab container. TemplateTabContainerProvider contains support for a number of tabs in it.
See the Javadocs for more information on these containers.
Available and Selected ListAll containers must define a list of available and selected channels. The presence of these is what mainly distinguishes a container from a channel.
Conceptually, the available list defines the set of channels that can be displayed in the container. The selected list defines those that are actually displayed in the container.
To take a specific example, consider the table container. Table containers use the available channel list to store channels that the user may add to their Desktop. The selected list is used to store the set of channels that are visible in their portal page. Typically, the selected channels are a subset of the available channels.
The following is a list of the required container properties. This two column table lists the properties in the first (left) column and a brief description in the second (right) column.
Common Properties for Table ContainerThe following are the common properties for table containers. This two column table lists the property tags in the first column and a brief description in the second column.
The <Collection name> </Collection> tags define a list to contain these properties, which are set with the <String> tag.
Common Properties for Tab ContainerThe following is a list of the properties common to all TabContainerProviders. This two column table lists the properties in the first (left) column and a brief description in the second (right) column.
Other Container PropertiesThe following is a list of properties that are common to all container providers. This two column table lists the property in the first column and a brief description in the second column.