Package com.microstrategy.web.app.beans

Interface VisualizationPropertiesEditorBean

All Superinterfaces:

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

All Known Implementing Classes:

VisualizationPropertiesEditorBeanImpl

public interface VisualizationPropertiesEditorBean
extends VisualizationsEditorBean

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
java.lang.String	getSecondaryDataProviders()
Visualization	getSelectedVisualization()
JsonGenerator	getVisPropsJson()
void	setSelectedVisualizationName(java.lang.String visName)	Sets the name of the current visualization.

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

areVisualizationsEnabled, getActiveLayoutID, getAndroidTabletVisualizations, getAndroidVisualizations, getAvailableVisualizations, getIPadVisualizations, getIPhoneVisualizations, getScope, getSelectedAndroidTabletVisualization, getSelectedAndroidVisualization, getSelectedIPadVisualization, getSelectedIPadVisualizations, getSelectedIPhoneVisualization, getSelectedIPhoneVisualizations, getSelectedSecondaryDataSourceKeys, getSelectedVisualizations, getVisProps, haveSecondarySourcesChanged, setScope

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

getSelectedVisualization

Visualization getSelectedVisualization()
                                throws WebObjectsException,
                                       WebBeanException

Returns:

the selected visualization

Throws:

WebObjectsException

WebBeanException

setSelectedVisualizationName

void setSelectedVisualizationName(java.lang.String visName)

Sets the name of the current visualization.
Note: This editor has a setter because the properties it would display could be of a visualization that may not be set on the report bean yet.

Parameters:

visName - the name of the current visualization

getSecondaryDataProviders

java.lang.String getSecondaryDataProviders()

Returns:

the Comma separated value list of secondary data provider keys

getVisPropsJson

JsonGenerator getVisPropsJson()

Returns:

the Json data of visualization properties