ReportTitleInsertMetric (Web API 2021)

java.lang.Object
- com.microstrategy.web.app.gui.ContextMenu.DefaultContextMenuItemBuilder
- - com.microstrategy.web.app.transforms.contextmenus.AbstractReportCellContextMenuItemBuilder
  - - com.microstrategy.web.app.transforms.contextmenus.AbstractReportCellParentMenu
    - - com.microstrategy.web.app.transforms.contextmenus.ReportTitleInsertMetric

All Implemented Interfaces:

ContextMenuItemBuilder
```
public class ReportTitleInsertMetric
extends AbstractReportCellParentMenu
```
The ReportTitleInsertMetric represents a context menu item builder that will hold a sub-menu structure with a list of the options that a user is enabled to access for inserting new shortcut metrics based on the current grid title selected, specified on the context. If no children options are defined on its submenu (lack of privileges, conditions required not met by the current context, etc) the option will automatically be ignored and the final context menu will not display it.

Constructor Summary

Constructors
Constructor Description

ReportTitleInsertMetric(Shortcut definition)
Class constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected boolean`	`isActionEnabled(TransformContext context)`	Called by `AbstractReportCellContextMenuItemBuilder.isItemAvailable(com.microstrategy.web.app.transforms.TransformContext)`, indicates the abstract class if the corresponding action of this item is available.

Methods inherited from class com.microstrategy.web.app.transforms.contextmenus.AbstractReportCellParentMenu
createItem, getJSCode

Methods inherited from class com.microstrategy.web.app.transforms.contextmenus.AbstractReportCellContextMenuItemBuilder
canDefineDerivedElements, getCell, getFormalParameter, getIntValue, getPassThroughMode, getStringValue, getTransform, isFeatureAvailable, isIframeEnabled, isItemAvailable, isRW, isTrue

Methods inherited from class com.microstrategy.web.app.gui.ContextMenu.DefaultContextMenuItemBuilder
createItem, getDefinition, getItemKey, getScript

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ReportTitleInsertMetric
```
public ReportTitleInsertMetric(Shortcut definition)
```
    Class constructor
    
    Parameters:
    
    definition - Shortcut instance with the base definition of the option
- Method Detail
  - isActionEnabled
```
protected boolean isActionEnabled(TransformContext context)
```
    Called by AbstractReportCellContextMenuItemBuilder.isItemAvailable(com.microstrategy.web.app.transforms.TransformContext), indicates the abstract class if the corresponding action of this item is available.
    
    Specified by:
    
    isActionEnabled in class AbstractReportCellContextMenuItemBuilder
    
    Parameters:
    
    context - TransformContext initialized instance with the information on where this option will be used
    
    Returns:
    
    boolean value indicating if the option should be enabled to the user or not, given the properties available on the context object.