Package com.microstrategy.web.app.beans

Class AccordionTabManagerBeanImpl

java.lang.Object

com.microstrategy.utils.serialization.AbstractPersistable

com.microstrategy.web.beans.AbstractTransformable

com.microstrategy.web.beans.AbstractWebComponent

com.microstrategy.web.app.beans.AbstractAppComponent

com.microstrategy.web.app.beans.AbstractPersistableAppComponent

com.microstrategy.web.app.beans.AbstractPersistableFrameElement

com.microstrategy.web.app.beans.AbstractViewBeanParserBean

com.microstrategy.web.app.beans.AccordionTabManagerBeanImpl

All Implemented Interfaces:

EnumWebPersistableState, Persistable, AppComponent, TabManagerBean, ViewBeanParserBean, RequestPersistable, Transformable, WebComponent

public class AccordionTabManagerBeanImpl
extends AbstractViewBeanParserBean

Since:

MicroStrategy Web 9.0.0

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.String	_currentTabName

Fields inherited from class com.microstrategy.web.app.beans.AbstractPersistableAppComponent

STATE_DELIMITOR, STATE_ITEM_SEPARATOR

Fields inherited from class com.microstrategy.web.beans.AbstractWebComponent

_features, _hasJustOpened

Fields inherited from class com.microstrategy.web.beans.AbstractTransformable

_beanContext

Fields inherited from class com.microstrategy.utils.serialization.AbstractPersistable

scriptEndTagEncoder

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

Constructor Summary

Constructors

Constructor	Description
AccordionTabManagerBeanImpl()

Method Summary

Modifier and Type	Method	Description
void	doCollectData()	Prepare the bean, collect all the information it needs before it is rendered.
protected void	doFlatState(FlatStateSerializer serializer, int howMuchState, FlatStateTokenizer tokenizer)	Utility method for collecting the bean's state and save it on a string representation
MarkupOutput	generateOutput()	Generate the output of this bean.
int	getActionId()	getActionId Return the action id that caused the editor to open, i.e, edit, add
HashList	getAllChildren()	From the list of all children beans defined for this manager, return a HashList.
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.
WebFeatures	getFeaturesManager()	Overrides getFeaturesManager by providing a new Features implementation for FrameElements.
java.lang.String	getRememberLastEditorPanel()
java.lang.String	getSelectedTabOptions()	getSelectedOptions
java.lang.String	getSelectedTypes()	set the list of object types selected in the client.
HashList	getTabProperties()	Returns the HashList containing properties of all tabs
int	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 a HashList of those that are currently visible or available.
int	getXMLStatus()	Returns the EnumRequestStatus status of the component.
boolean	hasChanged()	Verifies the state of the component has changed
protected boolean	isCookieOpen(java.lang.String key)	Checks if the given key is marked as opened.
boolean	isOpen()	Overrides isOpen by making sure FrameElements use the FrameBean to control their open-close status.
boolean	isPartialUpdate()
boolean	isTabAvailable(TabBean childTab)	Indicates whether the chikd tab will be available for selection.
protected WebEventHandler	newDefaultEventHandler()
void	prepareForReuse()	If a Web Component instance is going to be reused across different requests, this API serves as a notifier to the component to do the necessary cleanup.
java.lang.String	rememberLastEditorPanel()
void	setActionId(int actionId)	setActionId Set the action id that caused the editor to open, i.e, edit, add
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 this 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	setDefaultTabNameMDXReportDesign(java.lang.String value)
void	setDefaultTabNameMDXReportRun(java.lang.String value)
void	setDefaultTabNameReportDesign(java.lang.String value)
void	setDefaultTabNameReportRun(java.lang.String value)
void	setDefaultTabNameRWDesign(java.lang.String value)
void	setDefaultTabNameRWRun(java.lang.String value)
void	setPartialUpdate(boolean partialUpdate)
void	setSelectedTabOptions(java.lang.String selectedTabOptions)	setSelectedOptions
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.
protected void	syncTabName()	This method looks at the tab with the name that matches _currentTabName.

Methods inherited from class com.microstrategy.web.app.beans.AbstractViewBeanParserBean

getActiveElementIndex, getActiveViewKey, getTemplateElementList, getViewBean, getViewBean, setActiveElementIndex, setActiveViewKey

