Class ReportCellRankMetric.AbstractInsertMetricContextMenuBuilder
- java.lang.Object
-
- com.microstrategy.web.app.transforms.contextmenus.ReportCellRankMetric.AbstractInsertMetricContextMenuBuilder
-
- All Implemented Interfaces:
ComposedContextMenuBuilder
,ReportCellRankMetric.InsertMetricContextMenuBuilder
- Enclosing class:
- ReportCellRankMetric
protected abstract static class ReportCellRankMetric.AbstractInsertMetricContextMenuBuilder extends java.lang.Object implements ReportCellRankMetric.InsertMetricContextMenuBuilder
Abstract base implementation of theReportCellRankMetric.InsertMetricContextMenuBuilder
class.- Since:
- MicroStrategy Web 8.0.1
-
-
Constructor Summary
Constructors Constructor Description AbstractInsertMetricContextMenuBuilder(ReportGridDisplayCell.Context context)
Class constructor
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected abstract void
generateRankOptions()
ContextMenu
instance with the insert metric options related to Rank metricsContextMenu
generateSubMenu()
Method that generates aContextMenu
instance with all the possible sub menu options enabled for the report cell provided.TransformContext
getContext()
protected java.lang.String
getDescriptor(int key)
Utility method for obtaining the string of a descriptorprotected int
getIntValue(java.lang.String fpName, int defaultValue)
Utility method for obtaining the integer value of a given formal parameterprotected java.lang.String
getJSCode(WebEvent event)
Generate the JavaScript code the option will have based on the event information providedprotected java.lang.String
getStringValue(java.lang.String fpName, java.lang.String defaultValue)
Utility method for obtaining the string value of a given formal parameterprotected ContextMenu
getSubMenu()
protected WebTemplate
getWebTemplate()
protected void
internalPopulate()
protected boolean
isFeatureAvailable(java.lang.String featureName)
Utility method for determining if a feature is available or notboolean
isIframeEnabled()
protected boolean
isTrue(java.lang.String fpName)
Utility method for obtaining the boolean value of a given formal parameterboolean
isValid()
void
setIframeEnabled(boolean value)
Define if the options to generate will be iframe enabled or not-
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.transforms.contextmenus.ComposedContextMenuBuilder
generateSubMenu, isIframeEnabled, setIframeEnabled
-
-
-
-
Constructor Detail
-
AbstractInsertMetricContextMenuBuilder
public AbstractInsertMetricContextMenuBuilder(ReportGridDisplayCell.Context context)
Class constructor- Parameters:
context
- instance with the information about the context (cell, transform, etc) where this menu item will be displayed.
-
-
Method Detail
-
isValid
public boolean isValid()
- Specified by:
isValid
in interfaceComposedContextMenuBuilder
- Returns:
- boolean value that indicates if drilling on the current cell shall be enabled to the user
-
getJSCode
protected java.lang.String getJSCode(WebEvent event)
Generate the JavaScript code the option will have based on the event information provided- Parameters:
event
-WebEvent
instance from where the JavaScript information will be extracted- Returns:
- String value with the JavaScript code to use for the context menu option.
-
getWebTemplate
protected WebTemplate getWebTemplate()
- Returns:
WebTemplate
instance related with the grid currently being analyzed.
-
generateRankOptions
protected abstract void generateRankOptions()
ContextMenu
instance with the insert metric options related to Rank metrics
-
internalPopulate
protected void internalPopulate()
-
setIframeEnabled
public void setIframeEnabled(boolean value)
Define if the options to generate will be iframe enabled or not- Specified by:
setIframeEnabled
in interfaceComposedContextMenuBuilder
- Parameters:
value
- boolean value indicating if the options to generate will be iframe enabled or not
-
isIframeEnabled
public boolean isIframeEnabled()
- Specified by:
isIframeEnabled
in interfaceComposedContextMenuBuilder
- Returns:
- boolean value indicating if the options generated by this builder are iframe enabled or not
-
getContext
public TransformContext getContext()
- Returns:
ReportGridDisplayCell.Context
instance with the information about the context (cell, transform, etc) where this menu item will be displayed.
-
getSubMenu
protected ContextMenu getSubMenu()
- Returns:
ContextMenu
instance where the different options this builder will generate will be saved.
-
generateSubMenu
public ContextMenu generateSubMenu()
Description copied from interface:ComposedContextMenuBuilder
Method that generates aContextMenu
instance with all the possible sub menu options enabled for the report cell provided.- Specified by:
generateSubMenu
in interfaceComposedContextMenuBuilder
- Returns:
ContextMenu
instance with the drilling options that can be displayed to the user
-
getDescriptor
protected java.lang.String getDescriptor(int key)
Utility method for obtaining the string of a descriptor- Parameters:
key
- value with the identifier of the descriptor to obtain- Returns:
- String value of the descriptor, according to the key provided
-
isFeatureAvailable
protected boolean isFeatureAvailable(java.lang.String featureName)
Utility method for determining if a feature is available or not- Parameters:
featureName
- String value with the name of the feature to test- Returns:
- boolean value indicating if the feature is available or not.
-
isTrue
protected boolean isTrue(java.lang.String fpName)
Utility method for obtaining the boolean value of a given formal parameter- Parameters:
fpName
- String value with the name of the formal parameter to test- Returns:
- boolean value of the formal parameter requested. If not found or the formal parameter is not of type boolean, it will return false.
-
getIntValue
protected int getIntValue(java.lang.String fpName, int defaultValue)
Utility method for obtaining the integer value of a given formal parameter- Parameters:
fpName
- String value with the name of the formal parameter to testdefaultValue
- value to return if the process of querying the formal parameter fails.- Returns:
- value of the formal parameter requested. If not found or the formal parameter is not of type integer, it will return the default value provided.
-
getStringValue
protected java.lang.String getStringValue(java.lang.String fpName, java.lang.String defaultValue)
Utility method for obtaining the string value of a given formal parameter- Parameters:
fpName
- String value with the name of the formal parameter to testdefaultValue
- value to return if the process of querying the formal parameter fails.- Returns:
- value of the formal parameter requested. If not found or the formal parameter is not of type string, it will return the default value provided.
-
-