Package com.microstrategy.web.app.beans

Interface VisualizationsEditorBean

All Superinterfaces:

AppComponent, EnumWebPersistableState, FrameElement, Persistable, ReportFrameElement, RequestPersistable, Transformable, ViewBeanParserBean, WebComponent

All Known Subinterfaces:

VisualizationPropertiesEditorBean

All Known Implementing Classes:

VisualizationPropertiesEditorBeanImpl, VisualizationsEditorBeanImpl

public interface VisualizationsEditorBean
extends ViewBeanParserBean, ReportFrameElement

Since:

MicroStrategy Web 8.0.2

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

Method Summary

Modifier and Type	Method	Description
boolean	areVisualizationsEnabled()
java.lang.String	getActiveLayoutID()	The ID of the layout whose visualization is being set.
VisualizationList	getAndroidTabletVisualizations()
VisualizationList	getAndroidVisualizations()
VisualizationList	getAvailableVisualizations()
VisualizationList	getIPadVisualizations()
VisualizationList	getIPhoneVisualizations()
int	getScope()
java.lang.String	getSelectedAndroidTabletVisualization()
java.lang.String	getSelectedAndroidVisualization()
java.lang.String	getSelectedIPadVisualization()
java.lang.String	getSelectedIPadVisualizations()	Deprecated. use getSelectedIPadVisualization()
java.lang.String	getSelectedIPhoneVisualization()
java.lang.String	getSelectedIPhoneVisualizations()	Deprecated. use getSelectedIPhoneVisualization()
java.lang.String	getSelectedSecondaryDataSourceKeys()
VisualizationList	getSelectedVisualizations()
HashList<java.lang.String,java.lang.String>	getVisProps()
boolean	haveSecondarySourcesChanged()
void	setScope(int scope)	Whether this editor applies to a Report (Visualization.SCOPE_REPORT), a Grid in a Document (Visualization.SCOPE_RW_GRID) or a Document (Visualization.SCOPE_RW)

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.app.beans.FrameElement

getFrameBean, getTargetBean, getTargetBeanPath, getUseIFrame, isEditor, isEnabled, setTargetBean, setTargetBeanPath, setUseIFrame

Methods inherited from interface com.microstrategy.utils.serialization.Persistable

restoreState, restoreState, saveState, saveState, saveState, saveState

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

getReportFrameBean, isGridDataNecessary

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.app.beans.ViewBeanParserBean

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

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, 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, setWebEventHandler

Method Detail

areVisualizationsEnabled

boolean areVisualizationsEnabled()

Returns:

whether visualizations are enabled for the current report or document.

getSelectedVisualizations

VisualizationList getSelectedVisualizations()

Returns:

the list of visualizations available for the current report or document.

getAvailableVisualizations

VisualizationList getAvailableVisualizations()

Returns:

the list of available visualizations with the scope set on the editor

getScope

int getScope()

Returns:

whether this editor applies to a Report (Visualization.SCOPE_REPORT), a Grid in a Document (Visualization.SCOPE_RW_GRID) or a Document (Visualization.SCOPE_RW)

setScope

void setScope(int scope)

Whether this editor applies to a Report (Visualization.SCOPE_REPORT), a Grid in a Document (Visualization.SCOPE_RW_GRID) or a Document (Visualization.SCOPE_RW)

Parameters:

scope - int

getSelectedSecondaryDataSourceKeys

java.lang.String getSelectedSecondaryDataSourceKeys()
                                             throws WebBeanException

Returns:

A comma separated list of the secondary providers for the selected grid

Throws:

WebBeanException

Since:

MicroStrategy Web 8.1.1

haveSecondarySourcesChanged

boolean haveSecondarySourcesChanged()
                             throws WebBeanException

Returns:

whether the original list of secondary providers changed.
This happens when one of the keys become invalid

Throws:

WebBeanException

Since:

MicroStrategy Web 8.1.1

getVisProps

HashList<java.lang.String,java.lang.String> getVisProps()

Returns:

the list of Visualization Properties

getActiveLayoutID

java.lang.String getActiveLayoutID()

The ID of the layout whose visualization is being set.
Note: only relevant when the scope is (Visualization.SCOPE_RW_LAYOUT)

Returns:

getIPhoneVisualizations

VisualizationList getIPhoneVisualizations()

Returns:

the list of available visualizations for the iphone

getIPadVisualizations

VisualizationList getIPadVisualizations()

Returns:

the list of available visualizations for the ipad

getAndroidVisualizations

VisualizationList getAndroidVisualizations()

Returns:

the list of available visualizations for android phone

getAndroidTabletVisualizations

VisualizationList getAndroidTabletVisualizations()

Returns:

the list of available visualizations for android tablet

getSelectedIPhoneVisualizations

@Deprecated
java.lang.String getSelectedIPhoneVisualizations()

Deprecated.

use getSelectedIPhoneVisualization()

Returns:

the selected visualization for the iphone

getSelectedIPhoneVisualization

java.lang.String getSelectedIPhoneVisualization()

Returns:

the selected visualization for the iphone

getSelectedIPadVisualizations

@Deprecated
java.lang.String getSelectedIPadVisualizations()

Deprecated.

use getSelectedIPadVisualization()

Returns:

the selected visualization for the ipad

getSelectedIPadVisualization

java.lang.String getSelectedIPadVisualization()

Returns:

the selected visualization for the ipad

getSelectedAndroidVisualization

java.lang.String getSelectedAndroidVisualization()

Returns:

the selected visualization for android phone

getSelectedAndroidTabletVisualization

java.lang.String getSelectedAndroidTabletVisualization()

Returns:

the selected visualization for android tablet