com.sun.portal.providers.containers.jsp.tab
Interface TabContainer

All Known Implementing Classes:

JSPTabContainerProvider

public interface TabContainer

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

List	getAvailableTabs() Gets the List of available tabs.
UnmodifiableTab	getMakeTab() Gets the make tab, the tab spec to be used for 'Make My Own tab' creation by the user .
String	getMakeTabName() Gets the make tab channel Name, the tab spec to be used for 'Make My Own tab' creation by the user .
String	getMakeTabProviderName() Gets the make tab provider Name, the tab spec to be used for 'Make My Own tab' creation by the user .
int	getMaxTabs() Gets the maximum number of tabs allowed on the user's desktop.
UnmodifiableTab	getSelectedTab() Gets the selected tab, the current selected tab in the user's session .
String	getSelectedTabName() Gets the selected tab Name, the current selected tab in the user's session .
List	getSelectedTabs() Gets the List of selected tabs.
UnmodifiableTab	getStartTab() Gets the start tab, the tab to be displayed when the user logs in.
String	getStartTabName() Gets the start tab Name, the name of the tab to be displayed when the user logs in.
UnmodifiableTab	getTab(String name) Gets a tab.
void	setSelectedTab(ModifiableTab t) Sets the selected tab Name in the session.
void	setSelectedTabName(String tabName) Sets the selected tab Name in the session
void	setStartTabName() Sets the start tab Name, the name of the tab to be displayed when the user logs in.
void	setStartTabName(String name) Sets the start tab Name, the name of the tab to be displayed when the user logs in.
void	setStartTabName(UnmodifiableTab t) Sets the start tab Name, the name of the tab to be displayed when the user logs in.
void	setTab(ModifiableTab t) Sets a tab.
void	setTab(ModifiableTab t, boolean selected) Sets a tab.

Method Detail

getMaxTabs

public int getMaxTabs()
               throws ProviderException

Gets the maximum number of tabs allowed on the user's desktop.

Returns:

the maximum number of tabs.

Throws:

ProviderException - If the maximum number cannot be returned.

getSelectedTabs

public List getSelectedTabs()
                     throws ProviderException

Gets the List of selected tabs.

Returns:

The list of selected tabs, a list of UnmodifiableTabs.

Throws:

ProviderException - If the list of selected tabs cannot be returned.

See Also:

UnmodifiableTab

getAvailableTabs

public List getAvailableTabs()
                      throws ProviderException

Gets the List of available tabs.

Returns:

The list of available tabs, a list of UnmodifiableTabs.

Throws:

ProviderException - If the list of available tabs cannot be returned.

See Also:

UnmodifiableTab

getStartTab

public UnmodifiableTab getStartTab()
                            throws ProviderException

Gets the start tab, the tab to be displayed when the user logs in.

Returns:

The start tab, UnmodifiableTab.

Throws:

ProviderException - If the start tab cannot be returned.

See Also:

UnmodifiableTab

getStartTabName

public String getStartTabName()
                       throws ProviderException

Gets the start tab Name, the name of the tab to be displayed when the user logs in.

Returns:

The start tab name as a string.

Throws:

ProviderException - If the start tab name cannot be returned.

getMakeTab

public UnmodifiableTab getMakeTab()
                           throws ProviderException

Gets the make tab, the tab spec to be used for 'Make My Own tab' creation by the user .

Returns:

The make tab,UnmodifiableTab .

Throws:

ProviderException - If the make tab cannot be returned.

See Also:

UnmodifiableTab

getMakeTabName

public String getMakeTabName()
                      throws ProviderException

Gets the make tab channel Name, the tab spec to be used for 'Make My Own tab' creation by the user .

Returns:

The make tab channel name as a string.

Throws:

ProviderException - If the make tab name cannot be returned.

getMakeTabProviderName

public String getMakeTabProviderName()
                              throws ProviderException

Gets the make tab provider Name, the tab spec to be used for 'Make My Own tab' creation by the user .

Returns:

The make tab provider name as a string.

Throws:

ProviderException - If the make tab provider name cannot be returned.

getSelectedTabName

public String getSelectedTabName()
                          throws ProviderException

Gets the selected tab Name, the current selected tab in the user's session .

Returns:

The selected tab name as a string.

Throws:

ProviderException - If the selected tab name cannot be returned.

getSelectedTab

public UnmodifiableTab getSelectedTab()
                               throws ProviderException

Gets the selected tab, the current selected tab in the user's session .

Returns:

The selected tab, UnmodifiableTab.

Throws:

ProviderException - If the selected tab cannot be returned.

See Also:

UnmodifiableTab

getTab

public UnmodifiableTab getTab(String name)
                       throws ProviderException

Gets a tab. This method returns an instance of the UnmodifiableTab for the named channel.

Parameters:

name - The name of the channel for which the tab Object is requested.

Returns:

The tab, UnmodifiableTab.

Throws:

ProviderException - If the tab cannot be returned.

See Also:

UnmodifiableTab

setTab

public void setTab(ModifiableTab t)
            throws ProviderException

Sets a tab.

Parameters:

b - Tab that needs to be set. This method adds the ModifiableTab to the selected tabs list.

Throws:

ProviderException - If the tab cannot be set

See Also:

UnmodifiableTab, ModifiableTab

setTab

public void setTab(ModifiableTab t,
                   boolean selected)
            throws ProviderException

Sets a tab.

Parameters:

b - A ModifiableTab Tab that needs to be set.

selected - If true sets the tab to the current selected tab on the user's desktop. This method adds the ModifiableTab to the selected tabs list

Throws:

ProviderException - If the tab cannot be set

See Also:

UnmodifiableTab, ModifiableTab

setStartTabName

public void setStartTabName()
                     throws ProviderException

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.

Throws:

ProviderException - If the start tab name cannot be returned.

setStartTabName

public void setStartTabName(UnmodifiableTab t)
                     throws ProviderException

Sets the start tab Name, the name of the tab to be displayed when the user logs in.

Parameters:

t - A UnmodifiableTab Whose tab name needs to be set as the start tab name. This method sets the start tab name to the name of UnmodifiableTab that was passed in.

Throws:

ProviderException - If the start tab name cannot be set

See Also:

UnmodifiableTab

setStartTabName

public void setStartTabName(String name)
                     throws ProviderException

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

Throws:

ProviderException - If the start tab name cannot be set.

setSelectedTab

public void setSelectedTab(ModifiableTab t)
                    throws ProviderException

Sets the selected tab Name in the session.

Parameters:

t - A ModifiableTab.Whose tab name needs to be set as the selected tab name. This method sets the current selected tab name to the name of ModifiableTab that was passed in.

Throws:

ProviderException - If the start tab name cannot be set

See Also:

ModifiableTab

setSelectedTabName

public void setSelectedTabName(String tabName)
                        throws ProviderException

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

Throws:

ProviderException - If the selected tab name cannot be set.