Sun Java System Portal Server 7.1 Technical Reference

Chapter 30 JSPs in the developer_sample Directory

This chapter lists the sub directories and the JSPs available under the /var/opt/SUNWportal/portals/<portal_id>/desktop/developer_sample/ directory.

FrameTabContainer

The FrameTabContainer JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/developer_sample/FrameTabContainer directory.

The list of JSPs in the FrameTabContainer directory and their description are:

banner.jsp: Contains the required JavaScript and the body tag for the right frame of the frame tab container.
frameset.jsp: Contains the HTML source for frames of the frameset container.
frametab.jsp: Is the main JSP for the frame tab container and throws out the requested content for each frame based on the request parameters from the frameset JSP.
frametabedit.jsp: Displays the Edit page for the frame tab container where new pages can be added, removed, or renamed.
frametabmenu.jsp: Displays the left frame for the frame tab container that has the list of available pages and links to them.
header.jsp: Displays the product banner that is used by the frame tab container.
makeNewTab.jsp: Provides the content for the Make New Page part of the Sections page in the frame tab container.
makeTopic.jsp: Provides the content for each of the page topics in the Make New Page.
menubar.jsp: Displays the menubar that has the Home, Tabs, Theme, Help, and Logout links.
remove.jsp: Displays the remove, rename, and start links for each of the selected pages of the frame tab container in the Current Tab Settings page.
removeRenameTab.jsp: Displays the Start Page, Tab, and Actions part of the Current Tab Settings page for the frame tab container.
selectedTab.jsp: Displays the content for the right frame of the frame tab container.

JSPContentContainer

The JSPContentContainer JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/developer_sample/JSPContentContainer directory. These JSPs are used for the content view when the Content link is selected in a JSP-based table container.

The JSP available in the JSPContentContainer directory and its description is:

contentedit.jsp: Displays the content Edit page.

JSPCreateChannelContainer

The JSPCreateChannelContainer JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/developer_sample/JSPCreateChannelContainer directory.

The list of JSPs in the JSPCreateChannelContainer directory and their description are:

createchannel.jsp: These JSPs are used for the User Defined Channel page on the Desktop.
createchannelcontent.jsp: To create content in the User Defined Channel page.
createchanneldoedit.jsp: To edit content in the User Defined Channel page.
createchanneledit.jsp: To edit content in the User Defined Channel page.
createchannelui.jsp: To create user interface content in the User Defined Channel page.
deletechannel.jsp: To delete a User Defined Channel page.
deletechannelui.jsp: To delete a user interface in the User Defined Channel page.

JSPCustomThemeContainer

The JSPCustomThemeContainer JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/developer_sample/JSPCustomThemeContainer directory. These JSPs are used when the Custom Theme link is selected in the Themes page.

The list of JSPs in the JSPCustomThemeContainer directory and their description are:

customthemedoedit.jsp: Processes the result from the Custom Theme page.
customthemeedit.jsp: Displays the Custom Theme Edit page.
themepreview.jsp: Displays the preview view of the Custom Theme page.

JSPDynamicSingleContainer

The JSPDynamicSingleContainer JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/Developer_sample/JSPDynamicSingleContainer directory.

The JSP available in the JSPDynamicSingleContainer directory and its description is:

dynamicSingle.jsp: Used by the DynamicSingleContainer to display the channel specified in the request parameter. This JSP uses the Desktop theme.

JSPEditContainer

The JSPEditContainer JSP is located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/developer_sample/JSPEditContainer directory. These JSPs are used when the Edit icon is selected in a channel title bar inside a JSP- based container. Channels that have the editType defined as EDIT_SUBSET use these JSPs. The difference between this JSP and the one from default directory is that this includes the Desktop theme style.

The JSP available in the JSPEditContainer directory and its description is:

edit.jsp: Displays the Edit view of a channel. Also provides a wrapper around the actual Edit view for a given channel.

JSPFrameCustomTableContainerProvider

The JSPFrameCustomTableContainerProvider JSP is located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/developer_sample/JSPFrameCustomTableContainerProvider directory.

JSPFrameCustomTableContainerProvider JSPs are mainly used by the user created pages in the frame tab container. When the user creates a new page from the Sections page in the frame tab container, a new table container is created dynamically. The following JSPs are used by the user created table containers. The difference between this JSP and the one from default directory is that this includes the Desktop theme style.

The JSP available in the JSPFrameCustomTableContainerProvider directory and its description is:

framecustomtable.jsp: Displays the content for the newly created page (table container) from the Sections page.

JSPLayoutContainer

The JSPLayoutContainer JSP is located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/developer_sample/JSPLayoutContainer directory. These JSPs are used to display the Layout view when the Layout link is selected in a JSP-based table container.

