Sun Java System Portal Server 7.1 Technical Reference

Chapter 20 Display Profile Properties: Container Provider Properties

This chapter contains the following sections:

Introduction

This 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.

See the Javadocs for more information on these containers.

Available and Selected List

All 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.

Note –

Containers are not required to make use of the available and selected channel lists in the display profile. A container may manage its contained channels in other implementation dependent ways. However, it is recommended that containers use the display profile available and selected channel lists in order to standardize how they are administrated.

The list of required container properties and their description are:

Available

Defines a list of all available channels for this container. The <Available> and </Available> tags define the list, and the <Reference value=> tag defines the list items. For example:

<Available>
<Reference value="App"/>
<Reference value="Bookmark"/>
</Available>

Selected

Defines a list of selected channels for this container. Only selected channels are displayed on the Desktop. The <Selected> and </Selected> tags define the list, and the <Reference value=> tag defines the list items. For example:

<Selected>
 <Reference value="App"/>
<Reference value="Bookmark"/>
</Selected>

Common Properties for Table Container

The following table lists the common properties for table containers and their description.

The <Collection name> </Collection> tags define a list to contain these properties, which are set with the <String> tag.

Table 20–1 Table Container Properties


Property Tag	Description
`parentTabContainer`	Contained table containers have the `parentTabContainer` property whose value is the name of the tab container in which the contained table container is contained. If the contained table container has to be used in some other tab container, change this property value to the respective tab container name.
`refreshParentContainerOnly`
`layout`	Defines the width of the table columns. Layout one (1) refers to thin-thick, layout two (2) refers to thick-thin, and layout three (3) refers to thin-thick-thin.
`thin_popup_height`	Defines the window height in pixels for the thin channel in the detached window.
`thin_popup_width`	Defines the window width in pixels for the thin channel in the detached window.
`thick_popup_height`	Defines the window height in pixels for the thick channel in the detached window.
`thick_popup_width`	Defines the window width in pixels for the thick channel in the detached window.
`fullwidth_popup_height`	Defines the window height in pixels for the full_top or full_bottom channel in the detached window.
`fullwidth_popup_width`	Defines the window width in pixels for the full_top or full_bottom channel in the detached window.
`defaultChannelIsMinimizable`	Defines the `isMinimizable` default value for the channels in this container. If you define a default value, then you do not have to define `isMinimizable` for all the leaf channels in the container. You can change the value for a leaf channel in the container if needed.
`defaultchannelsIsMaximizable`	Defines the `isMaximizable` default value for the channels in this container. If you define a default value, then you do not have to define `isMaximizable` for all the leaf channels in the container. You can change the value for a leaf channel in the container if needed.
`defaultChannelIsMinimized`	Defines the `isMinimized` default value for the channels in this container. If you define a default value, then you do not have to define `isMinimized` for all the leaf channels in the container. You can change the value for a leaf channel in the container if needed.
`defaultChannelIsDetached`	Defines the `isDetached` default value for the channels in this container. If you define a default value, then you do not have to define `isDetached` for all the leaf channels in the container. You can change the value for a leaf channel in the container if needed.
`defaultChannelIsDetachable`	Defines the `isDetachable` default value for the channels in this container. If you define a default value, then you do not have to define `isDetachable` for all the leaf channels in the container. You can change the value for a leaf channel in the container if needed.
`defaultChannelIsRemovable`	Defines the `isRemovable` default value for the channels in this container. If you define a default value, then you do not have to define `isRemoveable` for all the leaf channels in the container. You can change the value for a leaf channel in the container if needed.
`defaultChannelHasFrame`	Defines the `hasFrame` default value for the channels in this container. If you define a default value, then you do not have to define `hasFrame` for all the leaf channels in the container. You can change the value for a leaf channel in the container if needed.
`defaultChannelIsMovable`	Defines the `isMovable` default value for the channels in this container. If you define a default value, then you do not have to define `isMovable` for all the leaf channels in the container. You can change the value for a leaf channel in the container if needed.
`defaultChannelColumn`	Defines the column number default value for the channels in this container. If you define a default value, then you do not have to define the column number for all the leaf channels in the container. You can change the value for a leaf channel in the container if needed.
`defaultChannelRow`	Defines the row number default value for the channels in this container. If you define a default value, then you do not have to define row number for all the leaf channels in the container. You can change the value for a leaf channel in the container if needed.
`channelsIsMinimized`	Defines a collection property to contain the `isMinimized` value for channels in this container.
`channelsIsDetached`	Defines a collection property to contain the `isDetached` value for channels in this container.
`channelsHasFrame`	Defines a collection property to contain the `hasFrame` value for channels in this container.
`channelsIsMinimizable`	Defines a collection property to contain the `isMinimizable` value for channels in this container.
`channelsIsMaximizable`	Defines a collection property to contain the `isMaximizable` value for channels in this container.
`channelsRow`	Defines a collection property to contain the row number value for channels in this container.
`channelsColumn`	Defines a collection property to contain the column number value for channels in this container.
`channelsIsMovable`	Defines a collection property to contain the `isMovable` value for channels in this container.
`channelsIsDetachable`	Defines a collection property to contain the `isDetachable` value for channels in this container.
`channelsIsRemovable`	Defines a collection property to contain the `isRemovable` value for channels in this container.
`borderlessChannels`	Defines the collection property to contain the channel name and Boolean value pair for specifying border-less channels in this container. A value of `true` means the channel does not have border.
`defaultBorderlessChannel`	Defines the default value for the border-less channels in this container. If you define a default value, then you do not have to define `borderlessChannels` for all leaf channels in the container. You can change the value for a leaf channel in the container if needed.

Common Properties for Tab Container

The list of the properties common to all TabContainerProviders and their description are:

startTab: Tab that is displayed when the user logs in.
makeTabChannel: Container channel name to be used when the user creates a new tab.
makeTabProvider: Container provider to be used as a base provider when the user creates a new tab.
maxTabs: The maximum number of tabs that can be selected on the user’s Desktop.
channelNumber: Used in the naming of newly created tabs by user.
contentChannel: The content channel to be used as the Content page for a user created tab.
TabProperties: The collection property TabProperties creates the new tab. There needs to be a one-to-one mapping between the contents of the TabProperties collection and the available or selected tabs. That is, for every tab specified in the available or selected list, a new collection needs to be defined inside TabProperties collection.

Other Container Properties

The list of properties that are common to all container providers and their description are:

presetThemeChannel: Defines the preset theme channel for the container. The JSP™ defined in the channel displays the Theme->Preset Themes page.
customThemeChannel: Defines the custom theme channel for the container. The JSP defined in the channel displays the Theme-> Custom Theme page.
editContainerName: Defines the edit container channel for this container. When a leaf channel defined in this container is of the type edit_subset, then the edit container channel is used to display a frame for the Edit page for the leaf channel.