public interface

TabManagerBean

implements AppComponent RequestPersistable
com.microstrategy.web.app.beans.TabManagerBean
Known Indirect Subclasses

Class Overview

This bean will be used for a tabbed control, for handling which tab should be shown, based on the children beans defined to this instance and the tab specification of each one of them. The manager should be used only when there's the possibility of multiple tabs being shown to the user as options. If it is for sure only one is to be shown, the manager is not required, since each child bean should be independent for processing the information and rendering its contents.

Summary

Constants
int TAB_MANAGER_CURRENT_TAB_NOT_SPECIFIED Constant to represent the current tab of this manager has not been specified yet
int TAB_MANAGER_TAB_SWITCH_MODE_DHTML Constant to represent the tab switch mode of the tab manager This mode means that switching of tabs is done using DHTML
int TAB_MANAGER_TAB_SWITCH_MODE_HTML Constant to represent the tab switch mode of the tab manager This mode means that switching of tabs is done after a trip to the web server
[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
From interface com.microstrategy.web.app.beans.AppComponent
Public Methods
abstract int getActionId()
Return the action id that caused the editor to open, i.e, edit, add
abstract HashList getAllChildren()
From the list of all children beans defined for this manager, return a HashList.
abstract String getAppliesToID()
Return the id of the bone that this tab manager will apply to.
abstract int getCurrentTab()
Get the tab that it's currently selected for being displayed by the Manager.
abstract String getSelectedTabOptions()
Get the selected options or values on each tab of the editor.
abstract String getSelectedTypes()
set the list of object types selected in the client.
abstract HashList getTabProperties()
Returns the HashList containing properties of all tabs
abstract int getTabSwitchMode()
Return the mode of switching tabs for the tab manager.
abstract HashList getVisibleChildren(boolean hideUnavailable)
From the list of children beans defined for this manager, return a HashList of those that are currently visible or available.
abstract boolean isPartialUpdate()
abstract boolean isTabAvailable(TabBean childTabBean)
Returns a boolean that indicates if a child Tab bean is available for the current tab manager bean
abstract void setActionId(int actionId)
Set the action id that caused the editor to open.
abstract void setAppliesToID(String boneId)
Set the id of the bone that this tab manager will apply to.
abstract void setCurrentTab(int currentTab)
Set the tab to be displayed by the Tab Manager as current one.
abstract void setCurrentTabName(String currentTabName)
Set the tab to be displayed by the this manager as current one by name of the tab.
abstract void setPartialUpdate(boolean paritalUpdate)
abstract void setSelectedTabOptions(String selectedTabOptions)
Set the selected options or values on each tab of the editor.
abstract void setSelectedTypes(String selectedTypes)
Set the list of object types selected in the client.
abstract void setTabProperties(String tabName, Object prop)
Sets bone properties for individual tabs of the editor.
abstract void setTabSwitchMode(int switchMode)
Set the mode of switching tabs for the tab manager.
[Expand]
Inherited Methods
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.app.beans.AppComponent
From interface com.microstrategy.web.beans.RequestPersistable
From interface com.microstrategy.web.beans.Transformable
From interface com.microstrategy.web.beans.WebComponent

Constants

public static final int TAB_MANAGER_CURRENT_TAB_NOT_SPECIFIED

Constant to represent the current tab of this manager has not been specified yet

Constant Value: 1 (0x00000001)

public static final int TAB_MANAGER_TAB_SWITCH_MODE_DHTML

Constant to represent the tab switch mode of the tab manager This mode means that switching of tabs is done using DHTML

Constant Value: 1 (0x00000001)

public static final int TAB_MANAGER_TAB_SWITCH_MODE_HTML

Constant to represent the tab switch mode of the tab manager This mode means that switching of tabs is done after a trip to the web server

Constant Value: 2 (0x00000002)

Public Methods

public abstract int getActionId ()

Return the action id that caused the editor to open, i.e, edit, add

Returns
  • int

public abstract HashList getAllChildren ()

From the list of all children beans defined for this manager, return a HashList.

Returns
  • all HashList of the children beans of this manager.

public abstract String getAppliesToID ()

Return the id of the bone that this tab manager will apply to.

Returns
  • String

public abstract int getCurrentTab ()

Get the tab that it's currently selected for being displayed by the Manager.

Returns
  • int value representing the current tab.

public abstract String getSelectedTabOptions ()

Get the selected options or values on each tab of the editor. These options are normally not applied to the object.

Returns
  • String

public abstract String getSelectedTypes ()

set the list of object types selected in the client.

Returns
  • String representing the list of selected objects.

public abstract HashList getTabProperties ()

Returns the HashList containing properties of all tabs

public abstract int getTabSwitchMode ()

Return the mode of switching tabs for the tab manager. Automatic/HTML mode

Returns
  • int

public abstract HashList getVisibleChildren (boolean hideUnavailable)

From the list of children beans defined for this manager, return a HashList of those that are currently visible or available.

Parameters
hideUnavailable TODO
Returns
  • a HashList of the children beans of this manager that are visible.

public abstract boolean isPartialUpdate ()

public abstract boolean isTabAvailable (TabBean childTabBean)

Returns a boolean that indicates if a child Tab bean is available for the current tab manager bean

Parameters
childTabBean TabBean
Returns
  • boolean

public abstract void setActionId (int actionId)

Set the action id that caused the editor to open. Most of the time, the action is editing the object. There are some exception like adding an image. Remembering this action would let the editor to know what action to take when the cancel button is pressed. In the case of adding an image, the editor would delete the image. But for editing an existing image, the editor would just cancel all the changes without deleting the image.

Parameters
actionId int

public abstract void setAppliesToID (String boneId)

Set the id of the bone that this tab manager will apply to.

Parameters
boneId String

public abstract void setCurrentTab (int currentTab)

Set the tab to be displayed by the Tab Manager as current one.

Parameters
currentTab numeric identifier of the child tab to be marked as current.

public abstract void setCurrentTabName (String currentTabName)

Set the tab to be displayed by the this manager as current one by name of the tab.

Parameters
currentTabName String representing which tab is to be selected as current by name

public abstract void setPartialUpdate (boolean paritalUpdate)

public abstract void setSelectedTabOptions (String selectedTabOptions)

Set the selected options or values on each tab of the editor. These options are normally not applied to the object.

public abstract void setSelectedTypes (String selectedTypes)

Set the list of object types selected in the client.

Parameters
selectedTypes String representing the list of selected objects.

public abstract void setTabProperties (String tabName, Object prop)

Sets bone properties for individual tabs of the editor.

Parameters
prop a JSonGenerator object containing all property-value pairs that need to be associated with the tab

public abstract void setTabSwitchMode (int switchMode)

Set the mode of switching tabs for the tab manager. Automatic/HTML mode Automatic - means, we use DHTML to switch tabs. HTML - means, switching tabs will go back to the web server

Parameters
switchMode int