The JSPs in the JSPLayoutContainer directory and its description is:

layoutedit.jsp: Displays the Layout Edit page.

JSPPopupContainer

The JSPPopupContainer JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/developer_sample/JSPPopupContainer directory. These JSPs were used to detach a channel from a JSP-based Desktop. However, this container is no longer used by the developer sample. The detached windows in developer sample are now drawn by the popup.jsp, popupmenubar.jsp, and providerwrapper.jsp in JSPTableContainer. These JSPs are present for backward compatibility only.

The list of JSPs in the JSPPopupContainer directory and their description are:

popup.jsp: Displays the contents of the channel inside the detached window.
popupMenubar.jsp: Displays the Update, Close, and Logout links inside the popup window.
providerWrapper.jsp: Combines the above JSPs.

JSPPresetThemeContainer

The JSPPresetThemeContainer JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/developer_sample/JSPPresetThemeContainer directory. These JSPs are used when the Preset Themes link is selected in the Themes page.

The list of JSPs in the JSPPresetThemeContainer directory and their description are:

themedoedit.jsp: Processes the result from the Preset Theme page.
themeedit.jsp: Displays the Preset Theme Edit page.
themepreview.jsp: This file exists for backward compatibility and shows that the theme changes apply to a channel only.

JSPSingleContainer

The JSPSingleContainer JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/developer_sample/JSPSingleContainer directory.

The list of JSPs in the JSPSingleContainer directory and their description are:

header.jsp: Displays the product banner that is used by the Single Container page.
menubar.jsp: Displays the menubar that has the Home, Tabs, Theme, Help, and Logout links.
single.jsp: Displays the content for JSPSingleContainerProvider.

JSPTabContainer

The JSPTabContainer JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/developer_sample/JSPTabContainer directory.

The list of JSPs in the JSPTabContainer directory and their description are:

header.jsp: Displays the product banner that is used by the Tab Container page. (Dynamically included.)
menubar.jsp: Displays the menubar that has the Home, Tabs, Theme, Help, and Logout links. (Dynamically included.)
selectedTab.jsp: Displays the tab image for the current selected tab in the tab container.
tab.jsp: Is the main JSP for the tab container. It draws the content page for the tab container. (Dynamically includes header.jsp and menubar.jsp.)
tabedit.jsp: Displays the Edit page for the tab container where new pages can be added, removed, or renamed.
tabs.jsp: Generates the available tabs and the links for them to be activated on the Desktop.

JSPTabCustomTableContainerProvider

The JSPTabCustomTableContainer JSP is located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/developer_sample/JSPTabCustomTableContainerProvider directory.

The JSP available in the JSPTabCustomTableContainerProvider directory and their description are:

tabcustomtable.jsp: Displays the table container’s content view.

JSPTableContainerProvider

The JSPTableContainer JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/developer_sample/JSPTableContainerProvider directory.

The list of JSPs in the JSPTableContainerProvider directory and their description are:

header.jsp: Displays the product banner that includes the user reference links for the table container.
leafWraper.jsp: Displays the content view for each channel inside the table container.
menubar.jsp: Displays the menubar that has the Home, Theme, Help, and Logout links.
popup.jsp: This JSP is used to draw the content in the detached window for the channel in the detached mode.
popupMenubar.jsp: This JSP is used to draw the menubar in the detached window for a detached channel.
providerWrapper.jsp: This JSP is used to draw the wrapper containing the attach, edit, and help links around the channel displayed in the detached window.
table.jsp: Displays the table container’s content view, which is used by the table container inside a frame tab container. (Dynamically includes launchPopup.jsp, tablecolumn.jsp, and tabletopbottom.jsp.)
tabtable.jsp: Displays the table container’s content view, which is used by the table container inside a tab container. (Dynamically includes launchPopup.jsp, tablecolumn.jsp, and tabletopbottom.jsp.)
toptable.jsp: Displays the table container’s content view, which is used by the table container that is the top most container in the Desktop. (Dynamically includes launchPopup.jsp, tablecolumn.jsp, and tabletopbottom.jsp.)

JSPs Within the developer_sample Directory

These JSPs are located within the /var/opt/SUNWportal/portals/<portal_id>/desktop/developer_sample directory. These JSPs are used by more than one channel, and are also used as a default if the named JSP is not found in the provider or channel subdirectory.

The JSPs that are available within the developer_sample directory and their description are:

