Package com.microstrategy.web.app.beans
Interface TabManagerBean
-
- All Superinterfaces:
AppComponent
,EnumWebPersistableState
,Persistable
,RequestPersistable
,Transformable
,WebComponent
- All Known Subinterfaces:
DerivedElementFormatEditorBean
,FormatTabManagerBean
,ObjectBrowserManagerBean
- All Known Implementing Classes:
AccordionTabManagerBeanImpl
public interface TabManagerBean extends AppComponent, RequestPersistable
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.- Since:
- MicroStrategy Web 8.0.0
-
-
Field Summary
Fields Modifier and Type Field Description static int
TAB_MANAGER_CURRENT_TAB_NOT_SPECIFIED
Constant to represent the current tab of this manager has not been specified yetstatic 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 DHTMLstatic 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-
Fields inherited from interface com.microstrategy.web.app.beans.AppComponent
COMPONENT_POSITION_NOT_INITIALIZED
-
Fields inherited from interface com.microstrategy.utils.serialization.EnumWebPersistableState
BARE_MINIMAL_STATE_INFO, MAXIMAL_STATE_INFO, MINIMAL_STATE_INFO, TYPICAL_STATE_INFO
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description int
getActionId()
Return the action id that caused the editor to open, i.e, edit, addHashList
getAllChildren()
From the list of all children beans defined for this manager, return aHashList
.java.lang.String
getAppliesToID()
Return the id of the bone that this tab manager will apply to.int
getCurrentTab()
Get the tab that it's currently selected for being displayed by the Manager.java.lang.String
getSelectedTabOptions()
Get the selected options or values on each tab of the editor.java.lang.String
getSelectedTypes()
set the list of object types selected in the client.HashList
getTabProperties()
Returns the HashList containing properties of all tabsint
getTabSwitchMode()
Return the mode of switching tabs for the tab manager.HashList
getVisibleChildren(boolean hideUnavailable)
From the list of children beans defined for this manager, return aHashList
of those that are currently visible or available.boolean
isPartialUpdate()
boolean
isTabAvailable(TabBean childTabBean)
Returns a boolean that indicates if a child Tab bean is available for the current tab manager beanvoid
setActionId(int actionId)
Set the action id that caused the editor to open.void
setAppliesToID(java.lang.String boneId)
Set the id of the bone that this tab manager will apply to.void
setCurrentTab(int currentTab)
Set the tab to be displayed by the Tab Manager as current one.void
setCurrentTabName(java.lang.String currentTabName)
Set the tab to be displayed by the this manager as current one by name of the tab.void
setPartialUpdate(boolean paritalUpdate)
void
setSelectedTabOptions(java.lang.String selectedTabOptions)
Set the selected options or values on each tab of the editor.void
setSelectedTypes(java.lang.String selectedTypes)
Set the list of object types selected in the client.void
setTabProperties(java.lang.String tabName, java.lang.Object prop)
Sets bone properties for individual tabs of the editor.void
setTabSwitchMode(int switchMode)
Set the mode of switching tabs for the tab manager.-
Methods inherited from interface com.microstrategy.web.app.beans.AppComponent
getAppContext, getDescriptor, getDescriptor, getEventManager, getExtraInput, getExtraUrl, getLeft, getResultFilterMode, getTop, isDialog, isForcedChildrenStateSaving, isModal, isModalOpen, isOpen, setExtraInput, setExtraUrl, setForcedChildrenStateSaving, setHasJustOpened, setIsDialog, setIsModal, setIsOpen, setLeft, setTop
-
Methods inherited from interface com.microstrategy.utils.serialization.Persistable
restoreState, restoreState, saveState, saveState, saveState, saveState
-
Methods inherited from interface com.microstrategy.web.beans.RequestPersistable
restoreStateFromRequest, restoreStateFromRequest
-
Methods inherited from interface com.microstrategy.web.beans.Transformable
addTransform, addTransformByClass, addTransformByStyle, addTransformByStyle, clearTransforms, getBeanContext, getMessageString, getMyTransformInstances, getTransformInstance, getTransformInstance, getTransformInstances, getType, hasTransform, hasTransform, invalidateTransformCache, setBeanContext, transform, transform
-
Methods inherited from interface com.microstrategy.web.beans.WebComponent
addChild, addChildStateInfo, addChildStateInfo, collectData, collectMinimalData, generateOutput, getBeanContext, getChild, getChild, getChildByClass, getChildByType, getChildCount, getChildrenByClass, getDefaultStateLevel, getFeaturesManager, getMaximumStateLevel, getName, getOutputFormat, getParent, getPath, getPersistMode, getRenderingFilter, getRoot, getTargetBean, getTargetBeanPath, getWebEvent, getWebEvent, getWebEventHandler, getXMLStatus, handleRequest, hasChanged, hasJustOpened, initBean, invalidateChildrenState, isBeanContextEmpty, isFeatureAvailable, prepareForReuse, removeChild, removeChild, searchChild, setBeanContext, setBeanContext, setChanged, setChanged, setDefaultStateLevel, setFeaturesManager, setName, setOutputFormat, setParent, setPersistMode, setRenderingFilter, setTargetBean, setTargetBeanPath, setWebEventHandler
-
-
-
-
Field Detail
-
TAB_MANAGER_CURRENT_TAB_NOT_SPECIFIED
static final int TAB_MANAGER_CURRENT_TAB_NOT_SPECIFIED
Constant to represent the current tab of this manager has not been specified yet- See Also:
- Constant Field Values
-
TAB_MANAGER_TAB_SWITCH_MODE_HTML
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- See Also:
- Constant Field Values
-
TAB_MANAGER_TAB_SWITCH_MODE_DHTML
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- See Also:
- Constant Field Values
-
-
Method Detail
-
getCurrentTab
int getCurrentTab()
Get the tab that it's currently selected for being displayed by the Manager.- Returns:
int
value representing the current tab.
-
getVisibleChildren
HashList getVisibleChildren(boolean hideUnavailable)
From the list of children beans defined for this manager, return aHashList
of those that are currently visible or available.- Parameters:
hideUnavailable
- TODO- Returns:
- a
HashList
of the children beans of this manager that are visible. - Since:
- MicroStrategy Web 9.0.0
-
getAllChildren
HashList getAllChildren()
From the list of all children beans defined for this manager, return aHashList
.- Returns:
- all
HashList
of the children beans of this manager. - Since:
- MicroStrategy Web 9.0.0
-
setCurrentTab
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.
-
setCurrentTabName
void setCurrentTabName(java.lang.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- Since:
- MicroStrategy Web 9.0.0
-
getSelectedTabOptions
java.lang.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
- Since:
- MicroStrategy Web 8.0.1
-
setSelectedTabOptions
void setSelectedTabOptions(java.lang.String selectedTabOptions)
Set the selected options or values on each tab of the editor. These options are normally not applied to the object.- Since:
- MicroStrategy Web 8.0.1
-
setSelectedTypes
void setSelectedTypes(java.lang.String selectedTypes)
Set the list of object types selected in the client.- Parameters:
selectedTypes
-String
representing the list of selected objects.
-
getSelectedTypes
java.lang.String getSelectedTypes()
set the list of object types selected in the client.- Returns:
String
representing the list of selected objects.
-
setTabSwitchMode
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
-
getTabSwitchMode
int getTabSwitchMode()
Return the mode of switching tabs for the tab manager. Automatic/HTML mode- Returns:
- int
-
isTabAvailable
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
-
setActionId
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
-
getActionId
int getActionId()
Return the action id that caused the editor to open, i.e, edit, add- Returns:
- int
-
setAppliesToID
void setAppliesToID(java.lang.String boneId)
Set the id of the bone that this tab manager will apply to.- Parameters:
boneId
- String- Since:
- MicroStrategy Web 9.0.0
-
getAppliesToID
java.lang.String getAppliesToID()
Return the id of the bone that this tab manager will apply to.- Returns:
- String
- Since:
- MicroStrategy Web 9.0.0
-
setTabProperties
void setTabProperties(java.lang.String tabName, java.lang.Object prop)
Sets bone properties for individual tabs of the editor.- Parameters:
tabName
-prop
- a JSonGenerator object containing all property-value pairs that need to be associated with the tab- Since:
- MicroStrategy Web 9.0.0
-
getTabProperties
HashList getTabProperties()
Returns the HashList containing properties of all tabs- Since:
- MicroStrategy Web 9.0.0
-
setPartialUpdate
void setPartialUpdate(boolean paritalUpdate)
- Since:
- MicroStrategy Web 9.0.0
-
isPartialUpdate
boolean isPartialUpdate()
- Since:
- MicroStrategy Web 9.0.0
-
-