Sun Java System Portal Server 7.1 Technical Reference

Chapter 71 Desktop Templates in the Developer Sample Directory

This chapter contains the following sections:

MyFrontPageTemplatePanelContainer
PredefinedFrontPageTemplatePanelContainerProvider and PredefinedSamplesTemplatePanelContainerProvider
SamplesTemplatePanelContainer and ToolsTemplatePanelContainer
developersample directory template files

MyFrontPageTemplatePanelContainer

The templates available in the MyFrontPageTemplatePanelContainer directory and their description are:

banner.template: The banner across the top of the Desktop pages.
menubar.template: HTML for the menubar across the bottom of the Desktop pages, including the Edit, Layout, and Content pages, and containing Home, Help and Log Out links.

PredefinedFrontPageTemplatePanelContainerProvider

The templates available in the PredefinedFrontPageTemplatePanelContainerProvider directory and their description are:

banner.template: The banner across the top of the Desktop pages.
bareProviderWrapper.template: Template for each provider wrapper with no titlebar.
contentBarInContent.template: Content bar for template displayed when a user selects Content on any other page’s Content bar.
contentBarInLayout.template: Content bar for template displayed when user selects Layout on any other page’s Content bar.
contentLayout.template: Content bar for template displayed on the Desktop before the user selects Content or Layout.
contentTemplate.template: The HTML template for the Content (Channels) page that displays when a user selects Content.
layout1Template.template: left/thin, right/wide.
layout2Template.template: left/wide, right/thin.
layout3Template.template: left/thin, center/wide, right/thin.
layout4Template.template: left/thin, center/thin, right/thin.
layoutFullBottom.template: Partial HTML template for Layout pages when the user has a full width channel available at the bottom of the layout.
layoutFullTop.template: Partial HTML template for Layout pages when the user has a full width channel available at the top of the layout.
maximizedTemplate.template: Template of a provider when it’s in its maximized state.
menubar.template: HTML for the menubar across the bottom of the Desktop pages, including the Edit, Layout, and Content pages and containing Home, Help and Log Out links.
minimized.template: Template of a provider when it’s in its minimized state - just the title/button bar showing, no content area showing.
optionsTemplate.template: Template for the Options page of the Desktop.
popupMenubar.template: Menubar to be used in popup windows.
popupTemplate.template: Used to show provider/channel content in detached windows. Similar use to providerWrapper.template, but not in a table structure.
providerWrapper.template: Template that all providers and channels use for layout on Desktop. Defines the look of the border of the providers and channels on the screen.
userTemplate.template: The base Desktop layout structure document. Very little in this file, as most of the content of the Desktop is swapped in during processing in the servlets.
arrangeProvider.js: JavaScript code used in the Desktop Layout page.
launchPopup.js: JavaScript code to launch a popup window.
performColumnSubstitution.js: JavaScript code used on the Layout page.
performSubstitution.js: JavaScript code used on the Layout page.
removeProvider.js: JavaScript code used to remove a channel from the Desktop.
selectAll.js: JavaScript code used on the Layout page.
switchColumns.js: JavaScript code used on the Layout page.

PredefinedSamplesTemplatePanelContainerProvider

The templates available in the PredefinedFrontPageTemplatePanelContainerProvider directory and their description are:

banner.template: The banner across the top of the Desktop pages.
bareProviderWrapper.template: Template for each provider wrapper with no titlebar.
contentBarInContent.template: Content bar for template displayed when a user selects Content on any other page’s Content bar.
contentBarInLayout.template: Content bar for template displayed when user selects Layout on any other page’s Content bar.
contentLayout.template: Content bar for template displayed on the Desktop before the user selects Content or Layout.
contentTemplate.template: The HTML template for the Content (Channels) page that displays when a user selects Content.
layout1Template.template: left/thin, right/wide.
layout2Template.template: left/wide, right/thin.
layout3Template.template: left/thin, center/wide, right/thin.
layout4Template.template: left/thin, center/thin, right/thin.
layoutFullBottom.template: Partial HTML template for Layout pages when the user has a full width channel available at the bottom of the layout.
layoutFullTop.template: Partial HTML template for Layout pages when the user has a full width channel available at the top of the layout
maximizedTemplate.template: Template of a provider when it’s in its maximized state.
menubar.template: HTML for the menubar across the bottom of the Desktop pages, including the Edit, Layout, and Content pages, and containing Home, Help and Log Out links.
minimized.template: Template of a provider when it’s in its minimized state - just the title/button bar are displayed and no content area is displayed.
optionsTemplate.template: Template for the Options page of the Desktop.
popupMenubar.template: Menubar to be used in popup windows.
popupTemplate.template: Used to show provider/channel content in detached windows. Similar use to providerWrapper.template, but not in a table structure.
providerWrapper.template: Template that all providers and channels use for layout on Desktop. Defines the look of the border of the providers and channels on the screen.
userTemplate.template: The base Desktop layout structure document. Very little in this file, as most of the content of the Desktop is swapped in during processing in the servlets.
launchPopup.js: JavaScript code to launch a popup window.
performColumnSubstitution.js: JavaScript code used on the Layout page.
performSubstitution.js: JavaScript code used on the Layout page.
removeProvider.js: JavaScript code used to remove a channel from the Desktop.
selectAll.js: JavaScript code used on the Layout page.
switchColumns.js: JavaScript code used on the Layout page.

SamplesTemplatePanelContainer

The templates available in the SamplesTemplatePanelContainer directory and their description are:

banner.template: The banner across the top of the Desktop pages.
menubar.template: HTML for the menubar across the bottom of the Desktop pages, including the Edit, Layout, and Content pages, and containing Home, Help and Log Out links.

ToolsTemplatePanelContainer

The templates available in the ToolsTemplatePanelContainer directory and their description are:

banner.template: The banner across the top of the Desktop pages.
menubar.template: HTML for the menubar across the bottom of the Desktop pages, including the Edit, Layout, and Content pages, and containing Home, Help and Log Out links.

developersample

The templates available in the developersample directory and their description are:

AtachCommand.template: Handles reattaching a detached channel.
MaximizeCommand.template: Allows the channel to be displayed in the maximize mode so that the channel occupies the entire Desktop.
detachEditCommand.template: Handles link to the Edit page for the detached channel.
detachCommand.template: Handles detaching a channel.
detachRemoveCommand.template: Handles closing or removing a detached channel.
editCommand.template: Handles link to the Edit page for the detached channel.
helpHref.template: Generates the help URL for each of the channels. Displays the help contents in a new window.
minimizeCommand.template: Allows the channel to be displayed in the minimize mode so that only the title bar of the channel is displayed and no content of the channel is displayed.
normalizeCommand.template: Allows the channel to be displayed in the normal mode so that the channel is displayed in the Desktop, with all other channels in the same table container.
removeCommand.template: Removes the channel.