PortletBanner.jsp: This JSP is used to draw the banner on the edit page of a JSR 168 portlet when the edit button is clicked on the portlet.
PortletMenubar.jsp: This JSP is used to draw the menubar on the edit page of a JSR 168 portlet when the edit button is clicked on the portlet.
defaultHeader.jsp: Displays the default product banner that includes the user reference links.
defaultMenubar.jsp: Displays the default menubar that includes the user reference links.
framePreferenceHeader.jsp: Displays the product banner that is used by the frame tab containers.
framePreferenceMenubar.jsp: Displays the menubar that is used by the frame tab containers.
searchbox.jsp: Displays the search box that are used in the desktop header area.
singlePreferenceHeader.jsp: Displays the product banner that is used by the single containers.
singlePreferenceMenubar.jsp: Displays the menubar that is used by the single containers.
tabPreferenceHeader.jsp: Displays the product banner that is used by the tab containers.
tabPreferenceMenubar.jsp: Displays the menubar that is used by the tab containers.
tablePreferenceHeader.jsp: Displays the product banner that is used by the table containers.
tablePreferenceMenubar.jsp: Displays the menubar that is used by the table containers.

PredefinedFrontPageFramePanelContainerProvider

The PredefinedFrontPageFramePanelContainerProvider JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/developer_sample/PredefinedFrontPageFramePanelContainerProvider directory.

The list of JSPs in the PredefinedFrontPageFramePanelContainerProvider directory and their description are:

header.jsp: Displays the product banner that includes the user reference links for the table container.
launchPopup.jsp: Displays the detached windows that are detached from the table container. (Dynamically included.)
leafWrapper.jsp: Displays the content view for each channel inside the table container.
menubar.jsp: Displays the menubar that has the Home, Theme, Help, and Logout links.
popup.jsp: This JSP is used to draw the content in the detached window for the channel in the detached mode.
popupMenubar.jsp: This JSP is used to draw the menubar in the detached window for a detached channel.
providerCommands.jsp: Displays the channel command buttons and links, such as Remove, Minimize/Maximize, Edit, and Help.
providerWrapper.jsp: This JSP is used to draw the wrapper containing the attach, edit, and help links around the channel displayed in the detached window.
table.jsp: Displays the table container’s content view, which is used by the table container inside a frame tab container. (Dynamically includes launchPopup.jsp, tablecolumn.jsp, and tabletopbottom.jsp.)
tablecolumn.jsp: Handles the left, center and right columns of a table. (Dynamically included.)
tablemaximized.jsp: Handles the channel in the maximized state on the Desktop front page. This JSP is used to draw the HTML around the channel displayed in the maximized state.
tabletopbottom.jsp: Handles the top and bottom channels of a table. (Dynamically included.)
tabtable.jsp: Displays the table container’s content view, which is used by the table container inside a tab container. (Dynamically includes launchPopup.jsp, tablecolumn.jsp, and tabletopbottom.jsp.)
toptable.jsp: Displays the table container’s content view, which is used by the table container that is the top most container in the Desktop. (Dynamically includes launchPopup.jsp, tablecolumn.jsp, and tabletopbottom.jsp.)

PredefinedFrontPageTabPanelContainerProvider

The PredefinedFrontPageTabPanelContainerProvider JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/developer_sample/PredefinedFrontPageTabPanelContainerProvider directory.

The list of JSPs in the PredefinedFrontPageTabPanelContainerProvider directory and their description are:

header.jsp: Displays the product banner that includes the user reference links for the table container.
launchPopup.jsp: Displays the detached windows that are detached from the table container. (Dynamically included.)
leafWrapper.jsp: Displays the content view for each channel inside the table container.
menubar.jsp: Displays the menubar that has the Home, Theme, Help, and Logout links.
popup.jsp: This JSP is used to draw the content in the detached window for the channel in the detached mode.
popupMenubar.jsp: This JSP is used to draw the menubar in the detached window for a detached channel.
providerCommands.jsp: Displays the channel command buttons and links, such as Remove, Minimize/Maximize, Edit, and Help.
providerWrapper.jsp: This JSP is used to draw the wrapper containing the attach, edit, and help links around the channel displayed in the detached window.
table.jsp: Displays the table container’s content view, which is used by the table container inside a frame tab container. (Dynamically includes launchPopup.jsp, tablecolumn.jsp, and tabletopbottom.jsp.)
tablecolumn.jsp: Handles the left, center and right columns of a table. (Dynamically included.)
tablemaximized.jsp: Handles the channel in the maximized state on the Desktop front page. This JSP is used to draw the HTML around the channel displayed in the maximized state.
tabletopbottom.jsp: Handles the top and bottom channels of a table. (Dynamically included.)
tabtable.jsp: Displays the table container’s content view, which is used by the table container inside a tab container. (Dynamically includes launchPopup.jsp, tablecolumn.jsp, and tabletopbottom.jsp.)
toptable.jsp: Displays the table container’s content view, which is used by the table container that is the top most container in the Desktop. (Dynamically includes launchPopup.jsp, tablecolumn.jsp, and tabletopbottom.jsp.)

