com.webmethods.bpm.noodle
Interface IUserTabSet

public interface IUserTabSet

Method Summary

boolean	addTab(IUserTab userTab, boolean setAsCurrent) Adds a tab to the user's tab set.
IUserTab	addTab(String name, String URL, boolean setAsCurrent) Adds a new tab to the tab set.
void	addTabAfter(IUserTab newTab, IUserTab targetTab, boolean setAsCurrent) Adds the new tab after the selected existing tab in the displayed tab set.
void	addTabBefore(IUserTab newTab, IUserTab targetTab, boolean setAsCurrent) Adds the new tab before the selected existing tab in the user's current tab set.
IUserTab	getCurrentTab() Gets the tab the user is viewing from the tab set.
IUserTab	getTabByID(String tabID) Gets the IUserTab object by ID from the tab set.
IUserTab	getTabByName(String tabName) Get an IUserTab object by name from the tab set.
IUserTab	getTabByURI(String uri) Gets a tab that is viewing the specified URI.
List	listTabs() Lists all of the tabs in the tab set.
void	moveTabAfter(IUserTab moveTab, IUserTab targetTab) Moves a selected tab to new location before another tab selected by the user.
void	moveTabBefore(IUserTab moveTab, IUserTab targetTab) Move an existing tab prior to the specified existing tab in tab set order.
boolean	removeTab(IUserTab userTab) Removes an existing tab from the tab set.
void	save() Commits any unsaved changes in the tab.
void	setCurrentTab(IUserTab usertab) Sets the specified IUserTab as the active tab.
void	setCurrentTab(String tabID) Sets the tab specified by ID as the active tab.

Method Detail

addTab

boolean addTab(IUserTab userTab,
               boolean setAsCurrent)

Adds a tab to the user's tab set.

Parameters:

userTab - The IUserTab instance to add to the user's tab set.

setAsCurrent - Specify true to make this tab the active tab.

Returns:

Returns true if the new tab was successfully created.

addTab

IUserTab addTab(String name,
                String URL,
                boolean setAsCurrent)

Adds a new tab to the tab set.

Parameters:

name - The name of the new tab.

URL - The navigation URL of the new tab.

setAsCurrent - Specify true to make this tab the active tab.

Returns:

Returns a new IUserTab object representing the new tab.

removeTab

boolean removeTab(IUserTab userTab)

Removes an existing tab from the tab set.

Parameters:

userTab - the IUserTab object to remove.

Returns:

Returns true if the tab exists and was successfully removed from the tab set.

save

void save()

Commits any unsaved changes in the tab.

listTabs

List listTabs()

Lists all of the tabs in the tab set.

Returns:

Returns a list of IUserTab objects representing all tabs for the user.

getCurrentTab

IUserTab getCurrentTab()

Gets the tab the user is viewing from the tab set.

Returns:

Returns the IUserTab object representing the active tab.

setCurrentTab

void setCurrentTab(IUserTab usertab)

Sets the specified IUserTab as the active tab.

Parameters:

usertab - The IUserTab to set as active.

setCurrentTab

void setCurrentTab(String tabID)

Sets the tab specified by ID as the active tab.

Parameters:

tabID - The tabID of the tab to set as active.

getTabByID

IUserTab getTabByID(String tabID)

Gets the IUserTab object by ID from the tab set.

Parameters:

tabID - The tab ID to find.

Returns:

Returns the IUserTab matching the specified tabID, may be null.

getTabByName

IUserTab getTabByName(String tabName)

Get an IUserTab object by name from the tab set.

Parameters:

tabName - The tabe name to find.

Returns:

Returns the IUserTab matching the specified name, may be null.

getTabByURI

IUserTab getTabByURI(String uri)

Gets a tab that is viewing the specified URI.

Parameters:

uri - The URI of the page the tab is viewing.

Returns:

Returns the IUserTab that presents the specified display URI, may be null.

addTabBefore

void addTabBefore(IUserTab newTab,
                  IUserTab targetTab,
                  boolean setAsCurrent)

Adds the new tab before the selected existing tab in the user's current tab set.

Parameters:

newTab - The new tab to add to the tab set.

targetTab - The existing tab that you would like to insert before in the tab set order.

setAsCurrent - Specify true to set the new tab as the active tab

addTabAfter

void addTabAfter(IUserTab newTab,
                 IUserTab targetTab,
                 boolean setAsCurrent)

Adds the new tab after the selected existing tab in the displayed tab set.

Parameters:

newTab - The new tab to add to the tab set.

targetTab - The existing tab that you would like to insert after in the tab set order.

setAsCurrent - Specify true to set the new tab as the active tab.

moveTabBefore

void moveTabBefore(IUserTab moveTab,
                   IUserTab targetTab)

Move an existing tab prior to the specified existing tab in tab set order.

Parameters:

moveTab - The existing tab to move.

targetTab - The existing tab you would like to insert before in tab set order.

moveTabAfter

void moveTabAfter(IUserTab moveTab,
                  IUserTab targetTab)

Moves a selected tab to new location before another tab selected by the user.

Parameters:

moveTab - The existing tab to move.

targetTab - The existing tab you would like to insert after in tab set order.