Package com.microstrategy.web.app.beans
Interface FormatTabManagerBean
-
- All Superinterfaces:
AppComponent
,EnumWebPersistableState
,Persistable
,RequestPersistable
,TabManagerBean
,Transformable
,WebComponent
public interface FormatTabManagerBean extends TabManagerBean
This bean will be used for a tabbed control for formatting editor, 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 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
-
Fields inherited from interface com.microstrategy.web.app.beans.TabManagerBean
TAB_MANAGER_CURRENT_TAB_NOT_SPECIFIED, TAB_MANAGER_TAB_SWITCH_MODE_DHTML, TAB_MANAGER_TAB_SWITCH_MODE_HTML
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getActiveViewKey()
Returns the active view key.int
getTargetAxis()
Get the axis where the target is locatedint
getTargetLevel()
Get the level at which the formatting will be appliedint
getTargetPosition()
Get the position in the axis where the target is locatedViewBean
getViewBean()
Utility method for obtaining theViewBean
indicated as target bean for this tab instance.boolean
isCrossTab()
Returns true if the selected object is a cross tab object.boolean
isPanelStack()
void
setActiveViewKey(java.lang.String activeViewKey)
Set the active view key.void
setTargetAxis(int axis)
Set the axis where the target is locatedvoid
setTargetAxisPosition(java.lang.String axisPosition)
Set the axis and position of the target, based on a string with the value of the axis and the position separated by a comma.void
setTargetLevel(int level)
Set the level at which the formatting will be appliedvoid
setTargetPosition(int position)
Set the position in the axis where the target is located-
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.app.beans.TabManagerBean
getActionId, getAllChildren, getAppliesToID, getCurrentTab, getSelectedTabOptions, getSelectedTypes, getTabProperties, getTabSwitchMode, getVisibleChildren, isPartialUpdate, isTabAvailable, setActionId, setAppliesToID, setCurrentTab, setCurrentTabName, setPartialUpdate, setSelectedTabOptions, setSelectedTypes, setTabProperties, setTabSwitchMode
-
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
-
-
-
-
Method Detail
-
setActiveViewKey
void setActiveViewKey(java.lang.String activeViewKey)
Set the active view key. It's used for initializing current bean from a view Bean.- Parameters:
activeViewKey
- The specific element to set as active.
-
getActiveViewKey
java.lang.String getActiveViewKey()
Returns the active view key.- Returns:
- String activeViewKey The specific element to set as active.
-
getViewBean
ViewBean getViewBean()
Utility method for obtaining theViewBean
indicated as target bean for this tab instance.
-
getTargetAxis
int getTargetAxis()
Get the axis where the target is located- Returns:
- Element from the
EnumDSSXMLAxisName
enumeration
-
setTargetAxis
void setTargetAxis(int axis)
Set the axis where the target is located- Parameters:
axis
- Element from theEnumDSSXMLAxisName
enumeration
-
getTargetPosition
int getTargetPosition()
Get the position in the axis where the target is located- Returns:
- the index where the target is located
-
setTargetPosition
void setTargetPosition(int position)
Set the position in the axis where the target is located- Parameters:
position
- the index where the target is located
-
getTargetLevel
int getTargetLevel()
Get the level at which the formatting will be applied- Returns:
- Element of the
EnumWebFormatType
enumeration indicating if the formatting is to be applied at the header, subtotal header, grid or subtotal grid level
-
setTargetLevel
void setTargetLevel(int level)
Set the level at which the formatting will be applied- Parameters:
level
- Element of theEnumWebFormatType
enumeration indicating if the formatting is to be applied at the header, subtotal header, grid or subtotal grid level
-
setTargetAxisPosition
void setTargetAxisPosition(java.lang.String axisPosition)
Set the axis and position of the target, based on a string with the value of the axis and the position separated by a comma. For example:1,3
for the third element on the grid row.- Parameters:
axisPosition
- String with value of the axis and position separated by a comma.
-
isCrossTab
boolean isCrossTab()
Returns true if the selected object is a cross tab object.- Returns:
- true if the selected object is a cross tab object.
-
isPanelStack
boolean isPanelStack()
- Returns:
- boolean value indicating if the selected object is a panel stack
- Since:
- MicroStrategy Web 8.1.0
-
-