PredefinedSamplesFramePanelContainerProvider

The PredefinedSamplesFramePanelContainerProvider JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/developer_sample/PredefinedSamplesFramePanelContainerProvider directory.

The list of JSPs in the PredefinedSamplesFramePanelContainerProvider directory and their description are:

header.jsp: Displays the product banner that includes the user reference links for the table container.
launchPopup.jsp: Displays the detached windows that are detached from the table container. (Dynamically included.)
leafWrapper.jsp: Displays the content view for each channel inside the table container.
menubar.jsp: Displays the menubar that has the Home, Theme, Help, and Logout links.
popup.jsp: This JSP is used to draw the content in the detached window for the channel in the detached mode.
popupMenubar.jsp: This JSP is used to draw the menubar in the detached window for a detached channel.
providerCommands.jsp: Displays the channel command buttons and links, such as Remove, Minimize/Maximize, Edit, and Help.
providerWrapper.jsp: This JSP is used to draw the wrapper containing the attach, edit, and help links around the channel displayed in the detached window.
table.jsp: Displays the table container’s content view, which is used by the table container inside a frame tab container. (Dynamically includes launchPopup.jsp, tablecolumn.jsp, and tabletopbottom.jsp.)
tablecolumn.jsp: Handles the left, center and right columns of a table. (Dynamically included.)
tablemaximized.jsp: Handles the channel in the maximized state on the Desktop front page. This JSP is used to draw the HTML around the channel displayed in the maximized state.
tabletopbottom.jsp: Handles the top and bottom channels of a table. (Dynamically included.)
tabtable.jsp: Displays the table container’s content view, which is used by the table container inside a tab container. (Dynamically includes launchPopup.jsp, tablecolumn.jsp, and tabletopbottom.jsp.)
toptable.jsp: Displays the table container’s content view, which is used by the table container that is the top most container in the Desktop. (Dynamically includes launchPopup.jsp, tablecolumn.jsp, and tabletopbottom.jsp.)

PredefinedSamplesTabPanelContainerProvider

The PredefinedSamplesTabPanelContainerProvider JSPs are located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/developer_sample/PredefinedSamplesTabPanelContainerProvider directory.

The list of JSPs in the PredefinedSamplesTabPanelContainerProvider directory and their description are:

header.jsp: Displays the product banner that includes the user reference links for the table container.
launchPopup.jsp: Displays the detached windows that are detached from the table container. (Dynamically included.)
leafWrapper.jsp: Displays the content view for each channel inside the table container.
menubar.jsp: Displays the menubar that has the Home, Theme, Help, and Logout links.
popup.jsp: This JSP is used to draw the content in the detached window for the channel in the detached mode.
popupMenubar.jsp: This JSP is used to draw the menubar in the detached window for a detached channel.
providerCommands.jsp: Displays the channel command buttons and links, such as Remove, Minimize/Maximize, Edit, and Help.
providerWrapper.jsp: This JSP is used to draw the wrapper containing the attach, edit, and help links around the channel displayed in the detached window.
table.jsp: Displays the table container’s content view, which is used by the table container inside a frame tab container. (Dynamically includes launchPopup.jsp, tablecolumn.jsp, and tabletopbottom.jsp.)
tablecolumn.jsp: Handles the left, center and right columns of a table. (Dynamically included.)
tablemaximized.jsp: Handles the channel in the maximized state on the Desktop front page. This JSP is used to draw the HTML around the channel displayed in the maximized state.
tabletopbottom.jsp: Handles the top and bottom channels of a table. (Dynamically included.)
tabtable.jsp: Displays the table container’s content view, which is used by the table container inside a tab container. (Dynamically includes launchPopup.jsp, tablecolumn.jsp, and tabletopbottom.jsp.)
toptable.jsp: Displays the table container’s content view, which is used by the table container that is the top most container in the Desktop. (Dynamically includes launchPopup.jsp, tablecolumn.jsp, and tabletopbottom.jsp.)

SampleJSP

The SampleJSP JSP is located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/developer_sample/SampleJSP directory. These JSPs are used by the SampleJSP channel.

The JSP available in the SampleJSP directory and its description is:

samplecontent.jsp: Displays the contents of the Sample JSP channel. This JSP uses of the Desktop theme, and is used as an example of the channelHighlightColor attribute.

SampleSimpleWebService

The SampleSimpleWebService JSP is located in the /var/opt/SUNWportal/portals/<portal_id>/desktop/developer_sample/SampleSimpleWebService directory.

The JSP available in the SampleSimpleWebService directory and its description is:

webserviceContent.jsp: Displays the Content view of the simple web service channels.