Package com.microstrategy.web.app.beans

Interface ViewBeanParserBean

All Superinterfaces:

AppComponent, Transformable, WebComponent

All Known Subinterfaces:

AdminTabBean, AlertsEditorBean, AttributeFormsEditorBean, AttributeFormsQualificationBean, ColorGradientEditorBean, ColorPickerEditorBean, ConfirmOverwriteDialogBean, DerivedElementsConvertDialogBean, DerivedElementsEditorBean, DrillFilterEditorBean, ExportOptionsEditorBean, FilterElementBean, FlashTabBean, FormatColorLinesTabBean, FormatNumberTabBean, FormatTabBean, FormulaBarBean, FunctionEditorBean, GraphColorGradientEditorBean, GraphTitleTabBean, GridColorGradientEditorBean, GroupbyPropertiesEditorBean, MetricQualLevelEditorBean, ObjectBrowserTabBean, OMDCreateFolderBean, ProjectBrowser, ReportObjectsTabBean, ReportWorkingSetBrowserTabBean, ResizeEditorBean, RibbonBean, RWActionControlEditorBean, RWDColorGradientEditorBean, RWGraphDropZonesEditorBean, RWProjectBrowserTabBean, RWWorkingSetBrowserTabBean, SecondaryDataSourcesEditorBean, SortEditorBean, SubscriptionEditorBean, SubsetUnitLimitElementBean, SubtotalsEditorBean, TabBean, TemplateElementsBean, ThresholdEditorBean, ViewFilterElementPanelBean, VisualizationPropertiesEditorBean, VisualizationsEditorBean

All Known Implementing Classes:

AbstractColorGradientEditorBeanImpl, AbstractObjectBrowserTabBean, AbstractTemplateElementsBean, AbstractViewBeanParserBean, AccordionTabManagerBeanImpl, AttributeFormsQualificationBeanImpl, ColorGradientEditorBeanImpl, GraphColorGradientEditorBeanImpl, GraphTitleTabBeanImpl, GridColorGradientEditorBeanImpl, OptimizedTabBeanImpl, ProjectBrowserBeanImpl, RibbonBeanImpl, RWDColorGradientEditorBeanImpl, RWGraphDropZonesEditorBeanImpl, SecondaryDataSourcesEditorBeanImpl, ViewFilterElementPanelBeanImpl, VisualizationPropertiesEditorBeanImpl, VisualizationsEditorBeanImpl

public interface ViewBeanParserBean
extends AppComponent

The ViewBeanParserBeanBean is used to represent an application bean that will manipiulate a View Bean from either a Report Bean or a Report Writer Bean.

Since:

MicroStrategy Web 8.0.0

Field Summary

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

COMPONENT_POSITION_NOT_INITIALIZED

Method Summary

Modifier and Type	Method	Description
int	getActiveElementIndex()	Deprecated. This method will no longer be part of this interface.
java.lang.String	getActiveViewKey()	Returns the active view key.
java.util.ArrayList	getTemplateElementList()	Deprecated. This method will no longer be part of this interface.
ViewBean	getViewBean()	Get a instance of the ViewBean associated with the bean.
ViewBean	getViewBean(int viewInstance)	Deprecated. This method will no longer be part of this interface.
void	setActiveElementIndex(int activeElementIndex)	Deprecated. This method will no longer be part of this interface.
void	setActiveViewKey(java.lang.String activeViewKey)	Set the active view key.

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.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 activeElementIndex The specific element to set as active.

getViewBean

ViewBean getViewBean()

Get a instance of the ViewBean associated with the bean. It will not return the data of the specific view bean. Just the definition will be returned.

Returns:

ViewBean instance

getActiveElementIndex

@Deprecated
int getActiveElementIndex()

Deprecated.

This method will no longer be part of this interface.

Returns:

the Active element index. It's used to pre-select an item in the template elements list

setActiveElementIndex

@Deprecated
void setActiveElementIndex(int activeElementIndex)

Deprecated.

This method will no longer be part of this interface.

Set the Active element index. It's used to pre-select an item in the template elements list

Parameters:

activeElementIndex - the active element index

getTemplateElementList

@Deprecated
java.util.ArrayList getTemplateElementList()

Deprecated.

This method will no longer be part of this interface. Create the TemplateParser using the getViewBean to access the template element list.

Get a list of template elements from ReportBean or RWBean.

Returns:

An arraylist containing the elements.

getViewBean

@Deprecated
ViewBean getViewBean(int viewInstance)

Deprecated.

This method will no longer be part of this interface.

Get a specific instance of the ViewBean associated with the bean. It will return the data of the specific view bean along with the definition.

Returns:

ViewBean instance