Package com.microstrategy.web.app.addons
Class RWSetFlagsAddOn
- java.lang.Object
-
- com.microstrategy.web.app.addons.AbstractAppAddOn
-
- com.microstrategy.web.app.addons.RWSetFlagsAddOn
-
- All Implemented Interfaces:
AppAddOns
public class RWSetFlagsAddOn extends AbstractAppAddOn
This add on takes care of setting the result flags specified on the view mode set for visualizations.
The flags will only be set if visualizations are supported.
If we are on the document page, the flags will only be set if we are in non-editable view mode.- Since:
- MicroStrategy Web 8.0.2
-
-
Constructor Summary
Constructors Constructor Description RWSetFlagsAddOn()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description java.lang.String
getAddOnDescription()
This method describes the tasks performed by the AddOn.boolean
getUseTerseElementIDs()
void
preCollectData(PageComponent pg)
This is the main method of the add on which executes the add on.void
setAdvThresholdEditorName(java.lang.String advThresholdEditorName)
void
setBeanName(java.lang.String name)
Sets the RW Bean namevoid
setCurrentSelectedGridKey(java.lang.String gridKey)
void
setOptimizeForUseURLForVisualizationsPreference(boolean optimizeForUseURLForVisualizationsPreference)
Whether to optimize flags if the useURLForVisualizations preference is true.void
setResultFlags(int flags)
Deprecated.void
setUseTerseElementIDs(boolean useTerse)
void
setViewMode(int viewMode)
Deprecated.void
setViewModeFlags(java.lang.String vmFlags)
Sets the result flags for specific view modes.
The format must be:
"viewMode:flags,viewMode2:flags2"
void
setVisThresholdEditorName(java.lang.String visThresholdEditorName)
-
Methods inherited from class com.microstrategy.web.app.addons.AbstractAppAddOn
getRequestKeys, isCollectDataRequired, isIFrameRequest, postCollectData
-
-
-
-
Method Detail
-
preCollectData
public void preCollectData(PageComponent pg)
Description copied from interface:AppAddOns
This is the main method of the add on which executes the add on. This has to be a static method.- Specified by:
preCollectData
in interfaceAppAddOns
- Overrides:
preCollectData
in classAbstractAppAddOn
- Parameters:
pg
- is the PageComponent.
-
setBeanName
public void setBeanName(java.lang.String name)
Sets the RW Bean name- Parameters:
name
- bean name
-
setViewMode
public void setViewMode(int viewMode)
Deprecated.Sets the View Mode to set the flags for- Parameters:
viewMode
- bean the View Mode to set the flags for
-
setResultFlags
public void setResultFlags(int flags)
Deprecated.Sets the result flags to set- Parameters:
flags
- the result flags to set
-
setViewModeFlags
public void setViewModeFlags(java.lang.String vmFlags)
Sets the result flags for specific view modes.
The format must be:
"viewMode:flags,viewMode2:flags2"
- Parameters:
vmFlags
-- Since:
- MicroStrategy Web 8.1.2
-
setOptimizeForUseURLForVisualizationsPreference
public void setOptimizeForUseURLForVisualizationsPreference(boolean optimizeForUseURLForVisualizationsPreference)
Whether to optimize flags if the useURLForVisualizations preference is true.
The optimization removes theEnumDSSXMLResultFlags.DssXmlResultGrid
result flag.
Default is true.
The optimization only applies to flags set at the document level.- Parameters:
optimizeForUseURLForVisualizationsPreference
- whether to optimize flags if the useURLForVisualizations preference is true.
.
-
getAddOnDescription
public java.lang.String getAddOnDescription()
Description copied from interface:AppAddOns
This method describes the tasks performed by the AddOn.- Returns:
- The tasks which the Add On performs. This needs to be as descriptive as possible.
-
setUseTerseElementIDs
public void setUseTerseElementIDs(boolean useTerse)
- Since:
- MicroStrategy Web 9.0.1
-
getUseTerseElementIDs
public boolean getUseTerseElementIDs()
- Since:
- MicroStrategy Web 9.0.1
-
setVisThresholdEditorName
public void setVisThresholdEditorName(java.lang.String visThresholdEditorName)
- Since:
- MicroStrategy Web 9.0.3
-
setCurrentSelectedGridKey
public void setCurrentSelectedGridKey(java.lang.String gridKey)
-
setAdvThresholdEditorName
public void setAdvThresholdEditorName(java.lang.String advThresholdEditorName)
-
-