Methods inherited from class com.microstrategy.web.app.beans.AbstractPersistableFrameElement

getDocumentFrameBean, getFrameBean, getReportFrameBean, getRWFrameBean, getUseIFrame, isEditor, isGridDataNecessary, isIFrameEnabled, setIsOpen, setUseIFrame

Methods inherited from class com.microstrategy.web.app.beans.AbstractPersistableAppComponent

addChildStateInfo, isSaveStateEnabled, saveState, saveState, saveState, saveState

Methods inherited from class com.microstrategy.web.app.beans.AbstractAppComponent

addChildStateInfo, collectData, collectMinimalData, compareChildsTargetWithCurrent, createTransformInstance, doCollectMinimalData, getAppContext, getContactInfo, getContainerServices, getDescriptor, getDescriptor, getEventManager, getExtraInput, getExtraUrl, getLeft, getObjectSource, getResultFilterMode, getSession, getTargetBean, getTop, getType, getWebObjectsFactory, getWebObjectsFactory, hasTargetBeanChanged, haveChildrenChanged, initComponent, internalCollectData, isDialog, isForcedChildrenStateSaving, isIFrameRequest, isModal, isModalOpen, newDefaultBeanContext, newHiddenInputBuilder, newNamespaceEncoder, newStyleRequestContext, newURIBuilder, setExtraInput, setExtraUrl, setForcedChildrenStateSaving, setHasJustOpened, setIsDialog, setIsModal, setLeft, setOutputFormat, setTop

Methods inherited from class com.microstrategy.web.beans.AbstractWebComponent

addChild, addChildStateInfo, addChildStateInfo, addChildStateInfo, addStateInfo, childValues, clearChildren, clearStateCache, getCachedState, getChild, getChild, getChildByClass, getChildByType, getChildCount, getChildrenByClass, getDefaultStateLevel, getMaximumStateLevel, getName, getOutputFormat, getParent, getPath, getPersistMode, getRenderingFilter, getRoot, getTargetBeanPath, getWebEvent, getWebEvent, getWebEventHandler, handleRequest, hasJustOpened, initBean, invalidateChildrenState, isBeanContextEmpty, isChangeComparisonFlagSet, isFeatureAvailable, removeChild, removeChild, restoreState, restoreStateFromRequest, restoreStateFromRequest, saveXMLState, saveXMLState, saveXMLState, searchChild, setBeanContext, setBeanContext, setChanged, setChanged, setDefaultStateLevel, setFeaturesManager, setName, setParent, setPersistMode, setRenderingFilter, setStateCache, setTargetBean, setTargetBeanPath, setWebEventHandler

Methods inherited from class com.microstrategy.web.beans.AbstractTransformable

addTransform, addTransform, addTransformByClass, addTransformByStyle, addTransformByStyle, clearTransforms, createTransformInstance, getBeanContext, getDefaultTransform, getMessageString, getMyTransformInstances, getTransformInstance, getTransformInstance, getTransformInstances, hasTransform, hasTransform, internalCollectData, internalCollectData, invalidateTransformCache, isTransformSuitable, transform, transform, transform, transform

Methods inherited from class com.microstrategy.utils.serialization.AbstractPersistable

doFlatState, getStateHandler, isXMLStateZipped, restoreState, restoreXMLState, saveXMLState

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.microstrategy.web.app.beans.AppComponent

getAppContext, getDescriptor, getDescriptor, getEventManager, getExtraInput, getExtraUrl, getLeft, getResultFilterMode, getTop, isDialog, isForcedChildrenStateSaving, isModal, isModalOpen, 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, getBeanContext, getChild, getChild, getChildByClass, getChildByType, getChildCount, getChildrenByClass, getDefaultStateLevel, getMaximumStateLevel, getName, getOutputFormat, getParent, getPath, getPersistMode, getRenderingFilter, getRoot, getTargetBean, getTargetBeanPath, getWebEvent, getWebEvent, getWebEventHandler, handleRequest, hasJustOpened, initBean, invalidateChildrenState, isBeanContextEmpty, isFeatureAvailable, removeChild, removeChild, searchChild, setBeanContext, setBeanContext, setChanged, setChanged, setDefaultStateLevel, setFeaturesManager, setName, setOutputFormat, setParent, setPersistMode, setRenderingFilter, setTargetBean, setTargetBeanPath, setWebEventHandler

