| com.sun.portal.providers.containers.JSPContainerProviderAdapter
 com.sun.portal.providers.containers.jsp.tab.JSPTabContainerProvider
All known Subclasses: com.sun.portal.providers.containers.jsp.menu.JSPMenuContainerProvider,
| JSPTabContainerProvider | | public class JSPTabContainerProvider extends JSPContainerProviderAdapter implements TabContainer(Code) | | This class provides the implementation for JSPTabContainerProvider
and extends JSPContainerProviderAdapter and
implements TabContainer
A TabContainer provider is a container provider that generates its views primarily
by being a client of table container objects.The Tab Container displays one of its
contained channels at a time. The tab container allows table containers to be arranged
onto virtual pages. The container can then switch between these pages allowing them to
be physically viewed one at a time.
It allows the user to switch logically separate row-column displays.
Viewing this with container glasses on, each page is a table container.
The tab container then contains multiple table containers, one for each page.
Each tab in tab container corresponds to a table container.
Here, a Tab container provider is defined as a container
provider that has a selected and available channels list,
and allows getting and setting of these lists.
Tab container uses the selected channels list to hold the names of the tabs
that the user has configured on their desktop.
The available channels list is used to hold the list of tab topics,
or the tabs that the user can add to their desktop.
This does not adhere to the semantics of the getSelectedChannels
defined in ContainerProvider.
Selected Tabs are the container channels that are considered "active" on the
portal page. Available Tabs are those that are available to
be added to the portal page from the edit page.
See Also: com.sun.portal.providers.containers.jsp.tab.TabContainer
See Also: com.sun.portal.providers.containers.JSPContainerProviderAdapter |
| Method Summary | |
| public void | addTab(String name, String title)
Adds the tab back to the desktop that has been removed before
name. | | public List | getAvailableChannels()
Gets the list of tab topics that are available to be added to the portal page. | | public List | getAvailableTabs()
Gets the List of available tab topics. | | public StringBuffer | getContent(HttpServletRequest req, HttpServletResponse res)
| | public URL | getContentURL(ModifiableTab tab, HttpServletRequest req)
Gets the ContentPage URL.
ModifiableTab tab. | | protected URL | getDesktopURL(HttpServletRequest req)
| | public UnmodifiableTab | getMakeTab()
Gets the make tab, the tab spec to be used for 'Make My Own tab' creation by the user . | | public String | getMakeTabName()
Gets the make tab channel Name, the tab spec to be used for 'Make My Own tab' creation by the user . | | public String | getMakeTabProviderName()
Gets the make tab provider Name, the tab spec to be used for 'Make My Own tab' creation by the user . | | public int | getMaxTabs()
Gets the maximum number of tabs allowed on the user's desktop. | | public List | getSelectedChannels()
Gets the list of tab names that are available on the portal page.
The semantics of this method are different than getSelectedChannels()
in ContainerProvider. | | public UnmodifiableTab | getSelectedTab()
Gets the selected tab, the current selected tab in the user's session . | | public String | getSelectedTabName()
Gets the selected tab Name, the current selected tab in the user's session . | | public List | getSelectedTabs()
Gets the List of selected tabs. | | public UnmodifiableTab | getStartTab()
Gets the start tab, the tab to be displayed when the user logs in. | | public String | getStartTabName()
Gets the start tab Name, the name of the tab to be displayed when the user logs in. | | public int[] | getSupportedWindowStates()
Gets the supported window states. | | public UnmodifiableTab | getTab(String name)
Gets a tab.
This method returns an instance of the UnmodifiableTab for the named channel.
name. | | public URL | getTabURL(UnmodifiableTab tab, HttpServletRequest req)
Gets the Tab URL.
This method gets the tab url used to switch the selected tab on the user's desktop.
UnmodifiableTab tab. | | public int | getWindowState(String channelName)
Gets the window state of the channel.
This method just returns ProviderWindowStates.NORMAL.
Parameters:
channelName - channel for which the window state is requested. | | public void | init(String n, HttpServletRequest req)
Initializes the TabContainerProvider.
This method must be called by clients of the TabContainerProvider object
when the provider object is created (after it is constructed, or
before the object is used). | | public boolean | isSetTabRequest(HttpServletRequest req)
| | public URL | processEdit(HttpServletRequest req, HttpServletResponse res)
Process a form for this provider.
This method is called to process form data associated with the
tab container provider. | | public void | removeTab(String name)
Removes the tab.
name. | | public void | setAvailableChannels(List avail)
Sets the list of available channel names. | | public void | setSelectedChannels(List sel)
Sets the list of selected channel names. | | public void | setSelectedTab(ModifiableTab t)
Sets the selected tab Name in the session. | | protected void | setSelectedTab(HttpServletRequest req)
| | public void | setSelectedTabName(String tabName)
Sets the selected tab Name in the session
tabName. | | public void | setStartTabName()
Sets the start tab Name, the name of the tab to be displayed when the user logs in. | | public void | setStartTabName(UnmodifiableTab t)
Sets the start tab Name, the name of the tab to be displayed when the user logs in. | | public void | setStartTabName(String name)
Sets the start tab Name, the name of the tab to be displayed when the user logs in.
name. | | public void | setTab(ModifiableTab t)
Sets a tab.
ModifiableTab. | | public void | setTab(ModifiableTab t, boolean selected)
Sets a tab.
ModifiableTab. | | public void | setWindowState(String channelName, int windowState)
Sets the window state of a channel. |
| getAvailableChannels | | public List getAvailableChannels() throws ProviderException(Code) | | Gets the list of tab topics that are available to be added to the portal page.
The list of available channel names, a list of string names.
exception:
ProviderException - If the list of channel names cannot bereturned. |
| getContentURL | | public URL getContentURL(ModifiableTab tab, HttpServletRequest req) throws ProviderException(Code) | | Gets the ContentPage URL.
ModifiableTab tab. The tab used in generating the URLto be used to redirect to when theuser is making a tab from scratch in the Make New Tab Page..
Parameters:
req - An HttpServletRequest that containsinformation related to thisrequest for content. The URL that the desktop will redirect to when theuser is making a tab from scratch in the Make New Tab Page.
exception:
ProviderException - If the ContentPage URL cannot be generated. |
| getMakeTabName | | public String getMakeTabName() throws ProviderException(Code) | | Gets the make tab channel Name, the tab spec to be used for 'Make My Own tab' creation by the user .
The make tab channel name as a String.
exception:
ProviderException - If the make tab name cannot bereturned. |
| getMakeTabProviderName | | public String getMakeTabProviderName() throws ProviderException(Code) | | Gets the make tab provider Name, the tab spec to be used for 'Make My Own tab' creation by the user .
The make tab provider name as a String.
exception:
ProviderException - If the make tab provider name cannot bereturned. |
| getMaxTabs | | public int getMaxTabs() throws ProviderException(Code) | | Gets the maximum number of tabs allowed on the user's desktop.
The maximum number of tabs.
exception:
ProviderException - If the maximum number of tabs cannot bereturned. |
| getSelectedChannels | | public List getSelectedChannels() throws ProviderException(Code) | | Gets the list of tab names that are available on the portal page.
The semantics of this method are different than getSelectedChannels()
in ContainerProvider. This method returns the names of the tabs that
the user has configured on their desktop.
The list of selected channel names, a list of string names.
exception:
ProviderException - If the list of channel names cannot bereturned. |
| getSelectedTabName | | public String getSelectedTabName() throws ProviderException(Code) | | Gets the selected tab Name, the current selected tab in the user's session .
The selected tab name as a String.
exception:
ProviderException - If the selected tab name cannot bereturned. |
| getStartTabName | | public String getStartTabName() throws ProviderException(Code) | | Gets the start tab Name, the name of the tab to be displayed when the user logs in.
The start tab name as a String.
exception:
ProviderException - If the start tab name cannot bereturned. |
| getTabURL | | public URL getTabURL(UnmodifiableTab tab, HttpServletRequest req) throws ProviderException(Code) | | Gets the Tab URL.
This method gets the tab url used to switch the selected tab on the user's desktop.
UnmodifiableTab tab. The tab used in generating the URLto be used to switch the selected tab to the passed in tab on the user's desktop.
Parameters:
req - An HttpServletRequest that containsinformation related to thisrequest for content. The URL that is used for tab switching on the desktop.
exception:
ProviderException - If the Tab URL cannot be generated. |
| init | | public void init(String n, HttpServletRequest req) throws ProviderException(Code) | | Initializes the TabContainerProvider.
This method must be called by clients of the TabContainerProvider object
when the provider object is created (after it is constructed, or
before the object is used). This method should not be called more
than once per object.
Parameters:
n - Unique name identifying this TabContainerprovider. This valueshould always be returned from getName().
Parameters:
req - The HTTP request object corresponding to the HTTP requestthat caused this provider object ot be created. This request may beused to extract session or user information that could be used togain access to external resources.
exception:
ProviderException - If there was an error initializing theTabContainerProvider. How this exception is handled is up to the client of theTabContainerProvider object.
See Also: com.sun.portal.providers.Provider.getName |
| processEdit | | public URL processEdit(HttpServletRequest req, HttpServletResponse res) throws ProviderException(Code) | | Process a form for this provider.
This method is called to process form data associated with the
tab container provider. Typically, this method is called to process the edit page
generated from the getEdit() method. Usually, the client calling
this method on a provider object is the desktop servlet.
Form data, passed into this method in the request, has been decoded into
Unicode.
When the desktop servlet receives a request where the action is
"process", it looks at the
parameters to identify which provider will handle the action, through
this method. The request passed in contains the parameters.
After calling this method, the desktop servlet will re-direct to the URL
returned from this method. Therefore, the result of a provider post
can be any desktop serlvet action, or the content of an arbitrary URL.
For more information on constructing desktop serlvet URLs, see
DesktopSerlvet.
Parameters:
request - An HttpServletRequest that containsinformation related to thisrequest for content.
Parameters:
response - An HttpServletResponse that allows theprovider to influence theoverall response for the desktop page (besides generating the content).
exception:
ProviderException - If there was an error processingthe edit form. How this exception is handled is up to the client of theprovider object. The URL that the iPS desktop will re-direct to. A valueof null should indicate to the client that it should return to itsdefault view.
See Also: com.sun.portal.providers.Provider.getEdit
See Also: com.sun.portal.providers.Provider.isEditable
See Also: com.sun.portal.providers.InvalidEditFormDataException
See Also: com.sun.portal.desktop.DesktopServlet |
| removeTab | | public void removeTab(String name) throws ProviderException(Code) | | Removes the tab.
name. Name of the tab to be removed.This method removes the tab from the selected channels list if predefinedand removes the tab from the selected and available lists and deletes thecorresponding table container if user created.
exception:
ProviderException - If the tab cannot be removed. |
| setAvailableChannels | | public void setAvailableChannels(List avail) throws ProviderException(Code) | | Sets the list of available channel names.
This method sets the available tab topics ussed by the user
to configure the portal desktop.
Parameters:
avail - The new list of channel names.
exception:
ProviderException - If the list of channel names cannot beset. |
| setSelectedChannels | | public void setSelectedChannels(List sel) throws ProviderException(Code) | | Sets the list of selected channel names.
This method sets the available tabs on the portal page.
Parameters:
sel - The new list of channel names.
exception:
ProviderException - If the list of channel names cannot beset. |
| setSelectedTabName | | public void setSelectedTabName(String tabName) throws ProviderException(Code) | | Sets the selected tab Name in the session
tabName. The name of the channel which needs to be set as the selected tab.This method sets the active tab on the user's desktopto the name passed in..
exception:
ProviderException - If the selected tab name cannot be set. |
| setStartTabName | | public void setStartTabName() throws ProviderException(Code) | | Sets the start tab Name, the name of the tab to be displayed when the user logs in.
This method sets the current selected tab name in the user's session to the start tab.
exception:
ProviderException - If the start tab name cannot bereturned. |
| setStartTabName | | public void setStartTabName(String name) throws ProviderException(Code) | | Sets the start tab Name, the name of the tab to be displayed when the user logs in.
name. The name of the channel which needs to be set as the start tab.This method sets the start tab to the name passed in..
exception:
ProviderException - If the start tab name cannot be set. |
| setWindowState | | public void setWindowState(String channelName, int windowState) throws UnsupportedWindowStateException(Code) | | Sets the window state of a channel.
This method currently has no effect and throws
UnsupportedWindowStateException if windowState passed is not
ProviderWindowStates#NORMAL.
Subclasses that wish to allow setting a WindowState should
override this method.
Parameters:
channelName - channel for which the window state needs to be set
Parameters:
windowState - The new window state UnsupportedWindowStateException. |
|
|