|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 | |
java.util.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 . |
java.lang.String |
getMakeTabName()
Gets the make tab channel Name, the tab spec to be used for 'Make My Own tab' creation by the user . |
java.lang.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 . |
java.lang.String |
getSelectedTabName()
Gets the selected tab Name, the current selected tab in the user's session . |
java.util.List |
getSelectedTabs()
Gets the List of selected tabs. |
UnmodifiableTab |
getStartTab()
Gets the start tab, the tab to be displayed when the user logs in. |
java.lang.String |
getStartTabName()
Gets the start tab Name, the name of the tab to be displayed when the user logs in. |
UnmodifiableTab |
getTab(java.lang.String name)
Gets a tab. |
void |
setSelectedTab(ModifiableTab t)
Sets the selected tab Name in the session. |
void |
setSelectedTabName(java.lang.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(java.lang.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 |
public int getMaxTabs() throws ProviderException
ProviderException
- If the maximum number cannot be
returned.public java.util.List getSelectedTabs() throws ProviderException
ProviderException
- If the list of selected tabs cannot be
returned.UnmodifiableTab
public java.util.List getAvailableTabs() throws ProviderException
ProviderException
- If the list of available tabs cannot be
returned.UnmodifiableTab
public UnmodifiableTab getStartTab() throws ProviderException
ProviderException
- If the start tab cannot be
returned.UnmodifiableTab
public java.lang.String getStartTabName() throws ProviderException
ProviderException
- If the start tab name cannot be
returned.public UnmodifiableTab getMakeTab() throws ProviderException
ProviderException
- If the make tab cannot be
returned.UnmodifiableTab
public java.lang.String getMakeTabName() throws ProviderException
ProviderException
- If the make tab name cannot be
returned.public java.lang.String getMakeTabProviderName() throws ProviderException
ProviderException
- If the make tab provider name cannot be
returned.public java.lang.String getSelectedTabName() throws ProviderException
ProviderException
- If the selected tab name cannot be
returned.public UnmodifiableTab getSelectedTab() throws ProviderException
ProviderException
- If the selected tab cannot be
returned.UnmodifiableTab
public UnmodifiableTab getTab(java.lang.String name) throws ProviderException
UnmodifiableTab
for the named channel.
name
- The name of the channel for which the tab Object is requested.
ProviderException
- If the tab cannot be
returned.UnmodifiableTab
public void setTab(ModifiableTab t) throws ProviderException
ProviderException
- If the tab cannot be setUnmodifiableTab
,
ModifiableTab
public void setTab(ModifiableTab t, boolean selected) throws ProviderException
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
ProviderException
- If the tab cannot be setUnmodifiableTab
,
ModifiableTab
public void setStartTabName() throws ProviderException
ProviderException
- If the start tab name cannot be
returned.public void setStartTabName(UnmodifiableTab t) throws ProviderException
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.
ProviderException
- If the start tab name cannot be setUnmodifiableTab
public void setStartTabName(java.lang.String name) throws ProviderException
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..
ProviderException
- If the start tab name cannot be set.public void setSelectedTab(ModifiableTab t) throws ProviderException
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.
ProviderException
- If the start tab name cannot be setModifiableTab
public void setSelectedTabName(java.lang.String tabName) throws ProviderException
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..
ProviderException
- If the selected tab name cannot be set.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |