Package com.microstrategy.web.app.transforms.contextmenus

Class ReportCellFilterOnSelections

java.lang.Object

com.microstrategy.web.app.gui.ContextMenu.DefaultContextMenuItemBuilder

com.microstrategy.web.app.transforms.contextmenus.AbstractReportCellContextMenuItemBuilder

com.microstrategy.web.app.transforms.contextmenus.ReportCellFilterOnSelections

All Implemented Interfaces:

ContextMenuItemBuilder

public class ReportCellFilterOnSelections
extends AbstractReportCellContextMenuItemBuilder

ReportCellFilterOnSelections is responsible for generating the Filter On Selections menu option.

Since:

MicroStrategy Web 9.0.0

Constructor Summary

Constructors

Constructor	Description
ReportCellFilterOnSelections(Shortcut definition)	Class constructor

Method Summary

Modifier and Type	Method	Description
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.
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.AbstractReportCellContextMenuItemBuilder

canDefineDerivedElements, createItem, 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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReportCellFilterOnSelections

public ReportCellFilterOnSelections(Shortcut definition)

Class constructor

Parameters:

definition - Shortcut instance with the base definition of the option

Method Detail

isActionEnabled

protected boolean isActionEnabled(TransformContext context)

Description copied from class: AbstractReportCellContextMenuItemBuilder

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.

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 class AbstractReportCellContextMenuItemBuilder

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 calling ContextMenu.DefaultContextMenuItemBuilder.createItem(TransformContext) to check whether the item already exists in the menu to avoid unnecessary creation.

Specified by:

getItemKey in interface ContextMenuItemBuilder

Overrides:

getItemKey in class ContextMenu.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.