| java.lang.Object | ||
| ↳ | com.microstrategy.web.app.addons.AbstractAppAddOn | |
| ↳ | com.microstrategy.web.app.addons.RWSetFlagsAddOn | |
Class Overview
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.
Summary
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| RWSetFlagsAddOn() | |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| String | getAddOnDescription() | ||||||||||
| boolean | getUseTerseElementIDs() | ||||||||||
| void |
preCollectData(PageComponent pg)
This is the main method of the add on which executes the add on.
| ||||||||||
| void | setAdvThresholdEditorName(String advThresholdEditorName) | ||||||||||
| void |
setBeanName(String name)
Sets the RW Bean name
| ||||||||||
| void | setCurrentSelectedGridKey(String gridKey) | ||||||||||
| void |
setOptimizeForUseURLForVisualizationsPreference(boolean optimizeForUseURLForVisualizationsPreference)
Whether to optimize flags if the useURLForVisualizations preference is true.
| ||||||||||
| void |
setResultFlags(int flags)
This method is deprecated.
use
setViewModeFlags(String)
| ||||||||||
| void | setUseTerseElementIDs(boolean useTerse) | ||||||||||
| void |
setViewMode(int viewMode)
This method is deprecated.
use
setViewModeFlags(String)
| ||||||||||
| void |
setViewModeFlags(String vmFlags)
Sets the result flags for specific view modes.
| ||||||||||
| void | setVisThresholdEditorName(String visThresholdEditorName) | ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
com.microstrategy.web.app.addons.AbstractAppAddOn
| |||||||||||
|
From class
java.lang.Object
| |||||||||||
|
From interface
com.microstrategy.web.app.addons.AppAddOns
| |||||||||||
Public Constructors
public RWSetFlagsAddOn ()
Public Methods
public String getAddOnDescription ()
public boolean getUseTerseElementIDs ()
public void preCollectData (PageComponent pg)
This is the main method of the add on which executes the add on. This has to be a static method.
Parameters
| pg | is the PageComponent. |
|---|
public void setAdvThresholdEditorName (String advThresholdEditorName)
public void setBeanName (String name)
Sets the RW Bean name
Parameters
| name | bean name |
|---|
public void setCurrentSelectedGridKey (String gridKey)
public void setOptimizeForUseURLForVisualizationsPreference (boolean optimizeForUseURLForVisualizationsPreference)
Whether to optimize flags if the useURLForVisualizations preference is true.
The optimization removes the 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. . |
|---|
public void setResultFlags (int flags)
This method is deprecated.
use setViewModeFlags(String)
Sets the result flags to set
Parameters
| flags | the result flags to set |
|---|
public void setUseTerseElementIDs (boolean useTerse)
public void setViewMode (int viewMode)
This method is deprecated.
use setViewModeFlags(String)
Sets the View Mode to set the flags for
Parameters
| viewMode | bean the View Mode to set the flags for |
|---|
public void setViewModeFlags (String vmFlags)
Sets the result flags for specific view modes.
The format must be:
"viewMode:flags,viewMode2:flags2"