| com.sun.portal.providers.containers.jsp.tab.TabContainer
All known Subclasses: com.sun.portal.providers.containers.template.tab.TemplateTabContainerProvider, com.sun.portal.providers.containers.jsp.tab.JSPTabContainerProvider,
| TabContainer | | public interface TabContainer (Code) | | TabContainer defines the interface for
implementing a Tab Container provider.
A TabContainerProvider must implement this interface.
This interface contains methods to query information
about a TabContainer and to set the properties
of a TabContainer
|
| Method Summary | |
| public List | getAvailableTabs()
Gets the List of available tabs. | | 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 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 UnmodifiableTab | getTab(String name)
Gets a tab.
This method returns an instance of the UnmodifiableTab for the named channel. | | public void | setSelectedTab(ModifiableTab t)
Sets the selected tab Name in the session. | | public void | setSelectedTabName(String 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. | | public void | setTab(ModifiableTab t)
Sets a tab. | | public void | setTab(ModifiableTab t, boolean selected)
Sets a tab. |
| 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 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. |
| setSelectedTabName | | public void setSelectedTabName(String tabName) throws ProviderException(Code) | | Sets the selected tab Name in the session
Parameters:
tabName - The name of the channel which needs to be set as the selected tab.This method sets the current selected tab on the user's desktop to 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.
Parameters:
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. |
|
|