public class

AccordionTabManagerBeanImpl

extends AbstractViewBeanParserBean
implements TabManagerBean
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

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.beans.AbstractPersistableAppComponent
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
From interface com.microstrategy.web.app.beans.AppComponent
From interface com.microstrategy.web.app.beans.TabManagerBean
Fields
protected String _currentTabName
[Expand]
Inherited Fields
From class com.microstrategy.web.beans.AbstractWebComponent
From class com.microstrategy.web.beans.AbstractTransformable
Public Constructors
AccordionTabManagerBeanImpl()
Public Methods
void doCollectData()
Prepare the bean, collect all the information it needs before it is rendered.
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.
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.
String getRememberLastEditorPanel()
String getSelectedTabOptions()
getSelectedOptions
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
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.
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.
String rememberLastEditorPanel()
void setActionId(int actionId)
setActionId Set the action id that caused the editor to open, i.e, edit, add
void setAppliesToID(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(String currentTabName)
Set the tab to be displayed by the this manager as current one by name of the tab.
void setDefaultTabNameMDXReportDesign(String value)
void setDefaultTabNameMDXReportRun(String value)
void setDefaultTabNameRWDesign(String value)
void setDefaultTabNameRWRun(String value)
void setDefaultTabNameReportDesign(String value)
void setDefaultTabNameReportRun(String value)
void setPartialUpdate(boolean partialUpdate)
void setSelectedTabOptions(String selectedTabOptions)
setSelectedOptions
void setSelectedTypes(String selectedTypes)
Set the list of object types selected in the client.
void setTabProperties(String tabName, 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 Methods
void doFlatState(FlatStateSerializer serializer, int howMuchState, FlatStateTokenizer tokenizer)
Utility method for collecting the bean's state and save it on a string representation
boolean isCookieOpen(String key)
Checks if the given key is marked as opened.
WebEventHandler newDefaultEventHandler()
void syncTabName()
This method looks at the tab with the name that matches _currentTabName.
[Expand]
Inherited Methods
From class com.microstrategy.web.app.beans.AbstractViewBeanParserBean
From class com.microstrategy.web.app.beans.AbstractPersistableFrameElement
From class com.microstrategy.web.app.beans.AbstractPersistableAppComponent
From class com.microstrategy.web.app.beans.AbstractAppComponent
From class com.microstrategy.web.beans.AbstractWebComponent
From class com.microstrategy.web.beans.AbstractTransformable
From class com.microstrategy.utils.serialization.AbstractPersistable
From class java.lang.Object
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.app.beans.AppComponent
From interface com.microstrategy.web.app.beans.TabManagerBean
From interface com.microstrategy.web.app.beans.ViewBeanParserBean
From interface com.microstrategy.web.beans.RequestPersistable
From interface com.microstrategy.web.beans.Transformable
From interface com.microstrategy.web.beans.WebComponent

Fields

protected String _currentTabName

Public Constructors

public AccordionTabManagerBeanImpl ()

Public Methods

public void doCollectData ()

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

public MarkupOutput generateOutput ()

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

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

public int getActionId ()

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

Returns
  • int

public 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 String getAppliesToID ()

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

Returns
  • String

public int getCurrentTab ()

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

Returns
  • int value representing the current selected tab.

public WebFeatures getFeaturesManager ()

Overrides getFeaturesManager by providing a new Features implementation for FrameElements.

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

public String getRememberLastEditorPanel ()

public String getSelectedTabOptions ()

getSelectedOptions

Returns
  • String

public String getSelectedTypes ()

set the list of object types selected in the client.

Returns
  • String representing the list of selected objects.

public HashList getTabProperties ()

Returns the HashList containing properties of all tabs

public int getTabSwitchMode ()

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

Returns
  • int

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.

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

public boolean hasChanged ()

Verifies the state of the component has changed

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

public boolean isOpen ()

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.

Returns
  • boolean true if open

public boolean isPartialUpdate ()

public boolean isTabAvailable (TabBean childTab)

Indicates whether the chikd tab will be available for selection.

Parameters
childTab TabBean instance to test for its availability
Returns
  • boolean value.

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

public String rememberLastEditorPanel ()

public void setActionId (int actionId)

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

Parameters
actionId int

public void setAppliesToID (String boneId)

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

Parameters
boneId String

public void setCurrentTab (int currentTab)

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

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

public 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 void setDefaultTabNameMDXReportDesign (String value)

public void setDefaultTabNameMDXReportRun (String value)

public void setDefaultTabNameRWDesign (String value)

public void setDefaultTabNameRWRun (String value)

public void setDefaultTabNameReportDesign (String value)

public void setDefaultTabNameReportRun (String value)

public void setPartialUpdate (boolean partialUpdate)

public void setSelectedTabOptions (String selectedTabOptions)

setSelectedOptions

Parameters
selectedTabOptions String

public void setSelectedTypes (String selectedTypes)

Set the list of object types selected in the client.

Parameters
selectedTypes String representing the list of selected objects.

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

Protected Methods

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

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

Parameters
serializer FlatStateSerializer instance
howMuchState int value indicating how much state should be saved for the bean
tokenizer FlatStateTokenizer instance

protected boolean isCookieOpen (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

Parameters
key String value with the key to look for on cookie values
Returns
  • true if the element is open as indicated by cookies.

protected WebEventHandler newDefaultEventHandler ()

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.