Class ReportCellDEQuickGroup
- java.lang.Object
-
- com.microstrategy.web.app.gui.ContextMenu.DefaultContextMenuItemBuilder
-
- com.microstrategy.web.app.transforms.contextmenus.AbstractReportCellContextMenuItemBuilder
-
- com.microstrategy.web.app.transforms.contextmenus.ReportCellDEQuickGroup
-
- All Implemented Interfaces:
ContextMenuItemBuilder
public class ReportCellDEQuickGroup extends AbstractReportCellContextMenuItemBuilder
- Since:
- MicroStrategy Web 9.0.0
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
SUB_MENU_NAME
-
Constructor Summary
Constructors Constructor Description ReportCellDEQuickGroup(Shortcut shortcut)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ContextMenuItem
createItem(TransformContext context)
Creates and populates aContextMenuItem
based on the information in theShortcut
used as its defintion, as well as the logic included on this builder instance.java.lang.String
getItemKey(TransformContext context)
Retrieve the key will be set on the context menu item corresponding to the context input.protected java.lang.String
getJSCode(TransformContext context)
Generate the JavaScript code the context menu item generated by this builder instance will trigger when the user selects it.ContextMenu
getSubMenu(TransformContext context)
protected boolean
isActionEnabled(TransformContext context)
Called byAbstractReportCellContextMenuItemBuilder.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.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, getScript
-
-
-
-
Field Detail
-
SUB_MENU_NAME
public static final java.lang.String SUB_MENU_NAME
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
ReportCellDEQuickGroup
public ReportCellDEQuickGroup(Shortcut shortcut)
-
-
Method Detail
-
createItem
public ContextMenuItem createItem(TransformContext context)
Description copied from class:AbstractReportCellContextMenuItemBuilder
Creates and populates aContextMenuItem
based on the information in theShortcut
used as its defintion, as well as the logic included on this builder instance.- Specified by:
createItem
in interfaceContextMenuItemBuilder
- Overrides:
createItem
in classAbstractReportCellContextMenuItemBuilder
- Parameters:
context
-TransformContext
initialized instance with the information on where this option will be used- Returns:
- a new instance of a
ContextMenuItem
initialized with the option information to present to the user.
-
getSubMenu
public ContextMenu getSubMenu(TransformContext context)
-
isActionEnabled
protected boolean isActionEnabled(TransformContext context)
Description copied from class:AbstractReportCellContextMenuItemBuilder
Called byAbstractReportCellContextMenuItemBuilder.isItemAvailable(com.microstrategy.web.app.transforms.TransformContext)
, indicates the abstract class if the corresponding action of this item is available.- Specified by:
isActionEnabled
in classAbstractReportCellContextMenuItemBuilder
- 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.
-
getJSCode
protected java.lang.String getJSCode(TransformContext context)
Description copied from class:AbstractReportCellContextMenuItemBuilder
Generate the JavaScript code the context menu item generated by this builder instance will trigger when the user selects it.- Specified by:
getJSCode
in classAbstractReportCellContextMenuItemBuilder
- Parameters:
context
-TransformContext
initialized instance with the information on where this option will be used- Returns:
- String value with the JavaScript information to trigger when the option is selected.
-
getItemKey
public java.lang.String getItemKey(TransformContext context)
Description copied from class:ContextMenu.DefaultContextMenuItemBuilder
Retrieve the key will be set on the context menu item corresponding to the context input. The context menu item generated based on the same context input will have the same key. This method can be called by context menu before callingContextMenu.DefaultContextMenuItemBuilder.createItem(TransformContext)
to check whether the item already exists in the menu to avoid unnecessary creation.- Specified by:
getItemKey
in interfaceContextMenuItemBuilder
- Overrides:
getItemKey
in classContextMenu.DefaultContextMenuItemBuilder
- Parameters:
context
- The context for context menu item creation- Returns:
- The key for the context menu item if created using the context. By default
null
will be return, which means build has no knowledge about the item key. Then context menu item may generate the key by itself. For builder who wants avoid unnecessary item creation should take advantage of this method by overriding with a meaningful implementation.
-
-