Field Detail

_currentTabName

protected java.lang.String _currentTabName

Constructor Detail

AccordionTabManagerBeanImpl

public AccordionTabManagerBeanImpl()

Method Detail

isOpen

public boolean isOpen()

Description copied from class: AbstractPersistableFrameElement

Overrides isOpen by making sure FrameElements use the FrameBean to control their open-close status. If the bean is a FrameElement and has a FrameBean as a parent, then it will ask the FrameBean if it's open, otherwise it would use the default isOpen implementation.

Specified by:

isOpen in interface AppComponent

Overrides:

isOpen in class AbstractPersistableFrameElement

Returns:

boolean true if open

doCollectData

public void doCollectData()

Prepare the bean, collect all the information it needs before it is rendered.

getFeaturesManager

public WebFeatures getFeaturesManager()

Description copied from class: AbstractPersistableFrameElement

Overrides getFeaturesManager by providing a new Features implementation for FrameElements.

Specified by:

getFeaturesManager in interface WebComponent

Overrides:

getFeaturesManager in class AbstractPersistableFrameElement

Returns:

a FrameElementsFeatures if the concrete bean implements FrameElement, otherwise the default FeaturesManager.

isCookieOpen

protected boolean isCookieOpen(java.lang.String key)

Checks if the given key is marked as opened. This method handles accordion related cookies differently; for other cookies it's calling super implementation

Overrides:

isCookieOpen in class AbstractPersistableAppComponent

Parameters:

key - String value with the key to look for on cookie values

Returns:

true if the element is open as indicated by cookies.

hasChanged

public boolean hasChanged()

Description copied from class: AbstractWebComponent

Verifies the state of the component has changed

Specified by:

hasChanged in interface WebComponent

Overrides:

hasChanged in class AbstractAppComponent

Returns:

boolean value indicating if the current instance or its base bean (if any defined) has been marked as changed.

syncTabName

protected void syncTabName()

This method looks at the tab with the name that matches _currentTabName. If this tab is available to show then set the _currentTab to be it. This way we make sure that the _currentTabName is being mapped to _currentTab only when the tab is available.

rememberLastEditorPanel

public java.lang.String rememberLastEditorPanel()

getRememberLastEditorPanel

public java.lang.String getRememberLastEditorPanel()

setDefaultTabNameReportRun

public void setDefaultTabNameReportRun(java.lang.String value)

setDefaultTabNameReportDesign

public void setDefaultTabNameReportDesign(java.lang.String value)

setDefaultTabNameMDXReportRun

public void setDefaultTabNameMDXReportRun(java.lang.String value)

setDefaultTabNameMDXReportDesign

public void setDefaultTabNameMDXReportDesign(java.lang.String value)

setDefaultTabNameRWRun

public void setDefaultTabNameRWRun(java.lang.String value)

setDefaultTabNameRWDesign

public void setDefaultTabNameRWDesign(java.lang.String value)

generateOutput

public MarkupOutput generateOutput()

Generate the output of this bean. Creates all the HTML required for the display of the instance on a JSP page.

Specified by:

generateOutput in interface WebComponent

Overrides:

generateOutput in class AbstractAppComponent

Returns:

a MarkupOutput instance with the HTML to be displayed for this bean.

getCurrentTab

public int getCurrentTab()

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

Specified by:

getCurrentTab in interface TabManagerBean

Returns:

int value representing the current selected tab.

setCurrentTab

public void setCurrentTab(int currentTab)

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

Specified by:

setCurrentTab in interface TabManagerBean

Parameters:

currentTab - int representing which tab is to be selected as current

setCurrentTabName

public void setCurrentTabName(java.lang.String currentTabName)

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

Specified by:

setCurrentTabName in interface TabManagerBean

Parameters:

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

getVisibleChildren

public 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.

Specified by:

getVisibleChildren in interface TabManagerBean

Parameters:

hideUnavailable - TODO

Returns:

a HashList of the children beans of this manager that are visible.

getAllChildren

public HashList getAllChildren()

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

Specified by:

getAllChildren in interface TabManagerBean

Returns:

all HashList of the children beans of this manager.

isTabAvailable

public boolean isTabAvailable(TabBean childTab)

Indicates whether the chikd tab will be available for selection.

Specified by:

