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

Class ReportCellFilterOn

java.lang.Object

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

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

com.microstrategy.web.app.transforms.contextmenus.ReportCellFilterOn

All Implemented Interfaces:

ContextMenuItemBuilder

public class ReportCellFilterOn
extends AbstractReportCellContextMenuItemBuilder

The ReportCellFilterOn represents a context menu item builder that will generate the option for being able to create a filter based on the current grid cell selected, specified on the context.

Since:

MicroStrategy Web 8.0.1

Constructor Summary

Constructors

Constructor	Description
ReportCellFilterOn(Shortcut definition)	Class constructor

Method Summary

Modifier and Type	Method	Description
protected WebEvent	getEvent(TransformContext context)	Get the event for enabling the Filter On functionality for the current cell being analyzed
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, getItemKey, getScript

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportCellFilterOn

public ReportCellFilterOn(Shortcut definition)

Class constructor

Parameters:

definition - Shortcut instance with the base definition of the option

Method Detail

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.

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.

getEvent

protected WebEvent getEvent(TransformContext context)

Get the event for enabling the Filter On functionality for the current cell being analyzed

Parameters:

context - TransformContext initialized instance with the information on where this option will be used

Returns:

WebEvent instance initialized with the information for enabling the filter on requests. If not enabled, it will return null