Package com.microstrategy.web.app.beans
Class VisualizationsEditorBeanImpl
- 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.VisualizationsEditorBeanImpl
-
- All Implemented Interfaces:
EnumWebPersistableState
,Persistable
,AppComponent
,FrameElement
,ReportFrameElement
,ViewBeanParserBean
,VisualizationsEditorBean
,RequestPersistable
,Transformable
,WebComponent
- Direct Known Subclasses:
VisualizationPropertiesEditorBeanImpl
public class VisualizationsEditorBeanImpl extends AbstractViewBeanParserBean implements VisualizationsEditorBean
- Since:
- MicroStrategy Web 8.0.2
-
-
Field Summary
-
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
-
-
Constructor Summary
Constructors Constructor Description VisualizationsEditorBeanImpl()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods 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.java.lang.String
getSelectedIPhoneVisualization()
java.lang.String
getSelectedIPhoneVisualizations()
java.lang.String
getSelectedSecondaryDataSourceKeys()
VisualizationList
getSelectedVisualizations()
HashList<java.lang.String,java.lang.String>
getVisProps()
protected boolean
hasTargetBeanChanged()
When this method is called, we have already checked the children and each of the children has returned with hasChanged() as false.boolean
haveSecondarySourcesChanged()
boolean
isEditor()
Indicates whether the instance most be considered editor.boolean
isEnabled()
Indicates whether a ReportFrameElement is Enabled.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 class com.microstrategy.web.app.beans.AbstractViewBeanParserBean
doFlatState, getActiveElementIndex, getActiveViewKey, getTemplateElementList, getViewBean, getViewBean, setActiveElementIndex, setActiveViewKey
-
Methods inherited from class com.microstrategy.web.app.beans.AbstractPersistableFrameElement
doCollectData, getDocumentFrameBean, getFeaturesManager, getFrameBean, getReportFrameBean, getRWFrameBean, getUseIFrame, isGridDataNecessary, isIFrameEnabled, isOpen, setIsOpen, setUseIFrame
-
Methods inherited from class com.microstrategy.web.app.beans.AbstractPersistableAppComponent
addChildStateInfo, isCookieOpen, isSaveStateEnabled, saveState, saveState, saveState, saveState
-
Methods inherited from class com.microstrategy.web.app.beans.AbstractAppComponent
addChildStateInfo, collectData, collectMinimalData, compareChildsTargetWithCurrent, createTransformInstance, doCollectMinimalData, generateOutput, getAppContext, getContactInfo, getContainerServices, getDescriptor, getDescriptor, getEventManager, getExtraInput, getExtraUrl, getLeft, getObjectSource, getResultFilterMode, getSession, getTargetBean, getTop, getType, getWebObjectsFactory, getWebObjectsFactory, getXMLStatus, hasChanged, 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, newDefaultEventHandler, prepareForReuse, 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, isOpen, setExtraInput, setExtraUrl, setForcedChildrenStateSaving, setHasJustOpened, setIsDialog, setIsModal, setIsOpen, setLeft, setTop
-
Methods inherited from interface com.microstrategy.web.app.beans.FrameElement
getFrameBean, getTargetBean, getTargetBeanPath, getUseIFrame, 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
public boolean areVisualizationsEnabled()
- Specified by:
areVisualizationsEnabled
in interfaceVisualizationsEditorBean
- Returns:
- whether visualizations are enabled for the current report or document.
-
getAvailableVisualizations
public VisualizationList getAvailableVisualizations()
- Specified by:
getAvailableVisualizations
in interfaceVisualizationsEditorBean
- Returns:
- the list of available visualizations with the scope set on the editor
-
getSelectedVisualizations
public VisualizationList getSelectedVisualizations()
- Specified by:
getSelectedVisualizations
in interfaceVisualizationsEditorBean
- Returns:
- the list of visualizations available for the current report or document.
-
isEnabled
public boolean isEnabled()
Description copied from interface:FrameElement
Indicates whether a ReportFrameElement is Enabled. Each bean checks its own features and other settings to determine whether it is enabled or not.- Specified by:
isEnabled
in interfaceFrameElement
- Returns:
- true
- See Also:
AbstractPersistableFrameElement.isEditor()
-
isEditor
public boolean isEditor()
Indicates whether the instance most be considered editor.- Specified by:
isEditor
in interfaceFrameElement
- Overrides:
isEditor
in classAbstractPersistableFrameElement
- Returns:
True
.
-
getScope
public int getScope()
- Specified by:
getScope
in interfaceVisualizationsEditorBean
- 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
) - See Also:
VisualizationsEditorBean.getScope()
-
getActiveLayoutID
public java.lang.String getActiveLayoutID()
Description copied from interface:VisualizationsEditorBean
The ID of the layout whose visualization is being set.
Note: only relevant when the scope is (Visualization.SCOPE_RW_LAYOUT
)- Specified by:
getActiveLayoutID
in interfaceVisualizationsEditorBean
- Returns:
-
setScope
public void setScope(int scope)
Description copied from interface:VisualizationsEditorBean
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
)- Specified by:
setScope
in interfaceVisualizationsEditorBean
- Parameters:
scope
- int- See Also:
VisualizationsEditorBean.setScope(int)
-
getSelectedSecondaryDataSourceKeys
public java.lang.String getSelectedSecondaryDataSourceKeys() throws WebBeanException
- Specified by:
getSelectedSecondaryDataSourceKeys
in interfaceVisualizationsEditorBean
- Returns:
- A comma separated list of the secondary providers for the selected grid
- Throws:
WebBeanException
- Since:
- MicroStrategy Web 8.1.1
-
haveSecondarySourcesChanged
public boolean haveSecondarySourcesChanged() throws WebBeanException
- Specified by:
haveSecondarySourcesChanged
in interfaceVisualizationsEditorBean
- 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
public HashList<java.lang.String,java.lang.String> getVisProps()
- Specified by:
getVisProps
in interfaceVisualizationsEditorBean
- Returns:
- the list of Visualization Properties
-
hasTargetBeanChanged
protected boolean hasTargetBeanChanged()
Description copied from class:AbstractAppComponent
When this method is called, we have already checked the children and each of the children has returned with hasChanged() as false. If #compareChildsTargetWithCurrent method returns true, then we check if any of the child's target bean is same as this object's target bean and return true if this is the case. If you want to check the targetbean of this component, then override compareChildsTargetWithCurrent to return true- Overrides:
hasTargetBeanChanged
in classAbstractAppComponent
-
getIPhoneVisualizations
public VisualizationList getIPhoneVisualizations()
- Specified by:
getIPhoneVisualizations
in interfaceVisualizationsEditorBean
- Returns:
- the list of available visualizations for the iphone
-
getIPadVisualizations
public VisualizationList getIPadVisualizations()
- Specified by:
getIPadVisualizations
in interfaceVisualizationsEditorBean
- Returns:
- the list of available visualizations for the ipad
-
getAndroidVisualizations
public VisualizationList getAndroidVisualizations()
- Specified by:
getAndroidVisualizations
in interfaceVisualizationsEditorBean
- Returns:
- the list of available visualizations for android phone
-
getAndroidTabletVisualizations
public VisualizationList getAndroidTabletVisualizations()
- Specified by:
getAndroidTabletVisualizations
in interfaceVisualizationsEditorBean
- Returns:
- the list of available visualizations for android tablet
-
getSelectedIPhoneVisualizations
public java.lang.String getSelectedIPhoneVisualizations()
- Specified by:
getSelectedIPhoneVisualizations
in interfaceVisualizationsEditorBean
- Returns:
- the selected visualization for the iphone
-
getSelectedIPhoneVisualization
public java.lang.String getSelectedIPhoneVisualization()
- Specified by:
getSelectedIPhoneVisualization
in interfaceVisualizationsEditorBean
- Returns:
- the selected visualization for the iphone
-
getSelectedIPadVisualizations
public java.lang.String getSelectedIPadVisualizations()
Deprecated.- Specified by:
getSelectedIPadVisualizations
in interfaceVisualizationsEditorBean
- Returns:
- the selected visualization for the ipad
-
getSelectedIPadVisualization
public java.lang.String getSelectedIPadVisualization()
- Specified by:
getSelectedIPadVisualization
in interfaceVisualizationsEditorBean
- Returns:
- the selected visualization for the ipad
-
getSelectedAndroidVisualization
public java.lang.String getSelectedAndroidVisualization()
- Specified by:
getSelectedAndroidVisualization
in interfaceVisualizationsEditorBean
- Returns:
- the selected visualization for android phone
-
getSelectedAndroidTabletVisualization
public java.lang.String getSelectedAndroidTabletVisualization()
- Specified by:
getSelectedAndroidTabletVisualization
in interfaceVisualizationsEditorBean
- Returns:
- the selected visualization for android tablet
-
-