isTabAvailable in interface TabManagerBean

Parameters:

childTab - TabBean instance to test for its availability

Returns:

boolean value.

getXMLStatus

public int getXMLStatus()

Description copied from class: AbstractAppComponent

Returns the EnumRequestStatus status of the component. The status determined by by the status of its children with the following precedence.

EnumRequestStatus.WebBeanRequestEndsInError EnumRequestStatus.WebBeanRequestCanceled EnumRequestStatus.WebBeanRequestProcessing EnumRequestStatus.WebBeanRequestNotInitiated EnumRequestStatus.WebBeanRequestWaitingForUserInput EnumRequestStatus.WebBeanRequestSuccessful

Specified by:

getXMLStatus in interface WebComponent

Overrides:

getXMLStatus in class AbstractAppComponent

Returns:

the EnumRequestStatus of the component.

See Also:

Returns the status of the component. The status determined by by the status of its children with the following precedence.

setSelectedTypes

public void setSelectedTypes(java.lang.String selectedTypes)

Set the list of object types selected in the client.

Specified by:

setSelectedTypes in interface TabManagerBean

Parameters:

selectedTypes - String representing the list of selected objects.

getSelectedTypes

public java.lang.String getSelectedTypes()

set the list of object types selected in the client.

Specified by:

getSelectedTypes in interface TabManagerBean

Returns:

String representing the list of selected objects.

setTabSwitchMode

public 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

Specified by:

setTabSwitchMode in interface TabManagerBean

Parameters:

switchMode - int

getTabSwitchMode

public int getTabSwitchMode()

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

Specified by:

getTabSwitchMode in interface TabManagerBean

Returns:

int

getActionId

public int getActionId()

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

Specified by:

getActionId in interface TabManagerBean

Returns:

int

setActionId

public void setActionId(int actionId)

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

Specified by:

setActionId in interface TabManagerBean

Parameters:

actionId - int

setAppliesToID

public void setAppliesToID(java.lang.String boneId)

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

Specified by:

setAppliesToID in interface TabManagerBean

Parameters:

boneId - String

getAppliesToID

public java.lang.String getAppliesToID()

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

Specified by:

getAppliesToID in interface TabManagerBean

Returns:

String

doFlatState

protected void doFlatState(FlatStateSerializer serializer,
                           int howMuchState,
                           FlatStateTokenizer tokenizer)

Utility method for collecting the bean's state and save it on a string representation

Overrides:

doFlatState in class AbstractViewBeanParserBean

Parameters:

serializer - FlatStateSerializer instance

howMuchState - int value indicating how much state should be saved for the bean

tokenizer - FlatStateTokenizer instance

setTabProperties

public void setTabProperties(java.lang.String tabName,
                             java.lang.Object prop)

Description copied from interface: TabManagerBean

Sets bone properties for individual tabs of the editor.

Specified by:

setTabProperties in interface TabManagerBean

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

getTabProperties

public HashList getTabProperties()

Description copied from interface: TabManagerBean

Returns the HashList containing properties of all tabs

Specified by:

getTabProperties in interface TabManagerBean

getSelectedTabOptions

public java.lang.String getSelectedTabOptions()

getSelectedOptions

Specified by:

getSelectedTabOptions in interface TabManagerBean

Returns:

String

Since:

MicroStrategy Web 8.0.1

setSelectedTabOptions

public void setSelectedTabOptions(java.lang.String selectedTabOptions)

setSelectedOptions

Specified by:

setSelectedTabOptions in interface TabManagerBean

Parameters:

selectedTabOptions - String

Since:

MicroStrategy Web 8.0.1

setPartialUpdate

public void setPartialUpdate(boolean partialUpdate)

Specified by:

setPartialUpdate in interface TabManagerBean

isPartialUpdate

public boolean isPartialUpdate()

Specified by:

isPartialUpdate in interface TabManagerBean

newDefaultEventHandler

protected WebEventHandler newDefaultEventHandler()

Overrides:

newDefaultEventHandler in class AbstractWebComponent

prepareForReuse

public void prepareForReuse()

Description copied from interface: WebComponent

If a Web Component instance is going to be reused across different requests, this API serves as a notifier to the component to do the necessary cleanup.

Specified by:

prepareForReuse in interface WebComponent

Overrides:

prepareForReuse in class AbstractWebComponent